Gnostice PDFOne
Pro. Ed. v5.0.0


com.gnostice.pdfone
Class PdfCaretAnnot

java.lang.Object
  extended bycom.gnostice.pdfone.PdfAnnot
      extended bycom.gnostice.pdfone.PdfProAnnot
          extended bycom.gnostice.pdfone.PdfCaretAnnot
All Implemented Interfaces:
Cloneable, Usable

public class PdfCaretAnnot
extends com.gnostice.pdfone.PdfProAnnot

This class represents a caret annotation. Caret annotations are identified by a caret (^) symbol and are typically used to visually indicate the presence of a text edit.

// Create a PDF page
PdfPage page = new PdfPage();

// Create a PDF font
PdfFont fontHelvetica = 
    PdfFont.create("Helvetica", 15, PdfEncodings.WINANSI);
fontHelvetica.setColor(Color.BLUE);

page.writeText("Caret Annotation", fontHelvetica, 80, 120);
page.writeText("Caret annotation displays the" 
               + " missing information in the popup window.", 
               fontHelvetica, 120, 150);

// Create a caret annotation and set its properties 
PdfCaretAnnot caretAnnot = 
  new PdfCaretAnnot(new PdfRect(367, 165, 8, 10), Color.red);
caretAnnot.setTitle("Title");
caretAnnot.setContents("This is a Caret Annotation");
caretAnnot.setSubject("Annotation Subject");
caretAnnot.setSymbol(PdfCaretAnnot.SYMBOL_PARAGRAPH);

// Add the caret annotation to the page 
page.addAnnotation(caretAnnot);


Field Summary
static int SYMBOL_NONE
          Constant specifying no associate symbol for the caret.
static int SYMBOL_PARAGRAPH
          Constant specifying a "new paragraph" symbol (¶) for the caret.
 
Fields inherited from class com.gnostice.pdfone.PdfAnnot
ANNOT_TYPE_CARET, ANNOT_TYPE_CIRCLE, ANNOT_TYPE_FILE_ATTACHMENT, ANNOT_TYPE_FREE_TEXT, ANNOT_TYPE_INK, ANNOT_TYPE_LINE, ANNOT_TYPE_LINK, ANNOT_TYPE_MARKUP, ANNOT_TYPE_POLYGON, ANNOT_TYPE_POLYLINE, ANNOT_TYPE_POPUP, ANNOT_TYPE_SQUARE, ANNOT_TYPE_STAMP, ANNOT_TYPE_TEXT, ANNOT_TYPE_WATERMARK, BORDERSTYLE_BEVELED, BORDERSTYLE_DASHED, BORDERSTYLE_INSET, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAG_HIDDEN, FLAG_INVISIBLE, FLAG_LOCKED, FLAG_NO_ROTATE, FLAG_NO_VIEW, FLAG_NO_ZOOM, FLAG_PRINT, FLAG_READONLY, FLAG_TOGGLE_NO_VIEW
 
