Class FDFAnnotation

Method Details

• create

  public static FDFAnnotation create(COSDictionary fdfDic) throws IOException

  Create the correct FDFAnnotation.

  Parameters:

  fdfDic - The FDF dictionary.

  Returns:

  A newly created FDFAnnotation

  Throws:

  IOException - If there is an error accessing the FDF information.

• getCOSObject

  public COSBase getCOSObject()

  Convert this standard java object to a COS object.

  Specified by:

  getCOSObject in interface COSObjectable

  Returns:

  The cos object that matches this Java object.

• getCOSDictionary

  public COSDictionary getCOSDictionary()

  Convert this standard java object to a COS object.

  Returns:

  The cos object that matches this Java object.

• getPage

  public Integer getPage()

  This will get the page number or null if it does not exist.

  Returns:

  The page number.

• setPage

  public void setPage(int page)

  This will set the page.

  Parameters:

  page - The page number.

• getColor

  public Color getColor()

  Get the annotation color.

  Returns:

  The annotation color, or null if there is none.

• setColor

  public void setColor(Color c)

  Set the annotation color.

  Parameters:

  c - The annotation color.

• getDate

  public String getDate()

  Modification date.

  Returns:

  The date as a string.

• setDate

  public void setDate(String date)

  The annotation modification date.

  Parameters:

  date - The date to store in the FDF annotation.

• isInvisible

  public boolean isInvisible()

  Get the invisible flag.

  Returns:

  The invisible flag.

• setInvisible

  public void setInvisible(boolean invisible)

  Set the invisible flag.

  Parameters:

  invisible - The new invisible flag.

• isHidden

  public boolean isHidden()

  Get the hidden flag.

  Returns:

  The hidden flag.

• setHidden

  public void setHidden(boolean hidden)

  Set the hidden flag.

  Parameters:

  hidden - The new hidden flag.

• isPrinted

  public boolean isPrinted()

  Get the printed flag.

  Returns:

  The printed flag.

• setPrinted

  public void setPrinted(boolean printed)

  Set the printed flag.

  Parameters:

  printed - The new printed flag.

• isNoZoom

  public boolean isNoZoom()

  Get the noZoom flag.

  Returns:

  The noZoom flag.

• setNoZoom

  public void setNoZoom(boolean noZoom)

  Set the noZoom flag.

  Parameters:

  noZoom - The new noZoom flag.

• isNoRotate

  public boolean isNoRotate()

  Get the noRotate flag.

  Returns:

  The noRotate flag.

• setNoRotate

  public void setNoRotate(boolean noRotate)

  Set the noRotate flag.

  Parameters:

  noRotate - The new noRotate flag.

• isNoView

  public boolean isNoView()

  Get the noView flag.

  Returns:

  The noView flag.

• setNoView

  public void setNoView(boolean noView)

  Set the noView flag.

  Parameters:

  noView - The new noView flag.

• isReadOnly

  public boolean isReadOnly()

  Get the readOnly flag.

  Returns:

  The readOnly flag.

• setReadOnly

  public void setReadOnly(boolean readOnly)

  Set the readOnly flag.

  Parameters:

  readOnly - The new readOnly flag.

• isLocked

  public boolean isLocked()

  Get the locked flag.

  Returns:

  The locked flag.

• setLocked

  public void setLocked(boolean locked)

  Set the locked flag.

  Parameters:

  locked - The new locked flag.

• isToggleNoView

  public boolean isToggleNoView()

  Get the toggleNoView flag.

  Returns:

  The toggleNoView flag.

• setToggleNoView

  public void setToggleNoView(boolean toggleNoView)

  Set the toggleNoView flag.

  Parameters:

  toggleNoView - The new toggleNoView flag.

• setName

  public void setName(String name)

  Set a unique name for an annotation.

  Parameters:

  name - The unique annotation name.

• getName

  public String getName()

  Get the annotation name.

  Returns:

  The unique name of the annotation.

• setRectangle

  public void setRectangle(PDRectangle rectangle)

  Set the rectangle associated with this annotation.

  Parameters:

  rectangle - The annotation rectangle.

• getRectangle

  public PDRectangle getRectangle()

  The rectangle associated with this annotation.

  Returns:

  The annotation rectangle.

• setTitle

  public void setTitle(String title)

  Set a unique title for an annotation.

  Parameters:

  title - The annotation title.

• getTitle

  public String getTitle()

  Get the annotation title.

  Returns:

  The title of the annotation.

• getCreationDate

  public Calendar getCreationDate() throws IOException

  The annotation create date.

  Returns:

  The date of the creation of the annotation date

  Throws:

  IOException - If there is an error converting the string to a Calendar object.

• setCreationDate

  public void setCreationDate(Calendar date)

  Set the creation date.

  Parameters:

  date - The date the annotation was created.

• setOpacity

  public void setOpacity(float opacity)

  Set the annotation opacity.

  Parameters:

  opacity - The new opacity value.

• getOpacity

  public float getOpacity()

  Get the opacity value.

  Returns:

  The opacity of the annotation.

• setSubject

  public void setSubject(String subject)

  A short description of the annotation.

  Parameters:

  subject - The annotation subject.

• getSubject

  public String getSubject()

  Get the description of the annotation.

  Returns:

  The subject of the annotation.