public class Caret extends Markup
Annot.BorderStyle
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_Unknown, e_Watermark, e_Widget
Constructor and Description |
---|
Caret()
Creates an empty Caret annotation.
|
Caret(Annot annot)
Creates an Caret annotation and initialize it using given annotation object.
|
Caret(Obj d)
Creates an Caret annotation and initialize it using given Cos/SDF object.
|
Modifier and Type | Method and Description |
---|---|
static Caret |
create(Doc doc,
Rect pos)
Creates a new Caret annotation, in the specified document.
|
java.lang.String |
getSymbol()
Get the paragraph symbol displayed along with the Caret.
|
void |
setSymbol(java.lang.String contt)
Set the paragraph symbol displayed along with the Caret.
|
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 Caret(Obj d)
Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.
d
- Cos/SDF objectpublic Caret()
public Caret(Annot annot) throws PDFNetException
Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.
annot
- input annotation objectPDFNetException
public static Caret create(Doc doc, Rect pos) throws PDFNetException
doc
- A document to which the Caret annotation is added.pos
- A rectangle specifying the Caret annotation's bounds, specified in
user space coordinates.PDFNetException
public java.lang.String getSymbol() throws PDFNetException
Note: the content of the Caret Annotation is a name specifying a symbol that shall be associated with the Caret: P - A new paragraph symbol should be associated with the Caret. None - No symbol should be associated with the Caret. Default value: None.
PDFNetException
public void setSymbol(java.lang.String contt) throws PDFNetException
Note: the content of the Caret Annotation is a name specifying a symbol that shall be associated with the Caret: P - A new paragraph symbol should be associated with the Caret.
contt
- A pointer to an array of charactors that specifies the Caret content.
specifies the Caret content.PDFNetException
- None - No symbol should be associated with the Caret.
Default value: None.