Fields inherited from interface com.gnostice.pdfone.Usable
INCHES_TO_POINTS, MM_TO_INCHES, MM_TO_POINTS, PDF_A, PDF_AA, PDF_AC, PDF_ACROFORM, PDF_ACTION, PDF_ALTERNATEPRESENTATIONS, PDF_ANNOT, PDF_ANNOT_DEFAULT_TITLE, PDF_ANNOT_NAME, PDF_ANNOT_SUBJECT, PDF_ANNOTS, PDF_AP, PDF_ARRAYEND, PDF_ARRAYSTART, PDF_ARTBOX, PDF_AS, PDF_ASCENT, PDF_ASCII85, PDF_ASCII85_NEW, PDF_ASCIIHEX, PDF_ASCIIHEX_NEW, PDF_AuthEvent, PDF_AUTHOR, PDF_AVGWIDTH, PDF_B, PDF_BASEFONT, PDF_BBOX, PDF_BC, PDF_BE, PDF_BEFOREFORMAT, PDF_BEGINTEXT, PDF_BG, PDF_BINARYDATA, PDF_BITS_PER_COMPONENT, PDF_BL, PDF_BLEEDBOX, PDF_BLINDS, PDF_BMC, PDF_BORDER, PDF_BOX, PDF_BS, PDF_BTN, PDF_BYTERANGE, PDF_C, PDF_CA, PDF_CA_SMALL, PDF_CAPHEIGHT, PDF_CARETANNOT, PDF_CARRIAGE, PDF_CATALOG, PDF_CENTER_WINDOW, PDF_CF, PDF_CFM, PDF_CH, PDF_CID_TO_GID_MAP, PDF_CIDFONT_TYPE1, PDF_CIDFONT_TYPE2, PDF_CIDSYSTEM_INFO, PDF_CIRCLEANNOT, PDF_CL, PDF_CM, PDF_COLOMNS, PDF_COLOR, PDF_COLORSPACE, PDF_COLORSPACE_CALGRAY, PDF_COLORSPACE_CALRGB, PDF_COLORSPACE_DEVICEN, PDF_COLORSPACE_ICCBASED, PDF_COLORSPACE_LAB, PDF_COLORSPACE_SEPARATION, PDF_CONTACTINFO, PDF_CONTENTS, PDF_COUNT, PDF_COVER, PDF_CREATIONDATE, PDF_CREATOR, PDF_CROPBOX, PDF_CS, PDF_CSP, PDF_D, PDF_DA, PDF_DATE, PDF_DATE_FORMAT, PDF_DCTDECODE, PDF_DCTDECODE_NEW, PDF_DECODEPARMS, PDF_DESC, PDF_DESCENDANT, PDF_DESCENDANT_FONTS, PDF_DESCENDENTFONTS, PDF_DESCENT, PDF_DESTINATION, PDF_DESTS, PDF_DEVICE_CMYK, PDF_DEVICE_GRAY, PDF_DEVICE_RGB, PDF_DI, PDF_DICTEND, PDF_DICTSTART, PDF_DIFFERENCES, PDF_DIRECTION, PDF_DISPLAY_DOCTITLE, PDF_DISPLAY_DURATION, PDF_DISSOLVE, PDF_DM, PDF_DOC_SUBJECT, PDF_DOCMDP, PDF_DOS, PDF_DP, PDF_DR, PDF_DS, PDF_DV, PDF_DW, PDF_E, PDF_EF, PDF_EMBEDDEDFILE, PDF_EMBEDDEDFILES, PDF_EMC, PDF_ENCODING, PDF_ENCRYPT, PDF_ENCRYPTMETADATA, PDF_ENDOBJ, PDF_ENDPATH, PDF_ENDSTREAM, PDF_ENDTEXT, PDF_EOCLIP, PDF_EOF, PDF_EXTGSTATE, PDF_F, PDF_FADE, PDF_FALSE, PDF_FDESCRIPTOR, PDF_FIELD_FLAG, PDF_FIELDS, PDF_FILEATTACHMENTANNOT, PDF_FILESPEC, PDF_FILTER, PDF_FIRST, PDF_FIRST_PAGE, PDF_FIRSTCHAR, PDF_FIT, PDF_FIT_WINDOW, PDF_FITB, PDF_FITBH, PDF_FITBV, PDF_FITH, PDF_FITR, PDF_FITV, PDF_FIXEDPRINT, PDF_FLAGS, PDF_FLATE, PDF_FLATE_NEW, PDF_FLY, PDF_FO, PDF_FONT, PDF_FONTBBOX, PDF_FONTDESCRIPTOR, PDF_FONTFILE, PDF_FONTFILE_2, PDF_FontFile_3, PDF_FONTFILE2, PDF_FONTNAME, PDF_FONTNAMEPREFIX, PDF_FORM, PDF_FORMFEED, PDF_FORMFONTPREFIX, PDF_FREE_TEXT_CALLOUT, PDF_FREE_TEXT_TYPEWRITER, PDF_FREETEXTANNOT, PDF_FS, PDF_FT, PDF_FULLSCREEN, PDF_GLITTER, PDF_GOTO_ACTION, PDF_GROUP, PDF_GS, PDF_H, PDF_HEADER, PDF_HEIGHT, PDF_HEXSTRINGEND, PDF_HEXSTRINGSTART, PDF_HIDE_MENUBAR, PDF_HIDE_TOOLBAR, PDF_HIDE_WINDOWUI, PDF_HIGHLIGHT, PDF_HORIZ_STEM, PDF_HORIZONTAL, PDF_I, PDF_IC, PDF_ID, PDF_IDS, PDF_IF, PDF_IMAGE, PDF_IMAGEB, PDF_IMAGEC, PDF_IMAGEI, PDF_IMPORTDATA, PDF_INDEX, PDF_INDEXED, PDF_INFO, PDF_INK, PDF_INKLIST, PDF_INWARD, PDF_IT, PDF_ITALANGLE, PDF_IX, PDF_JAVASCRIPT, PDF_JAVASCRIPT_ACTION, PDF_JS, PDF_KEYSTROKE, PDF_KEYWORDS, PDF_KIDS, PDF_L, PDF_L2R, PDF_LANG, PDF_LAST, PDF_LAST_PAGE, PDF_LASTCHAR, PDF_LAUNCH_ACTION, PDF_LE, PDF_LEGAL, PDF_LENGTH, PDF_LENGTH_1, PDF_LENGTH_2, PDF_LENGTH_3, PDF_LF, PDF_LINEANNOT, PDF_LINKANNOT, PDF_LITERALSTRINGEND, PDF_LITERALSTRINGSTART, PDF_LOCATION, PDF_LZWDECODE, PDF_M, PDF_MAC, PDF_MARKINFO, PDF_MATRIX, PDF_MAXLEN, PDF_MAXWIDTH, PDF_MEDIABOX, PDF_METADATA, PDF_MISSINGWIDTH, PDF_MK, PDF_MODDATE, PDF_N, PDF_NAME, PDF_NAMED, PDF_NAMED_ACT_FIND, PDF_NAMED_ACT_OPEN, PDF_NAMED_ACT_PRINT, PDF_NAMED_ACT_SEARCH, PDF_NAMES, PDF_NAMESTART, PDF_NEEDAPPEARANCES, PDF_NEWLINE, PDF_NEWWINDOW, PDF_NEXT, PDF_NEXT_PAGE, PDF_NO_COMP_OBJ, PDF_NONFULLSCREEN_PAGEMODE, PDF_NULL, PDF_O, PDF_OBJ, PDF_OBJSTREAM, PDF_OCPROPERTIES, PDF_OFF, PDF_ONECOLUMN, PDF_OPEN, PDF_OPEN_ACTION, PDF_OPT, PDF_OUTLINES, PDF_OUTPUTINTENTS, PDF_OUTWARD, PDF_P, PDF_PAGE, PDF_PAGECLOSE, PDF_PAGEINVISIBLE, PDF_PAGELABELS, PDF_PAGELAYOUT, PDF_PAGEMODE, PDF_PAGEOPEN, PDF_PAGES, PDF_PAGEVISIBLE, PDF_PAINT_TYPE, PDF_PARAMS, PDF_PARENT, PDF_PATTERN, PDF_PATTERN_TYPE, PDF_PBD, PDF_PC, PDF_PDC, PDF_PDF, PDF_PERMS, PDF_PFD, PDF_PH, PDF_PIECEINFO, PDF_POLYGONANNOT, PDF_POLYLINEANNOT, PDF_POPUP, PDF_PREDICTOR, PDF_PREV, PDF_PREV_PAGE, PDF_PROCSET, PDF_PRODUCER, PDF_PROPERTIES, PDF_PUSH, PDF_PV, PDF_Q, PDF_QUADPOINTS, PDF_R, PDF_R2L, PDF_RC, PDF_RD, PDF_RE, PDF_REASON, PDF_RECALCULATE, PDF_RECT, PDF_REMOTEGOTO_ACTION, PDF_RENDITIONS, PDF_REPLACE, PDF_RESET_FORM, PDF_RESOURCES, PDF_RESTORE_GS, PDF_RI, PDF_ROOT, PDF_ROTATE, PDF_RUNLENGTH, PDF_RUNLENGTH_NEW, PDF_S, PDF_SCN, PDF_SHADING, PDF_SHOWIMG, PDF_SHOWTEXT, PDF_SHOWTEXT_TJ, PDF_SIG, PDF_SIG_FILTER_ADOBE_PPKLITE, PDF_SIG_FILTER_ADOBE_PPKMS, PDF_SIG_SUBFILTER_ADBE_PKCS7_DETACHED, PDF_SIG_SUBFILTER_ADBE_PKCS7_SHA1, PDF_SINGLE_QUOTES, PDF_SINGLEPAGE, PDF_SIZE, PDF_SP, PDF_SPIDERINFO, PDF_SPLIT, PDF_SQUAREANNOT, PDF_SQUIGGLY, PDF_SS, PDF_STAMPANNOT, PDF_STARTXREF, PDF_StmF, PDF_STORE_GS, PDF_STREAM, PDF_StrF, PDF_STRIKEOUT, PDF_STRUCT_TREE, PDF_SUBFILTER, PDF_SUBMIT_FORM, PDF_SUBTYPE, PDF_T, PDF_TAB, PDF_TEMPLATES, PDF_TEXT, PDF_TEXTANNOT, PDF_TEXTDIMENSION, PDF_TEXTFONT, PDF_TEXTLEAD, PDF_TEXTMATRIX, PDF_TEXTNEWLINESTART, PDF_TEXTRENDER, PDF_TEXTWIDTH, PDF_THREADS, PDF_THUMB, PDF_TILING_TYPE, PDF_TITLE, PDF_TJ_OPERAND_END, PDF_TJ_OPERAND_START, PDF_TM, PDF_TOUNICODE, PDF_TP, PDF_TRAILER, PDF_TRANSITION, PDF_TRIMBOX, PDF_TRUE, PDF_TRUETYPE, PDF_TU, PDF_TWOCOLUMN_LEFT, PDF_TWOCOLUMN_RIGHT, PDF_TWOPAGE_LEFT, PDF_TWOPAGE_RIGHT, PDF_TX, PDF_TYPE, PDF_TYPE0, PDF_TYPE1, PDF_U, PDF_UNCOVER, PDF_UNDERLINE, PDF_UNIX, PDF_URI_ACTION, PDF_URL, PDF_URLS, PDF_USEATTACHMENTS, PDF_USENONE, PDF_USEOC, PDF_USEOUTLINES, PDF_USETHUMBS, PDF_V, PDF_VALUECHANGE, PDF_VERSION, PDF_VERT_STEM, PDF_VERTICAL, PDF_VERTICES, PDF_VIEWER_PREFERENCES, PDF_W, PDF_WATERMARKANNOT, PDF_WIDGET, PDF_WIDTH, PDF_WIDTHS, PDF_WINANSIENCODING, PDF_WIPE, PDF_X, PDF_XOBJECT, PDF_XREF, PDF_XREFSTMOFFSET, PDF_XREFSTREAM, PDF_XSTEP, PDF_XYZ, PDF_YES, PDF_YSTEP, PIXEL_PER_INCH, RUBICON_EMBEDDED, SITE, TEXT, TWIPS_TO_POINTS
 
