Gnostice PDFOne
Pro. Ed. v5.0.0


com.gnostice.pdfone
Class PdfPolylineAnnot

java.lang.Object
  extended bycom.gnostice.pdfone.PdfAnnot
      extended bycom.gnostice.pdfone.PdfProAnnot
          extended bycom.gnostice.pdfone.PdfPolylineAnnot
All Implemented Interfaces:
Cloneable, Usable
Direct Known Subclasses:
PdfPolygonAnnot

public class PdfPolylineAnnot
extends com.gnostice.pdfone.PdfProAnnot

This class represents a polyline annotation. A polyline annotation represents a set of lines representing an open or closed figure. A polyline annotation is built around a set of points that form the starting and ending points of the lines. A polygon annotation is derivation of the polyline annotation where a closed figure is formed. To specify the locations of the vertices, use the setVertices() method. To specify line-ending styles for an annotation, use methods such as setLineStartStyle(int) with constants such as LINEENDSTYLE_OPEN_ARROW. Here is a sample code snippet that illustrates how to create a polyline annotation.

PdfWriter writer1 = PdfWriter.fileWriter(
           new File("PdfPolylineAnnot_example.pdf"));
PdfDocument doc1 = new PdfDocument(writer1);
PdfPage p1 = new PdfPage();
doc1.add(p1);

// Define x-y coordinates for the lines forming the
// polyline
double vcs[] = { 100,100,150,150,200,250,300,300 };        

// Create a polyline annotation
PdfPolylineAnnot pla1 = 
    new PdfPolylineAnnot(
            vcs, 
            "Subject line", 
            "text content", 
            "title text", 
            PdfAnnot.FLAG_PRINT, 
            Color.YELLOW);

// Specify color used to fill the ends of the polyline
pla1.setInteriorColor(Color.ORANGE);

// Specify line-ending styles for the ends of the polyline
pla1.setLineStartStyle(PdfPolylineAnnot.LINEENDSTYLE_CIRCLE);
pla1.setLineEndStyle(PdfPolylineAnnot.LINEENDSTYLE_SQUARE);

// Add annotation to the document
doc1.addAnnotation(pla1, 1);

doc1.setOpenAfterSave(true);
doc1.write();
writer1.dispose();


Field Summary
static int LINEENDSTYLE_BUTT
          Constant for specifying a perpendicular line at the end of a polyline.
static int LINEENDSTYLE_CIRCLE
          Constant for specifying a circle-shaped end of a polyline.
static int LINEENDSTYLE_CLOSED_ARROW
          Constant for specifying a triangular arrow-like end of a polyline.
static int LINEENDSTYLE_DIAMOND
          Constant for specifying a diamond-shaped end of a polyline.
static int LINEENDSTYLE_NONE
          Constant for specifying an abrupt end of a polyline.
static int LINEENDSTYLE_OPEN_ARROW
          Constant for specifying an arrow-like end of a polyline.
static int LINEENDSTYLE_RCLOSED_ARROW
          Constant for specifying an inverted triangular arrow-like end of a polyline.
static int LINEENDSTYLE_ROPEN_ARROW
          Constant for specifying an inverted arrow-like end of a polyline.
static int LINEENDSTYLE_SLASH
          Constant for specifying a slanted line at the end of a polyline.
static int LINEENDSTYLE_SQUARE
          Constant for specifying a square-shaped end of a polyline.
 
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
PdfPolylineAnnot()
          Zero-argument default constructor.
PdfPolylineAnnot(double[] vertices, Color c)
           
PdfPolylineAnnot(double[] vertices, int flags)
           
PdfPolylineAnnot(double[] vertices, int flags, Color c)
           
PdfPolylineAnnot(double[] vertices, String subject, String contents, String title)
           
PdfPolylineAnnot(double[] vertices, String subject, String contents, String title, Color c)
           
PdfPolylineAnnot(double[] vertices, String subject, String contents, String title, int flags)
           
PdfPolylineAnnot(double[] vertices, String subject, String contents, String title, int flags, Color c)
           
PdfPolylineAnnot(PdfRect r, Color c)
          Deprecated. Instead, use PdfPolylineAnnot(double[], Color).
PdfPolylineAnnot(PdfRect r, int flags)
          Deprecated. Instead, use PdfPolylineAnnot(double[], int).
