public class Text extends Markup
Text
represents the text Annotation.
It offers specific properties get/set method for text annotation.
Before call all methods in this class,
please note to call
at first.PDFPage.loadAnnots()
Annot.Border, Annot.QuadpointsF
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ICONNAME_CHECK
Note icon type: Check.
|
static java.lang.String |
ICONNAME_CHECKMARK
Deprecated.
Current definition has been deprecated in GSDK 5.2. So, not recommend to use current definition any more.
Instead, please use
. |
static java.lang.String |
ICONNAME_CIRCLE
Note icon type: Circle.
|
static java.lang.String |
ICONNAME_COMMENT
Note icon type: Comment.
|
static java.lang.String |
ICONNAME_CROSS
Note icon type: Cross.
|
static java.lang.String |
ICONNAME_HELP
Note icon type: Help.
|
static java.lang.String |
ICONNAME_INSERT
Note icon type: Insert.
|
static java.lang.String |
ICONNAME_KEY
Note icon type: Key.
|
static java.lang.String |
ICONNAME_NEWPARAGRAPH
Note icon type: New Paragraph.
|
static java.lang.String |
ICONNAME_NOTE
Note icon type: Note.
|
static java.lang.String |
ICONNAME_PARAGRAPH
Note icon type: Paragraph.
|
static java.lang.String |
ICONNAME_RIGHARROW
Note icon type: Right Arrow.
|
static java.lang.String |
ICONNAME_RIGHPOINTER
Note icon type: Right Pointer.
|
static java.lang.String |
ICONNAME_STAR
Note icon type: Star.
|
static java.lang.String |
ICONNAME_UPARROW
Note icon type: Up Arrow.
|
static java.lang.String |
ICONNAME_UPLEFTARROW
Note icon type: Up-left Arrow.
|
INTENTNAME_FREETEXT_CALLOUT, INTENTNAME_FREETEXT_TYPEWRITER, INTENTNAME_LINE_ARROW, INTENTNAME_LINE_DIMENSION, INTENTNAME_POLYGON_CLOUD, INTENTNAME_POLYGON_DIMENSION, INTENTNAME_POLYLINE_DIMENSION, LINEENDINGSTYLE_BUTT, LINEENDINGSTYLE_CIRCLE, LINEENDINGSTYLE_CLOSEDARROW, LINEENDINGSTYLE_DIAMOND, LINEENDINGSTYLE_NONE, LINEENDINGSTYLE_OPENARROW, LINEENDINGSTYLE_REVERSECLOSEDARROW, LINEENDINGSTYLE_REVERSEOPENARROW, LINEENDINGSTYLE_SLASH, LINEENDINGSTYLE_SQUARE, STATE_MARKED_MARKED, STATE_MARKED_UNMARKED, STATE_REVIEW_ACCEPTED, STATE_REVIEW_CANCELLED, STATE_REVIEW_COMPLETED, STATE_REVIEW_NONE, STATE_REVIEW_REJECTED, STATEMODEL_MARKED, STATEMODEL_REVIEW
BORDERSTYLE_BEVELED, BORDERSTYLE_CLOUDY, BORDERSTYLE_DASHED, BORDERSTYLE_INSET, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAG_HIDDEN, FLAG_INVISIBLE, FLAG_LOCKED, FLAG_LOCKEDCONTENTS, FLAG_NOROTATE, FLAG_NOVIEW, FLAG_NOZOOM, FLAG_PRINT, FLAG_READONLY, FLAG_TOGGLENOVIEW, HIGHLIGHTINGMODE_INVERT, HIGHLIGHTINGMODE_NONE, HIGHLIGHTINGMODE_OUTLINE, HIGHLIGHTINGMODE_PUSH, HIGHLIGHTINGMODE_TOGGLE, MKENTRY_BACKGROUNDCOLOR, MKENTRY_BORDERCOLOR, MKENTRY_DOWNCAPTION, MKENTRY_DOWNICON, MKENTRY_ICONFIT, MKENTRY_NORMALCAPTION, MKENTRY_NORMALICON, MKENTRY_ROLLOVERCAPTION, MKENTRY_ROLLOVERICON, MKENTRY_ROTATION, MKENTRY_TEXTPOSITION, TRIGGER_ANNOT_CE, TRIGGER_ANNOT_CX, TRIGGER_ANNOT_FL, TRIGGER_ANNOT_FO, TRIGGER_ANNOT_MD, TRIGGER_ANNOT_MU, TRIGGER_ANNOT_PC, TRIGGER_ANNOT_PI, TRIGGER_ANNOT_PO, TRIGGER_ANNOT_PV, TYPE_3D, TYPE_CARET, TYPE_CIRCLE, TYPE_FILEATTACHMENT, TYPE_FREETEXT, TYPE_HIGHLIGHT, TYPE_INK, TYPE_LINE, TYPE_LINK, TYPE_MOVIE, TYPE_POLYGON, TYPE_POLYLINE, TYPE_POPUP, TYPE_PRINTERMARK, TYPE_PSI, TYPE_SCREEN, TYPE_SOUND, TYPE_SQUARE, TYPE_SQUIGGLY, TYPE_STAMP, TYPE_STRIKEOUT, TYPE_TEXT, TYPE_TRAPNET, TYPE_UNDERLINE, TYPE_WATERMARK, TYPE_WIDGET
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getIconName()
Get icon name of current text annotation.
|
boolean |
getOpenStatus()
Get open status of current text annotation.
|
Popup |
getPopup()
Get the associated popup annotation of current text annotation.
|
void |
resetAppearance()
Reset(regenerate) appearance of current text annotation.
|
void |
setIconName(java.lang.String iconName)
Set icon name of current text annotation.
|
void |
setOpenStatus(boolean status)
Set open status of current text annotation.
|
addState, countReplies, countStateAnnots, getCreationDateTime, getGroupElements, getGroupHeader, getIntent, getOpacity, getReply, getState, getStateAnnot, getSubject, getTitle, insertReply, isGrouped, isTextMarkup, removeAllReplies, removeAllStates, removeReply, setCreationDateTime, setGroup, setIntent, setOpacity, setState, setSubject, setTitle, unGroup
getBorder, getBorderColor, getContents, getDeviceRect, getFlags, getHandle, getIndex, getModifiedDateTime, getName, getRect, getType, isMarkup, move, setBorder, setBorderColor, setContents, setFlags, setIconProvider, setModifiedDateTime, setName
public static final java.lang.String ICONNAME_CHECKMARK
ICONNAME_CHECK
.public static final java.lang.String ICONNAME_CHECK
public static final java.lang.String ICONNAME_CIRCLE
public static final java.lang.String ICONNAME_COMMENT
public static final java.lang.String ICONNAME_CROSS
public static final java.lang.String ICONNAME_HELP
public static final java.lang.String ICONNAME_INSERT
public static final java.lang.String ICONNAME_KEY
public static final java.lang.String ICONNAME_NEWPARAGRAPH
public static final java.lang.String ICONNAME_NOTE
public static final java.lang.String ICONNAME_PARAGRAPH
public static final java.lang.String ICONNAME_RIGHARROW
public static final java.lang.String ICONNAME_RIGHPOINTER
public static final java.lang.String ICONNAME_STAR
public static final java.lang.String ICONNAME_UPARROW
public static final java.lang.String ICONNAME_UPLEFTARROW
public java.lang.String getIconName() throws PDFException
String
object that receives the icon name of a
text annotation. Please refer to constants definitions
ICONNAME_XXX
and this should be one of these constants.null
.PDFException
- For more exception information please see definitions
PDFException.ERRCODE_XXX
.PDFException
public boolean getOpenStatus() throws PDFException
false
.PDFException
- For more exception information please see definitions
PDFException.ERRCODE_XXX
.PDFException
public void setIconName(java.lang.String iconName) throws PDFException
iconName
- A String
object that specifies value of icon name
property. Please refer to constants definitions
ICONNAME_XXX
and
this should be one of these constants.PDFException
- For more exception information please see definitions
PDFException.ERRCODE_XXX
.PDFException
public void setOpenStatus(boolean status) throws PDFException
status
- A boolean
value used to specify the open status
to be set to the annotation.PDFException
- For more exception information please see definitions
PDFException.ERRCODE_XXX
.PDFException
public void resetAppearance() throws PDFException
PDFException
- For more exception information please see definitions
PDFException.ERRCODE_XXX
.PDFException
public Popup getPopup() throws PDFException
Popup
object that receives the popup annotation.
If no popup annotation is found, this function will return null
.PDFException
- For more exception information please see definitions
PDFException.ERRCODE_XXX
.PDFException
,
Popup