Constructor Summary
PdfCaretAnnot()
          Zero-argument default constructor.
PdfCaretAnnot(PdfRect r, Color c)
          Constructs a caret annotation with specified rectangle and color.
PdfCaretAnnot(PdfRect r, int flags)
          Constructs a caret annotation with specified rectangle and flags.
PdfCaretAnnot(PdfRect r, int flags, Color c)
          Constructs a caret annotation with specified rectangle, flags, and color.
PdfCaretAnnot(PdfRect r, String subject, String contents, String title)
          Constructs a caret annotation with specified rectangle, and popup window subject, conent and title.
PdfCaretAnnot(PdfRect r, String subject, String contents, String title, Color c)
          Constructs a caret annotation with specified rectangle, popup window subject, conent and title, and color.
PdfCaretAnnot(PdfRect r, String subject, String contents, String title, int flags)
          Constructs a caret annotation with specified rectangle, popup window subject, conent and title, flags, color, and associated symbol.
PdfCaretAnnot(PdfRect r, String subject, String contents, String title, int flags, Color c)
          Constructs a caret annotation with specified rectangle, popup window subject, conent and title, flags, and color.
PdfCaretAnnot(PdfRect r, String subject, String contents, String title, int flags, Color c, int symbol)
          Constructs a caret annotation with specified rectangle, popup window subject, conent and title, flags, color, and associated symbol.
 