PdfPolylineAnnot(PdfRect r, int flags, Color c)
          Deprecated. Instead, use PdfPolylineAnnot(double[], int, Color).
PdfPolylineAnnot(PdfRect r, String subject, String contents, String title)
          Deprecated.  
PdfPolylineAnnot(PdfRect r, String subject, String contents, String title, Color c)
          Deprecated. Instead, use PdfPolylineAnnot(double[], String, String, String, Color).
PdfPolylineAnnot(PdfRect r, String subject, String contents, String title, int flags)
          Deprecated. Instead, use PdfPolylineAnnot(double[], String, String, String, int).
PdfPolylineAnnot(PdfRect r, String subject, String contents, String title, int flags, Color c)
          Deprecated. Instead, use PdfPolylineAnnot(PdfRect, String, String, String, int, Color).
PdfPolylineAnnot(PdfRect r, String subject, String contents, String title, int flags, Color c, int lineStartStyle, int lineEndStyle, Color interior, double[] vertices)
          Deprecated.  
 
Method Summary
 Object clone()
           
 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.
 Color getInteriorColor()
          Returns color used to fill the ends of the polyline.
 int getLineEndStyle()
          Returns line-ending style of the end of the polyline.
 int getLineStartStyle()
          Returns line-ending style of the beginning of the polyline.
 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.
 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).
 float getTransparency()
           
 double[] getVertices()
          Returns locations that are connected by lines to form the polygon or polyline shape of the annotation.
 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 setInteriorColor(Color interiorColor)
          Specifies color that needs to be used to fill the ends of the polyline.
 void setLineEndStyle(int lineEndStyle)
          Specifies line-ending style for the end of the polyline.
 void setLineStartStyle(int lineStartStyle)
          Specifies line-ending style for the beginning of the polyline.
 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 setRect(double x, double y, double width, double height)
          Specifies annotation rectangle for this annotation at (x, y) with specified width and height.
 void setRect(double x, double y, double width, double height, int mu)
          Specifies annotation rectangle for this annotation in specified measurement unit.
 void setRect(PdfRect r)
          Specifies PdfRect object as annotation rectangle for this annotation.
 void setRect(PdfRect r, int mu)
          Specifies PdfRect object as annotation rectangle for this annotation in specified measurement unit.
 void setRect(Rectangle r)
          Specifies Rectangle object as annotation rectangle for this annotation.
 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 setTransparency(float transparecyLevel)
           
 void setVertices(double[] vertices)
          Specifies locations that need to be connected by lines to form the polygon or polyline shape of the annotation.
 void setVertices(double[] vertices, int measurementUnit)
          Specifies locations in specified measurement units that need to be connected by lines to form the polygon or polyline shape of the annotation.
 
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, setShowRect, setSubject, setTitle
 
Methods inherited from class java.lang.Object
equals, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LINEENDSTYLE_SQUARE

public static final int LINEENDSTYLE_SQUARE
Constant for specifying a square-shaped end of a polyline.

See Also:
Constant Field Values

LINEENDSTYLE_CIRCLE

public static final int LINEENDSTYLE_CIRCLE
Constant for specifying a circle-shaped end of a polyline.

See Also:
Constant Field Values

LINEENDSTYLE_DIAMOND

public static final int LINEENDSTYLE_DIAMOND
Constant for specifying a diamond-shaped end of a polyline.

See Also:
Constant Field Values

LINEENDSTYLE_OPEN_ARROW

public static final int LINEENDSTYLE_OPEN_ARROW
Constant for specifying an arrow-like end of a polyline.

See Also:
Constant Field Values

LINEENDSTYLE_CLOSED_ARROW

public static final int LINEENDSTYLE_CLOSED_ARROW
Constant for specifying a triangular arrow-like end of a polyline.

See Also:
Constant Field Values

LINEENDSTYLE_NONE

public static final int LINEENDSTYLE_NONE
Constant for specifying an abrupt end of a polyline.

See Also:
Constant Field Values

LINEENDSTYLE_BUTT

public static final int LINEENDSTYLE_BUTT
Constant for specifying a perpendicular line at the end of a polyline.

See Also:
Constant Field Values

LINEENDSTYLE_ROPEN_ARROW

public static final int LINEENDSTYLE_ROPEN_ARROW
Constant for specifying an inverted arrow-like end of a polyline.

See Also:
Constant Field Values

LINEENDSTYLE_RCLOSED_ARROW

