public class Text extends Markup
Annot.BorderStyle
Modifier and Type | Field and Description |
---|---|
static int |
e_Comment
This integer list represents type of icon
corresponding with the Text annotation.
|
static int |
e_Help
The Constant e_Help.
|
static int |
e_Insert
The Constant e_Insert.
|
static int |
e_Key
The Constant e_Key.
|
static int |
e_NewParagraph
The Constant e_NewParagraph.
|
static int |
e_Note
The Constant e_Note.
|
static int |
e_Paragraph
The Constant e_Paragraph.
|
static int |
e_Unknown
The Constant e_Unknown.
|
e_3D, e_action_trigger_activate, e_action_trigger_annot_blur, e_action_trigger_annot_down, e_action_trigger_annot_enter, e_action_trigger_annot_exit, e_action_trigger_annot_focus, e_action_trigger_annot_page_close, e_action_trigger_annot_page_invisible, e_action_trigger_annot_page_open, e_action_trigger_annot_page_visible, e_action_trigger_annot_up, e_Caret, e_Circle, e_down, e_FileAttachment, e_FreeText, e_hidden, e_Highlight, e_Ink, e_invisible, e_Line, e_Link, e_locked, e_locked_contents, e_Movie, e_no_rotate, e_no_view, e_no_zoom, e_normal, e_Polygon, e_Polyline, e_Popup, e_print, e_PrinterMark, e_Projection, e_read_only, e_Redact, e_RichMedia, e_rollover, e_Screen, e_Sound, e_Square, e_Squiggly, e_Stamp, e_StrikeOut, e_Text, e_toggle_no_view, e_TrapNet, e_Underline, e_Watermark, e_Widget
Constructor and Description |
---|
Text()
Creates an empty Text annotation.
|
Text(Annot annot)
Creates a Text annotation and initialize it using given annotation object.
|
Text(Obj d)
Creates a Text annotation and initialize it using given Cos/SDF object.
|
Modifier and Type | Method and Description |
---|---|
static Text |
create(Doc doc,
Point pos)
Creates a new Text annotation, in the specified document.
|
static Text |
create(Doc doc,
Point pos,
java.lang.String contents)
Creates a new Text annotation, in the specified document.
|
int |
getIcon()
Get the Icon type as an entry of the enum "Icon".
|
java.lang.String |
getIconName()
Get the string indicating the type of icon corresponding to
the Text annotation.
|
java.lang.String |
getState()
Get the string indicating the state of the Text annotation.
|
java.lang.String |
getStateModel()
Get the string indicating the state model of the Text annotation.
|
void |
setIcon(int icon)
Set the Icon type as an entry of the enum "Icon".
|
void |
setIcon(java.lang.String icon)
Set the string indicating the type of icon corresponding to
(Optional).
|
void |
setState(java.lang.String state)
Set the string indicating the state of the Text annotation.
|
void |
setStateModel(java.lang.String statemodule)
Set the string indicating the state model of the Text annotation.
|
getBorderEffect, getBorderEffectIntensity, getContentRect, getCreationDates, getInteriorColor, getInteriorColorCompNum, getOpacity, getPadding, getPopup, getSubject, getTitle, setBorderEffect, SetBorderEffectIntensity, setContentRect, setCreationDates, setInteriorColor, setOpacity, SetPadding, setPopup, setSubject, setTitle
__Create, __GetHandle, __GetRefHandle, create, equals, flatten, getActiveAppearanceState, getAppearance, getAppearance, getAppearance, getBorderStyle, getColorAsCMYK, getColorAsGray, getColorAsRGB, getColorCompNum, getContents, getDate, getFlag, getOptionalContent, getPage, getRect, getRotation, getSDFObj, GetStructParent, getTriggerAction, getType, getUniqueID, getVisibleContentBox, isMarkup, isValid, refreshAppearance, removeAppearance, resize, setActiveAppearanceState, setAppearance, setAppearance, setAppearance, setBorderStyle, setColor, setContents, setDate, setFlag, setOptionalContent, setPage, setRect, setRotation, setStructParent, setUniqueID
public static final int e_Comment
public static final int e_Key
public static final int e_Help
public static final int e_NewParagraph
public static final int e_Paragraph
public static final int e_Insert
public static final int e_Note
public static final int e_Unknown
public Text(Obj d)
Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.
d
- the input Cos/SDF objectpublic Text()
public Text(Annot annot) throws PDFNetException
Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.
annot
- the annotPDFNetException
public static Text create(Doc doc, Point pos) throws PDFNetException
doc
- A document to which the annotation is added.pos
- A rectangle specifying the annotation's bounds, specified in
user space coordinates.PDFNetException
public static Text create(Doc doc, Point pos, java.lang.String contents) throws PDFNetException
doc
- A document to which the annotation is added.pos
- A rectangle specifying the annotation's bounds, specified in
user space coordinates.contents
- The text contents of the Text annotation.PDFNetException
public int getIcon() throws PDFNetException
Note: The icon type represnets the name of an icon that shall be used in displaying the annotation. Conforming readers shall provide predefined icon appearances for at least the following standard icon types: e_Comment, e_Key, e_Note, e_Help, e_NewParagraph, e_Paragraph, e_Insert Additional names may be supported as well. Default value: e_Note. The annotation dictionary's Appearance(AP) entry, if present, shall take precedence over this Name entry.
PDFNetException
public java.lang.String getIconName() throws PDFNetException
Note: the icon type represnets the name of an icon that shall be used in displaying the annotation. Conforming readers shall provide predefined icon appearances for at least the following standard icon types: e_Comment, e_Key, e_Note, e_Help, e_NewParagraph, e_Paragraph, e_Insert Additional names may be supported as well. Default value: Note. The annotation dictionary's Appearance(AP) entry, if present, shall take precedence over this Name entry.
PDFNetException
public void setIcon(int icon) throws PDFNetException
icon
- An entry of "Icon" that represents the type of icon
that is corresponding with this Text annotation.PDFNetException
- * Note: the icon type represnets the name of an icon that shall be used in displaying the annotation. Conforming readers shall provide predefined icon appearances for at least the following standard icon names: Comment, Key, Note, Help, NewParagraph, Paragraph, Insert Additional names may be supported as well. Default value: e_Note. The annotation dictionary's Appearance(AP) entry, if present, shall take precedence over this Name entry.
public void setIcon(java.lang.String icon) throws PDFNetException
icon
- A string that represents the type of icon
that is corresponding with this Text annotation.PDFNetException
- * Note: the icon type represnets the name of an icon that shall be used in displaying the annotation. Conforming readers shall provide predefined icon appearances for at least the following standard icon types: e_Comment, e_Key, e_Note, e_Help, e_NewParagraph, e_Paragraph, e_Insert Additional names may be supported as well. Default value: Note. The annotation dictionary's Appearance(AP) entry, if present, shall take precedence over this Name entry.
public java.lang.String getState() throws PDFNetException
PDFNetException
- * Note: The state is a state to which the original annotation shall be set. Default: "Unmarked" if StateModel is "Marked"; "None" if StateModel is "Review".
public void setState(java.lang.String state) throws PDFNetException
state
- A string that represents the state of the Text annotation.PDFNetException
- * Note: The state is a state to which the original annotation shall be set. Default: "Unmarked" if StateModel is "Marked"; "None" if StateModel is "Review".
public java.lang.String getStateModel() throws PDFNetException
PDFNetException
- * Note: The State model is the state model corresponding to the State entry;
public void setStateModel(java.lang.String statemodule) throws PDFNetException
statemodule
- - A string that represents the state model of the Text annotation.PDFNetException
- * Note: The State model is the state model corresponding to the State entry;