Method Summary
 Object clone()
           
 double getBottomRD()
          Returns distance between the bottom edge of the caret and the bottom edge of the annotation rectangle.
 PdfRect getDiffRect()
          Returns rectangle of the caret inside the annotation rectangle.
 PdfAppearanceStream getDownAppearance()
          Returns the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.
 double getLeftRD()
          Returns distance between the left edge of the caret and the left edge of the annotation rectangle.
 PdfAppearanceStream getNormalAppearance()
          Returns the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).
 PdfPopUpAnnot getPopup()
          Returns a popup annotation that needs to be used by a viewer application to display the popup window for this annotation.
 double getRightRD()
          Returns distance between the right edge of the caret and the right edge of the annotation rectangle.
 PdfAppearanceStream getRolloverAppearance()
          Returns the appearance stream that needs to be used by a viewer application to display the annotation when the user places the mouse pointer over the annotation (and does not hold down the mouse button).
 int getSymbol()
          Returns constant for any symbol associated with the caret annotation.
 double getTopRD()
          Returns distance between the top edge of the caret and the top edge of the annotation rectangle.
 float getTransparency()
           
 void setBottomRD(float bottomRD)
          Specifies distance between the bottom edge of the caret and the bottom edge of the annotation rectangle.
 void setDiffRect(PdfRect diffRect)
          Specifies a rectangle for the caret inside the annotation rectangle.
 void setDownAppearance(PdfAppearanceStream downAppearance)
          Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.
 void setLeftRD(float leftRD)
          Specifies distance between the left edge of the caret and the left edge of the annotation rectangle.
 void setNormalAppearance(PdfAppearanceStream normalAppearance)
          Specifies the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).
 void setPopup(PdfPopUpAnnot popup, boolean overridePopUpProperties)
          Specifies a popup annotation that needs to be used by a viewer application to display the popup window for this annotation.
 void setRightRD(float rightRD)
          Specifies distance between the right edge of the caret and the right edge of the annotation rectangle.
 void setRolloverAppearance(PdfAppearanceStream rolloverAppearance)
          Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field (and does not hold down the mouse button).
 void setSymbol(int symbol)
          Specifies a symbol that needs to be associated with caret.
 void setTopRD(float topRD)
          Specifies distance between the top edge of the caret and the top edge of the annotation rectangle.
 void setTransparency(float transparecyLevel)
           
 