public static final int LINEENDSTYLE_RCLOSED_ARROW
Constant for specifying an inverted triangular arrow-like end of a polyline.

See Also:
Constant Field Values

LINEENDSTYLE_SLASH

public static final int LINEENDSTYLE_SLASH
Constant for specifying a slanted line at the end of a polyline.

See Also:
Constant Field Values
Constructor Detail

PdfPolylineAnnot

public PdfPolylineAnnot()
Zero-argument default constructor.


PdfPolylineAnnot

public PdfPolylineAnnot(PdfRect r,
                        String subject,
                        String contents,
                        String title,
                        int flags,
                        Color c,
                        int lineStartStyle,
                        int lineEndStyle,
                        Color interior,
                        double[] vertices)
                 throws IOException,
                        PdfException
Deprecated.  


PdfPolylineAnnot

public PdfPolylineAnnot(PdfRect r,
                        String subject,
                        String contents,
                        String title)
                 throws IOException,
                        PdfException
Deprecated.  


PdfPolylineAnnot

public PdfPolylineAnnot(PdfRect r,
                        String subject,
                        String contents,
                        String title,
                        Color c)
                 throws IOException,
                        PdfException
Deprecated. Instead, use PdfPolylineAnnot(double[], String, String, String, Color).


PdfPolylineAnnot

public PdfPolylineAnnot(double[] vertices,
                        String subject,
                        String contents,
                        String title,
                        Color c)
                 throws IOException,
                        PdfException

PdfPolylineAnnot

public PdfPolylineAnnot(PdfRect r,
                        String subject,
                        String contents,
                        String title,
                        int flags)
                 throws IOException,
                        PdfException
Deprecated. Instead, use PdfPolylineAnnot(double[], String, String, String, int).


PdfPolylineAnnot

public PdfPolylineAnnot(double[] vertices,
                        String subject,
                        String contents,
                        String title,
                        int flags)
                 throws IOException,
                        PdfException

PdfPolylineAnnot

public PdfPolylineAnnot(PdfRect r,
                        String subject,
                        String contents,
                        String title,
                        int flags,
                        Color c)
                 throws IOException,
                        PdfException
Deprecated. Instead, use PdfPolylineAnnot(PdfRect, String, String, String, int, Color).


PdfPolylineAnnot

public PdfPolylineAnnot(double[] vertices,
                        String subject,
                        String contents,
                        String title,
                        int flags,
                        Color c)
                 throws IOException,
                        PdfException

PdfPolylineAnnot

public PdfPolylineAnnot(PdfRect r,
                        int flags)
                 throws IOException,
                        PdfException
Deprecated. Instead, use PdfPolylineAnnot(double[], int).


PdfPolylineAnnot

public PdfPolylineAnnot(double[] vertices,
                        int flags)
                 throws IOException,
                        PdfException

PdfPolylineAnnot

public PdfPolylineAnnot(PdfRect r,
                        int flags,
                        Color c)
                 throws IOException,
                        PdfException
Deprecated. Instead, use PdfPolylineAnnot(double[], int, Color).


PdfPolylineAnnot

public PdfPolylineAnnot(double[] vertices,
                        int flags,
                        Color c)
                 throws IOException,
                        PdfException

PdfPolylineAnnot

public PdfPolylineAnnot(double[] vertices,
                        String subject,
                        String contents,
                        String title)
                 throws IOException,
                        PdfException

PdfPolylineAnnot

public PdfPolylineAnnot(PdfRect r,
                        Color c)
                 throws IOException,
                        PdfException
Deprecated. Instead, use PdfPolylineAnnot(double[], Color).


PdfPolylineAnnot

public PdfPolylineAnnot(double[] vertices,
                        Color c)
                 throws IOException,
                        PdfException
Method Detail

clone

public Object clone()

getInteriorColor

public Color getInteriorColor()
Returns color used to fill the ends of the polyline.

Returns:
color used to fill the ends of the polyline

setInteriorColor

public void setInteriorColor(Color interiorColor)
Specifies color that needs to be used to fill the ends of the polyline.

Parameters:
interiorColor - color that needs to be used to fill the ends of the polyline

getVertices

public double[] getVertices()
Returns locations that are connected by lines to form the polygon or polyline shape of the annotation.

Returns:
x-y coordinates of the locations in the format (x1, y1, x2, y2, x3, y3...)
See Also:
setVertices(double[]), setVertices(double[], int)

