Text (Qoppa jPDFViewer API)

All Superinterfaces:

Annotation
```
public interface Text
extends Annotation
```
Interface representing a Text annotation (also known as sticky note) in a PDF document. Text annotations are displayed as a note icon on the PDF document and open a text box to show its contents when double-clicked.

Author:

Qoppa Software

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ICON_CHECK` This string designates a checkmark bubble icon.
`static String`	`ICON_CHECKMARK` This string designates a checkmark icon.
`static String`	`ICON_CIRCLE` This string designates a circle icon.
`static String`	`ICON_COMMENT` This string designates a comment bubble icon.
`static String`	`ICON_CROSS` This string designates a cross or "X" icon.
`static String`	`ICON_CROSSHAIRS` This string designates a crosshairs or bullseye icon.
`static String`	`ICON_DEFAULT` A reference to the default icon string.
`static String`	`ICON_HELP` This string designates a question mark bubble icon.
`static String`	`ICON_INSERT` This string designates an insert icon.
`static String`	`ICON_KEY` This string designates a key icon.
`static String`	`ICON_NEWPARAGRAPH` This string designates an insert new line icon.
`static String`	`ICON_NOTE` This string designates a note icon.
`static String`	`ICON_PARAGRAPH` This string designates a the literary paragraph icon.
`static String`	`ICON_RIGHT_ARROW` This string designates a right arrow bubble icon.
`static String`	`ICON_RIGHT_POINTER` This string designates a right pointer icon.
`static String`	`ICON_STAR` This string designates a star icon.
`static String`	`ICON_UP_ARROW` This string designates a up arrow bubble icon.
`static String`	`ICON_UP_LEFT_ARROW` This string designates an up-left arrow bubble icon.

Fields inherited from interface com.qoppa.pdf.annotations.Annotation
BORDERSTYLE_BEVELED, BORDERSTYLE_CLOUD, BORDERSTYLE_DASHED, BORDERSTYLE_INSETS, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAGS_HIDDEN, FLAGS_INVISIBLE, FLAGS_LOCKED, FLAGS_LOCKEDCONTENTS, FLAGS_NOROTATE, FLAGS_NOVIEW, FLAGS_NOZOOM, FLAGS_PRINTABLE, FLAGS_READONLY

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getContents()` Returns the string contents for this annotation.
`Date`	`getCreationDate()` Returns the date and time when the annotation was created.
`String`	`getIconName()` Returns the name of the icon for this annotation.
`boolean`	`isInitialOpen()` Returns the value of the InitialOpen flag.
`void`	`setContents(String contents)` Sets the string contents for this annotation.
`void`	`setIconName(String iconName)` Sets the name of the icon for this annotation.
`void`	`setInitialOpen(boolean initOpen)` Sets the initial open flag.

Methods inherited from interface com.qoppa.pdf.annotations.Annotation
getActions, getAnnotationComponent, getBorderStyle, getBorderWidth, getCheckmarkStatus, getColor, getComponent, getCreator, getFlags, getIRTAnnotation, getModifiedDate, getName, getOpacity, getPageIndex, getRectangle, getReviewHistory, getSubject, getSubtype, getTriggerActions, isHidden, isInvisible, isIRTGroup, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreator, setFlags, setHidden, setInvisible, setLayer, setLocked, setLockedContents, setModifiedDate, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPrintable, setReadOnly, setRectangle, setSubject, setTriggerActions, shiftRectangle

- Field Detail
  - ICON_NOTE
```
static final String ICON_NOTE
```
    This string designates a note icon. This is the default icon.
    
    See Also:
    
    Constant Field Values
  - ICON_COMMENT
```
static final String ICON_COMMENT
```
    This string designates a comment bubble icon.
    
    See Also:
    
    Constant Field Values
  - ICON_KEY
```
static final String ICON_KEY
```
    This string designates a key icon.
    
    See Also:
    
    Constant Field Values
  - ICON_HELP
```
static final String ICON_HELP
```
    This string designates a question mark bubble icon.
    
    See Also:
    
    Constant Field Values
  - ICON_NEWPARAGRAPH
```
static final String ICON_NEWPARAGRAPH
```
    This string designates an insert new line icon.
    
    See Also:
    
    Constant Field Values
  - ICON_PARAGRAPH
```
static final String ICON_PARAGRAPH
```
    This string designates a the literary paragraph icon.
    
    See Also:
    
    Constant Field Values
  - ICON_INSERT
```
static final String ICON_INSERT
```
    This string designates an insert icon.
    
    See Also:
    
    Constant Field Values
  - ICON_CHECK
```
static final String ICON_CHECK
```
    This string designates a checkmark bubble icon.
    
    See Also:
    
    Constant Field Values
  - ICON_CHECKMARK
```
static final String ICON_CHECKMARK
```
    This string designates a checkmark icon.
    
    See Also:
    
    Constant Field Values
  - ICON_CIRCLE