Methods inherited from class com.gnostice.pdfone.PdfAnnot
delete, getAnnotName, getBorderStyle, getBorderWidth, getBottom, getColor, getContents, getDashPattern, getFlags, getLeft, getRect, getRight, getSubject, getTitle, getTop, getType, hashCode, isDeleted, isShowRect, setAnnotName, setBorderStyle, setBorderWidth, setColor, setContents, setDashPattern, setFlags, setRect, setRect, setRect, setRect, setRect, setShowRect, setSubject, setTitle
 
Methods inherited from class java.lang.Object
equals, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SYMBOL_NONE

public static final int SYMBOL_NONE
Constant specifying no associate symbol for the caret.

See Also:
Constant Field Values

SYMBOL_PARAGRAPH

public static final int SYMBOL_PARAGRAPH
Constant specifying a "new paragraph" symbol (¶) for the caret.

See Also:
Constant Field Values
Constructor Detail

PdfCaretAnnot

public PdfCaretAnnot()
Zero-argument default constructor.


PdfCaretAnnot

public PdfCaretAnnot(PdfRect r,
                     String subject,
                     String contents,
                     String title,
                     int flags,
                     Color c,
                     int symbol)
              throws IOException,
                     PdfException
Constructs a caret annotation with specified rectangle, popup window subject, conent and title, flags, color, and associated symbol.

Parameters:
r - annotation rectangle - rectangular area on a page where the annotation is located
subject - text used as subject of the annotation
contents - text used as title of the annotation
title - text used as title of the annotation
flags - annotation attributes
c - color of the caret
symbol - constant for any associate symbol
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.

PdfCaretAnnot

public PdfCaretAnnot(PdfRect r,
                     String subject,
                     String contents,
                     String title)
              throws IOException,
                     PdfException
Constructs a caret annotation with specified rectangle, and popup window subject, conent and title.

Parameters:
r - annotation rectangle - rectangular area on a page where the annotation is located
subject - text used as subject of the annotation
contents - text used as title of the annotation
title - text used as title of the annotation
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.

PdfCaretAnnot

public PdfCaretAnnot(PdfRect r,
                     String subject,
                     String contents,
                     String title,
                     Color c)
              throws IOException,
                     PdfException
Constructs a caret annotation with specified rectangle, popup window subject, conent and title, and color.

Parameters:
r - annotation rectangle - rectangular area on a page where the annotation is located
subject - text used as subject of the annotation
contents - text used as title of the annotation
title - text used as title of the annotation
c - color of the caret
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.

