pdftron.PDF.Annots
Class Caret

java.lang.Object
  pdftron.PDF.Annot
      pdftron.PDF.Annots.Markup
          pdftron.PDF.Annots.Caret

public class Caret
extends Markup

A Caret annotation (PDF 1.5) is a visual symbol that indicates the presence of text edits.

Nested Class Summary

Nested classes/interfaces inherited from class pdftron.PDF.Annot

Annot.BorderStyle

Field Summary

Fields inherited from class pdftron.PDF.Annots.Markup

e_Cloudy, e_None

Fields inherited from class pdftron.PDF.Annot

e_3D, 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 Summary

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.

Method Summary

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.

Methods inherited from class pdftron.PDF.Annots.Markup

getBorderEffect, getBorderEffectIntensity, getContentRect, getCreationDates, getInteriorColor, getInteriorColorCompNum, getOpacity, getPadding, getPopup, getSubject, getTitle, setBorderEffect, SetBorderEffectIntensity, setContentRect, setCreationDates, setInteriorColor, setOpacity, SetPadding, setPopup, setSubject, setTitle

Methods inherited from class pdftron.PDF.Annot

__Create, __GetHandle, __GetRefHandle, create, equals, flatten, getActiveAppearanceState, getAppearance, getAppearance, getAppearance, getBorderStyle, getColorAsCMYK, getColorAsGray, getColorAsRGB, getColorCompNum, getContents, getDate, getFlag, getOptionalContent, getPage, getRect, getSDFObj, GetStructParent, getType, getUniqueID, isMarkup, isValid, refreshAppearance, removeAppearance, resize, setActiveAppearanceState, setAppearance, setAppearance, setAppearance, setBorderStyle, setColor, setContents, setDate, setFlag, setOptionalContent, setPage, setRect, setStructParent, setUniqueID

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Caret

public Caret(Obj d)

Creates an Caret annotation and initialize it using given Cos/SDF object.

Parameters:

d - Cos/SDF object

Note:

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Caret

public Caret()

Creates an empty Caret annotation.

Caret

public Caret(Annot annot)
      throws PDFNetException

Creates an Caret annotation and initialize it using given annotation object.

Parameters:

annot - input annotation object

Throws:

PDFNetException

Note:

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Method Detail

create

public static Caret create(Doc doc,
                           Rect pos)
                    throws PDFNetException

Creates a new Caret annotation, in the specified document.

Parameters:

doc - A document to which the Caret annotation is added.

pos - A rectangle specifying the Caret annotation's bounds, specified in user space coordinates.

Returns:

A newly created blank Caret annotation.

Throws:

PDFNetException

getSymbol

public java.lang.String getSymbol()
                           throws PDFNetException

Get the paragraph symbol displayed along with the Caret.

Returns:

A pointer to an array of charactors that specifies the Caret content.

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.

setSymbol

public void setSymbol(java.lang.String contt)
               throws PDFNetException

Set the paragraph symbol displayed along with the Caret. (Optional)

Parameters:

contt - A pointer to an array of charactors that specifies the Caret content. specifies the Caret content.

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.