```
static final String ICON_CIRCLE
```
    This string designates a circle icon.
    
    See Also:
    
    Constant Field Values
  - ICON_CROSS
```
static final String ICON_CROSS
```
    This string designates a cross or "X" icon.
    
    See Also:
    
    Constant Field Values
  - ICON_CROSSHAIRS
```
static final String ICON_CROSSHAIRS
```
    This string designates a crosshairs or bullseye icon.
    
    See Also:
    
    Constant Field Values
  - ICON_RIGHT_ARROW
```
static final String ICON_RIGHT_ARROW
```
    This string designates a right arrow bubble icon.
    
    See Also:
    
    Constant Field Values
  - ICON_RIGHT_POINTER
```
static final String ICON_RIGHT_POINTER
```
    This string designates a right pointer icon.
    
    See Also:
    
    Constant Field Values
  - ICON_STAR
```
static final String ICON_STAR
```
    This string designates a star icon.
    
    See Also:
    
    Constant Field Values
  - ICON_UP_ARROW
```
static final String ICON_UP_ARROW
```
    This string designates a up arrow bubble icon.
    
    See Also:
    
    Constant Field Values
  - ICON_UP_LEFT_ARROW
```
static final String ICON_UP_LEFT_ARROW
```
    This string designates an up-left arrow bubble icon.
    
    See Also:
    
    Constant Field Values
  - ICON_DEFAULT
```
static final String ICON_DEFAULT
```
    A reference to the default icon string.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getIconName
```
String getIconName()
```
    Returns the name of the icon for this annotation. Should be one of:
    - Text.ICON_NOTE - This is the default
    - Text.ICON_COMMENT
    - Text.ICON_KEY
    - Text.ICON_HELP
    - Text.ICON_NEWPARAGRAPH
    - Text.ICON_PARAGRAPH
    - Text.ICON_INSERT
    - Text.ICON_CHECK
    - Text.ICON_CHECKMARK
    - Text.ICON_CIRCLE
    - Text.ICON_CROSS
    - Text.ICON_CROSSHAIRS
    - Text.ICON_RIGHT_ARROW
    - Text.ICON_RIGHT_POINTER
    - Text.ICON_STAR
    - Text.ICON_UP_ARROW
    - Text.ICON_UP_LEFT_ARROW
    Returns:
    
    Name of the icon.
  - isInitialOpen
```
boolean isInitialOpen()
```
    Returns the value of the InitialOpen flag.
    
    Returns:
    
    Value of the flag.
  - setInitialOpen
```
void setInitialOpen(boolean initOpen)
```
    Sets the initial open flag.
    
    Parameters:
    
    initOpen - The new value of the initial open flag.
  - getContents
```
String getContents()
```
    Returns the string contents for this annotation.
    
    Specified by:
    
    getContents in interface Annotation
    
    Returns:
    
    The annotation's contents.
  - setContents
```
void setContents(String contents)
```
    Sets the string contents for this annotation.
  - setIconName
```
void setIconName(String iconName)
```
    Sets the name of the icon for this annotation. Should be one of:
    - Text.ICON_NOTE - This is the default
    - Text.ICON_COMMENT
    - Text.ICON_KEY
    - Text.ICON_HELP
    - Text.ICON_NEWPARAGRAPH
    - Text.ICON_PARAGRAPH
    - Text.ICON_INSERT
    - Text.ICON_CHECK
    - Text.ICON_CHECKMARK
    - Text.ICON_CIRCLE
    - Text.ICON_CROSS
    - Text.ICON_CROSSHAIRS
    - Text.ICON_RIGHT_ARROW
    - Text.ICON_RIGHT_POINTER
    - Text.ICON_STAR
    - Text.ICON_UP_ARROW
    - Text.ICON_UP_LEFT_ARROW
    Parameters:
    
    iconName - Name of the icon.
  - getCreationDate
```
Date getCreationDate()
```
    Returns the date and time when the annotation was created. Milliseconds are always zero since the PDF date format doesn't support milliseconds.
    
    Returns:
    
    The date and time when the annotation was created.

Interface Text

Field Summary

Fields inherited from interface com.qoppa.pdf.annotations.Annotation

Method Summary

Methods inherited from interface com.qoppa.pdf.annotations.Annotation

Field Detail

ICON_NOTE

ICON_COMMENT

ICON_KEY

ICON_HELP

ICON_NEWPARAGRAPH

ICON_PARAGRAPH

ICON_INSERT

ICON_CHECK

ICON_CHECKMARK

ICON_CIRCLE

ICON_CROSS

ICON_CROSSHAIRS

ICON_RIGHT_ARROW

ICON_RIGHT_POINTER

ICON_STAR

ICON_UP_ARROW

ICON_UP_LEFT_ARROW

ICON_DEFAULT

Method Detail

getIconName

isInitialOpen

setInitialOpen

getContents

setContents

setIconName

getCreationDate