PdfCaretAnnot

public PdfCaretAnnot(PdfRect r,
                     String subject,
                     String contents,
                     String title,
                     int flags)
              throws IOException,
                     PdfException
Constructs a caret annotation with specified rectangle, popup window subject, conent and title, flags, color, and associated symbol.

Parameters:
r - annotation rectangle - rectangular area on a page where the annotation is located
subject - text used as subject of the annotation
contents - text used as title of the annotation
title - text used as title of the annotation
flags - annotation attributes
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.

PdfCaretAnnot

public PdfCaretAnnot(PdfRect r,
                     String subject,
                     String contents,
                     String title,
                     int flags,
                     Color c)
              throws IOException,
                     PdfException
Constructs a caret annotation with specified rectangle, popup window subject, conent and title, flags, and color.

Parameters:
r - annotation rectangle - rectangular area on a page where the annotation is located
subject - text used as subject of the annotation
contents - text used as title of the annotation
title - text used as title of the annotation
flags - annotation attributes
c - color of the caret
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.

PdfCaretAnnot

public PdfCaretAnnot(PdfRect r,
                     int flags)
              throws IOException,
                     PdfException
Constructs a caret annotation with specified rectangle and flags.

Parameters:
r - annotation rectangle - rectangular area on a page where the annotation is located
flags - annotation attributes
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.

PdfCaretAnnot

public PdfCaretAnnot(PdfRect r,
                     int flags,
                     Color c)
              throws IOException,
                     PdfException
Constructs a caret annotation with specified rectangle, flags, and color.

Parameters:
r - annotation rectangle (rectangular area on a page where the annotation is located)
flags - annotation attributes
c - color of the caret
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.

PdfCaretAnnot

public PdfCaretAnnot(PdfRect r,
                     Color c)
              throws IOException,
                     PdfException
Constructs a caret annotation with specified rectangle and color.

Parameters:
r - annotation rectangle - rectangular area on a page where the annotation is located
c - color of the caret
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Method Detail

clone

public Object clone()

getSymbol

public int getSymbol()
Returns constant for any symbol associated with the caret annotation.

Returns:
constant for any symbol associated with the caret annotation
See Also:
setSymbol(int)

setSymbol

public void setSymbol(int symbol)
Specifies a symbol that needs to be associated with caret. Default is SYMBOL_NONE.

Parameters:
symbol - constant for a symbol associated with caret
See Also:
getSymbol(), SYMBOL_PARAGRAPH

getDiffRect

public PdfRect getDiffRect()
Returns rectangle of the caret inside the annotation rectangle.

Returns:
rectangle of the caret inside the annotation caret
See Also:
setDiffRect(PdfRect)

setDiffRect

