Package com.ironsoftware.ironpdf.annotation

Class TextAnnotation

java.lang.Object
com.ironsoftware.ironpdf.annotation.TextAnnotation
public final class TextAnnotation extends Object
Defines a Sticky-Note style PDF annotation. Annotation_Api.addTextAnnotation(InternalPdfDocument, TextAnnotation, int, int, int)

  • Constructor Details

    • TextAnnotation

      public TextAnnotation()
      Instantiates a new text annotation.

    • TextAnnotation

      public TextAnnotation(String contents)
      Instantiates a new text annotation.
      Parameters:
      contents - the contents of the 'sticky note' annotation

  • Method Details

    • getColorCode

      public String getColorCode()
      Gets the color of the annotation's 'Sticky Note'. Uses CSS '#ff66BB' hex color style.
      Returns:
      the color code string.

    • setColorCode

      public void setColorCode(String value)
      Sets the color of the annotation's 'Sticky Note'. Uses CSS '#ff66BB' hex color style.
      Parameters:
      value - the color code string.

    • getContents

      public String getContents()
      Gets the contents of the 'sticky note' annotation.
      Returns:
      the contents of the 'sticky note' annotation.

    • setContents

      public void setContents(String value)
      Sets the contents of the 'sticky note' annotation.
      Parameters:
      value - the contents text.

    • isHidden

      public boolean isHidden()
      Hides the annotation from users.
      Returns:
      the isHidden value.

    • setHidden

      public void setHidden(boolean value)
      Hides the annotation from users.
      Parameters:
      value - the isHidden value.

    • getOpacity

      public double getOpacity()
      Gets the opacity of the annotation (valid values are from 0.0 to 1.0).
      Returns:
      the opacity of the annotation.

    • setOpacity

      public void setOpacity(double value)
      Sets the opacity of the annotation (valid values are from 0.0 to 1.0).
      Parameters:
      value - the opacity of the annotation (valid values are from 0.0 to 1.0).

    • isOpenByDefault

      public boolean isOpenByDefault()
      The annotation to be opened and readable by default, without user interaction.
      Returns:
      the value of isOpenByDefault.

    • setOpenByDefault

      public void setOpenByDefault(boolean value)
      Sets the annotation to be opened and readable by default, without user interaction.
      Parameters:
      value - the value of isOpenByDefault.

    • isPrintable

      public boolean isPrintable()
      Is allows the annotation to be printed when users print the PDF.
      Returns:
      the isPrintable value.

    • setPrintable

      public void setPrintable(boolean value)
      Sets allows the annotation to be printed when users print the PDF.
      Parameters:
      value - the isPrintable value.

    • isReadOnly

      public boolean isReadOnly()
      Sets the annotation to be read only.
      Returns:
      the isReadOnly value.

    • setReadOnly

      public void setReadOnly(boolean value)
      Sets the annotation to be read only.
      Parameters:
      value - the isReadOnly value.

    • isRotateable

      public boolean isRotateable()
      Is rotateable boolean. Allows the annotation to be rotated. E.g. when the containing page os rotated.
      Returns:
      the rotateable boolean.

    • setRotateable

      public void setRotateable(boolean value)
      Sets rotateable. Allows the annotation to be rotated. E.g. when the containing page os rotated.
      Parameters:
      value - the rotateable value.

    • toString

      public String toString()
      Returns a String that represents this annotation.
      Overrides:
      toString in class Object
      Returns:
      A String that represents this instance.

    • getTitle

      public String getTitle()
      Gets title. The main title of the annotation as displayed in the header of the 'sticky note'.
      Returns:
      the title

    • setTitle

      public void setTitle(String value)
      Sets title. The main title of the annotation as displayed in the header of the 'sticky note'.
      Parameters:
      value - the value

    • getSubject

      public String getSubject()
      Gets subject. The subject of the annotation as displayed in the header of the 'sticky note'.
      Returns:
      the subject.

    • setSubject

      public void setSubject(String value)
      Sets subject. The subject of the annotation as displayed in the header of the 'sticky note'.
      Parameters:
      value - the value.

    • getIcon

      public AnnotationIcon getIcon()
      Gets icon. An icon to visually represent the 'sticky note' annotation.
      Returns:
      the icon.

    • setIcon

      public void setIcon(AnnotationIcon value)
      Sets icon. An icon to visually represent the 'sticky note' annotation.
      Parameters:
      value - the value.