setVertices

public void setVertices(double[] vertices)
Specifies locations that need to be connected by lines to form the polygon or polyline shape of the annotation.

Parameters:
vertices - x-y coordinates of the locations in the format (x1, y1, x2, y2, x3, y3...). In case of a polygon annotation, the last set of x-y coordinates will be connected with the first set to form the closed figure of a polygon.
See Also:
getVertices()

setVertices

public void setVertices(double[] vertices,
                        int measurementUnit)
Specifies locations in specified measurement units that need to be connected by lines to form the polygon or polyline shape of the annotation.

Parameters:
vertices - x-y coordinates of the locations in the format (x1, y1, x2, y2, x3, y3...). In case of a polygon annotation, the last set of x-y coordinates will be connected with the first set to form the closed figure of a polygon.
measurementUnit - constant specifying the measurement unit
See Also:
getVertices(), PdfMeasurement

getLineStartStyle

public final int getLineStartStyle()
Returns line-ending style of the beginning of the polyline.

Returns:
constant identifying the line-ending style
See Also:
setLineStartStyle(int), getLineEndStyle(), setLineEndStyle(int)

setLineStartStyle

public final void setLineStartStyle(int lineStartStyle)
Specifies line-ending style for the beginning of the polyline. Default style is LINEENDSTYLE_SQUARE.

Parameters:
lineStartStyle - constant specifying the line-ending style
See Also:
getLineStartStyle(), setLineEndStyle(int), getLineEndStyle()

setTransparency

public void setTransparency(float transparecyLevel)

getTransparency

public float getTransparency()

getLineEndStyle

public final int getLineEndStyle()
Returns line-ending style of the end of the polyline.

Returns:
constant identifying the line-ending style
See Also:
setLineEndStyle(int), setLineStartStyle(int), getLineStartStyle()

setLineEndStyle

public final void setLineEndStyle(int lineEndStyle)
Specifies line-ending style for the end of the polyline. Default style is LINEENDSTYLE_SQUARE.

Parameters:
lineEndStyle - constant specifying the line-ending style
See Also:
getLineEndStyle(), getLineStartStyle(), setLineStartStyle(int)

setRect

public void setRect(double x,
                    double y,
                    double width,
                    double height)
Deprecated.  

Description copied from class: PdfAnnot
Specifies annotation rectangle for this annotation at (x, y) with specified width and height.

The position (x, y), and dimensions width and height are applied in the default measurement unit of the page to which the annotation is added.

Overrides:
setRect in class PdfAnnot
Parameters:
x - x-coordinate of the annotation rectangle
y - y-coordinate of the annotation rectangle
width - width of the annotation rectangle
height - height of the annotation rectangle
See Also:
PdfAnnot.getRect()

setRect

public void setRect(double x,
                    double y,
                    double width,
                    double height,
                    int mu)
Deprecated.  

Description copied from class: PdfAnnot
Specifies annotation rectangle for this annotation in specified measurement unit.

Overrides:
setRect in class PdfAnnot
Parameters:
x - x-coordinate of the annotation rectangle
y - y-coordinate of the annotation rectangle
width - width of the annotation rectangle
height - height of the annotation rectangle
mu - measurement unit with which the annotation rectangle is specified
See Also:
PdfAnnot.getRect()

setRect

public void setRect(PdfRect r)
Deprecated.  

Description copied from class: PdfAnnot
Specifies PdfRect object as annotation rectangle for this annotation.

The position and size of the rectangle are applied in the default measurement unit of the page to which the annotation is added.

Overrides:
setRect in class PdfAnnot
Parameters:
r - annotation rectangle for this annotation
See Also:
PdfAnnot.getRect()

setRect

public void setRect(PdfRect r,
                    int mu)
Description copied from class: PdfAnnot
Specifies PdfRect object as annotation rectangle for this annotation in specified measurement unit.

Overrides:
setRect in class PdfAnnot
Parameters:
r - annotation rectangle for this annotation
mu - measurement unit with which the annotation rectangle is specified
See Also:
PdfAnnot.getRect()

setRect

public void setRect(Rectangle r)
Description copied from class: PdfAnnot
Specifies Rectangle object as annotation rectangle for this annotation.

Overrides:
setRect in class PdfAnnot
Parameters:
r - annotation rectangle for this annotation
See Also:
PdfAnnot.getRect()

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