public void setDiffRect(PdfRect diffRect)
Specifies a rectangle for the caret inside the annotation rectangle. A separate rectangle for the caret becomes necessary when the associated symbol is {set for the annotation.

Parameters:
diffRect - a rectangle for the caret inside the annotation rectangle
See Also:
getDiffRect()

getBottomRD

public double getBottomRD()
Returns distance between the bottom edge of the caret and the bottom edge of the annotation rectangle.

Returns:
distance between the bottom edge of the caret and the bottom edge of the annotation rectangle
See Also:
setBottomRD(float)

setBottomRD

public void setBottomRD(float bottomRD)
Specifies distance between the bottom edge of the caret and the bottom edge of the annotation rectangle.

Parameters:
bottomRD - distance between the bottom edge of the caret and the bottom edge of the annotation rectangle
See Also:
getBottomRD()

getLeftRD

public double getLeftRD()
Returns distance between the left edge of the caret and the left edge of the annotation rectangle.

Returns:
distance between the left edge of the caret and the left edge of the annotation rectangle.
See Also:
setLeftRD(float)

setLeftRD

public void setLeftRD(float leftRD)
Specifies distance between the left edge of the caret and the left edge of the annotation rectangle.

Parameters:
leftRD - distance between the left edge of the caret and the left edge of the annotation rectangle
See Also:
getLeftRD()

getRightRD

public double getRightRD()
Returns distance between the right edge of the caret and the right edge of the annotation rectangle.

Returns:
distance between the right edge of the caret and the right edge of the annotation rectangle
See Also:
setRightRD(float)

setRightRD

public void setRightRD(float rightRD)
Specifies distance between the right edge of the caret and the right edge of the annotation rectangle.

Parameters:
rightRD - distance between the right edge of the caret and the right edge of the annotation rectangle.
See Also:
getRightRD()

getTopRD

public double getTopRD()
Returns distance between the top edge of the caret and the top edge of the annotation rectangle.

Returns:
distance between the top edge of the caret and the top edge of the annotation rectangle
See Also:
setTopRD(float)

setTopRD

public void setTopRD(float topRD)
Specifies distance between the top edge of the caret and the top edge of the annotation rectangle.

Parameters:
topRD - distance between the top edge of the caret and the top edge of the annotation rectangle.
See Also:
getTopRD()

setTransparency

public void setTransparency(float transparecyLevel)

getTransparency

public float getTransparency()

getPopup

public PdfPopUpAnnot getPopup()
Returns a popup annotation that needs to be used by a viewer application to display the popup window for this annotation.

Returns:
popup annotation that needs to be used as the popup window

setPopup

public void setPopup(PdfPopUpAnnot popup,
                     boolean overridePopUpProperties)
Specifies a popup annotation that needs to be used by a viewer application to display the popup window for this annotation.

Parameters:
popup - popup annotation that needs to be used as the popup window
overridePopUpProperties - whether a viewer application should override the properties of the popup annotation with those of this annotation
See Also:
PdfProAnnot.getPopup()

getDownAppearance

public PdfAppearanceStream getDownAppearance()
Returns the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.

See Also:
PdfProAnnot.getNormalAppearance(), PdfProAnnot.getDownAppearance(), PdfProAnnot.setNormalAppearance(PdfAppearanceStream), PdfProAnnot.setRolloverAppearance(PdfAppearanceStream), PdfProAnnot.setDownAppearance(PdfAppearanceStream)

setDownAppearance

public void setDownAppearance(PdfAppearanceStream downAppearance)
Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.

See Also:
PdfProAnnot.getNormalAppearance(), PdfProAnnot.getDownAppearance(), PdfProAnnot.getRolloverAppearance(), PdfProAnnot.setNormalAppearance(PdfAppearanceStream), PdfProAnnot.setRolloverAppearance(PdfAppearanceStream)

getNormalAppearance

public PdfAppearanceStream getNormalAppearance()
Returns the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).

See Also:
PdfProAnnot.getDownAppearance(), PdfProAnnot.getRolloverAppearance(), PdfProAnnot.setNormalAppearance(PdfAppearanceStream), PdfProAnnot.setDownAppearance(PdfAppearanceStream), PdfProAnnot.setRolloverAppearance(PdfAppearanceStream)

setNormalAppearance

public void setNormalAppearance(PdfAppearanceStream normalAppearance)
Specifies the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).

Parameters:
normalAppearance - the specified appearance stream
See Also:
PdfProAnnot.setDownAppearance(PdfAppearanceStream), PdfProAnnot.setRolloverAppearance(PdfAppearanceStream), PdfProAnnot.getNormalAppearance(), PdfProAnnot.getDownAppearance(), PdfProAnnot.getRolloverAppearance()

getRolloverAppearance

public PdfAppearanceStream getRolloverAppearance()
Returns the appearance stream that needs to be used by a viewer application to display the annotation when the user places the mouse pointer over the annotation (and does not hold down the mouse button).

See Also:
PdfProAnnot.getNormalAppearance(), PdfProAnnot.getDownAppearance(), PdfProAnnot.setNormalAppearance(PdfAppearanceStream), PdfProAnnot.setDownAppearance(PdfAppearanceStream), PdfProAnnot.setRolloverAppearance(PdfAppearanceStream)

setRolloverAppearance

public void setRolloverAppearance(PdfAppearanceStream rolloverAppearance)
Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field (and does not hold down the mouse button).

Parameters:
rolloverAppearance - the specified appearance stream
See Also:
PdfProAnnot.setNormalAppearance(PdfAppearanceStream), PdfProAnnot.setDownAppearance(PdfAppearanceStream), PdfProAnnot.getNormalAppearance(), PdfProAnnot.getDownAppearance(), PdfProAnnot.getRolloverAppearance()

Gnostice PDFOne
Pro. Ed. v5.0.0

To contact our support team, send an e-mail to support@gnostice.com.
 
© 2010 Gnostice Information Technologies Private Limited. All rights reserved.
www.gnostice.com