Gnostice PDFOne
Pro. Ed. v1.41


com.gnostice.pdfone
Class PdfPage

java.lang.Object
  extended bycom.gnostice.pdfone.PdfNode
      extended bycom.gnostice.pdfone.PdfStdPage
          extended bycom.gnostice.pdfone.PdfProPage
              extended bycom.gnostice.pdfone.PdfPage
All Implemented Interfaces:
Cloneable, Usable

public final class PdfPage
extends com.gnostice.pdfone.PdfProPage


Field Summary
static int COLORSPACE_CMYK
           
static int COLORSPACE_RGB
           
static int HP_LEFT
          Constant to specify horizontal alignment to the left (inside header, footer and watermarks)
static int HP_MIDDLE
          Constant to specify horizontal alignment to the middle (inside header, footer and watermarks)
static int HP_RIGHT
          Constant to specify horizontal alignment to the right (inside header, footer and watermarks)
static boolean OVERLAY
          Constant to specify z-order overlay
static boolean UNDERLAY
          Constant to specify z-order underlay
static int VP_BOTTOM
          Constant to specify vertical alignment to the bottom (inside header, footer and watermarks)
static int VP_CENTRE
          Constant to specify vertical alignment to the center (inside header, footer and watermarks)
static int VP_TOP
          Constant to specify vertical alignment to the top (inside header, footer and watermarks)
 
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_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_C, PDF_CA, PDF_CA_SMALL, PDF_CAPHEIGHT, PDF_CARETANNOT, PDF_CARRIAGE, PDF_CATALOG, PDF_CENTER_WINDOW, 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_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_DESCENT, PDF_DESTINATION, PDF_DESTS, PDF_DEVICE_CMYK, PDF_DEVICE_GRAY, PDF_DEVICE_RGB, PDF_DI, PDF_DICTEND, PDF_DICTSTART, PDF_DIRECTION, PDF_DISPLAY_DOCTITLE, PDF_DISPLAY_DURATION, PDF_DISSOLVE, PDF_DM, PDF_DOC_SUBJECT, 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_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_FONTFILE, PDF_FONTFILE_2, PDF_FontFile_3, PDF_FONTNAME, PDF_FONTNAMEPREFIX, PDF_FORM, PDF_FORMFEED, PDF_FORMFONTPREFIX, 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_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_LZWDECODE, PDF_M, PDF_MAC, PDF_MARKINFO, 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_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_SINGLE_QUOTES, PDF_SINGLEPAGE, PDF_SIZE, PDF_SP, PDF_SPIDERINFO, PDF_SPLIT, PDF_SQUAREANNOT, PDF_SS, PDF_STAMPANNOT, PDF_STARTXREF, PDF_STORE_GS, PDF_STREAM, PDF_STRUCT_TREE, 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_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_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
PdfPage()
           
PdfPage(double width, double height)
           
PdfPage(double width, double height, double pageHeaderHeight, double pageFooterHeight, double pageLeftMargin, double pageTopMargin, double pageRightMargin, double pageBottomMargin, int measurementUnit)
           
PdfPage(double width, double height, double pageLeftMargin, double pageTopMargin, double pageRightMargin, double pageBottomMargin, int measurementUnit)
           
PdfPage(double width, double height, int measurementUnit)
           
PdfPage(int pageSize)
           
PdfPage(int pageSize, double pageHeaderHeight, double pageFooterHeight, double pageLeftMargin, double pageTopMargin, double pageRightMargin, double pageBottomMargin, int measurementUnit)
           
PdfPage(int pageSize, double pageLeftMargin, double pageTopMargin, double pageRightMargin, double pageBottomMargin, int measurementUnit)
           
 
Method Summary
 void addAction(int event, int namedAction)
          Adds specified named action for specified trigger event.
 void addAction(int event, int actionType, String javascriptOrURI)
          Adds action of resolving specified Uniform Resource Identifier URI) or executing a JavaScript script for the specified event.
 void addAction(int event, int actionType, String applicationToLaunch, boolean isPrint)
          Adds action of launching specified application, or displaying or printing specified file for the specified event.
 void addAnnotation(PdfAnnot annotation)
          Adds specified annotation to this PdfPage.
 void addAnnotationList(List annotList)
           
 void addAnnotationList(List annotList, boolean removeExistingAnnots)
           
 void addFooterImage(PdfImage img, int position, boolean underlay)
          Adds PdfImage object to footer.
 void addFooterImage(String path, int position, boolean underlay)
          Adds image, specified by its pathname, to footer.
 void addFooterText(String text, PdfFont font, int position, boolean underlay)
          Adds specified text to footer.
 void addFormField(PdfFormField f)
           
 void addFormFieldList(List formFieldList)
           
 void addHeaderImage(PdfImage img, int position, boolean underlay)
          Adds PdfImage object to the header.
 void addHeaderImage(String path, int position, boolean underlay)
          Adds image, specified by its pathname, to header.
 void addHeaderText(String text, PdfFont font, int position, boolean underlay)
          Adds specified text to header.
 void addTable(PdfTable table, double x, double y)
           
 void addThumbnailImage(String path)
           
 void addWatermarkImage(PdfImage image, int position, boolean applyMargins, double angle, boolean underlay)
          Adds PdfImage object as watermark image with its exact position determined by position and applyMargins.
 void addWatermarkImage(PdfImage image, int position, double angle, boolean underlay)
          Adds PdfImage object as watermark image.
 void addWatermarkImage(String path, int position, boolean applyMargins, double angle, boolean underlay)
          Adds image, specified by its pathname, as watermark image with its exact position determined by position and applyMargins.
 void addWatermarkImage(String path, int position, double angle, boolean underlay)
          Adds image, specified by its pathname, as watermark image.
 void addWatermarkText(String text, PdfFont font, int position, boolean applyMargins, double angle, boolean underlay)
          Adds specified text as watermark with its exact position determined by position and applyMargins.
 void addWatermarkText(String text, PdfFont font, int position, double angle, boolean underlay)
          Adds specified text as watermark.
 Object clone()
           
 void deleteFormFields()
           
 void deleteFormFields(int type)
           
 void deleteFormFields(String name)
           
 void disableAllMargins()
          Disables all margins on this PdfPage.
 void drawArc(PdfRect rect, double startAngle, double sweepAngle)
          Draws an arc.
 void drawBezierCurve(double startX, double startY, double ctrlX, double ctrlY, double endX, double endY, boolean isFill, boolean isStroke)
          Draws a Bézier curve with a control point specified by (ctrlX, ctrlY).
 void drawBezierCurve(double startX, double startY, double ctrlX1, double ctrlY1, double ctrlX2, double ctrlY2, double endX, double endY, boolean isFill, boolean isStroke)
          Draws a Bézier curve with control points at (ctrlX1, ctrlY1) and (ctrlX2, ctrlY2).
 void drawBezierCurve(PdfPoint start, PdfPoint control, PdfPoint end, boolean isFill, boolean isStroke)
          Draws a Bézier curve with a single control point.
 void drawBezierCurve(PdfPoint start, PdfPoint controlPoint1, PdfPoint controlPoint2, PdfPoint end, boolean isFill, boolean isStroke)
          Draws a Bézier curve with two control points.
 void drawCircle(double x, double y, double radius, boolean isFill, boolean isStroke)
          Draws a circle with its center at position (x, y).
 void drawCircle(PdfPoint center, double radius, boolean isFill, boolean isStroke)
          Draws a circle with its center at the specified point.
 void drawEllipse(double x1, double y1, double x2, double y2, boolean isFill, boolean isStroke)
          Draws an ellipse whose bounding box has its top-left corner at (x1, y1) and its bottom-right corner at (x2, y2).
 void drawEllipse(PdfPoint p1, PdfPoint p2, boolean isFill, boolean isStroke)
          Draws an ellipse whose bounding box has its top-left corner at point1 and its bottom-right corner at point2.
 void drawImage(PdfImage img, double x, double y)
          Draws specified image at position (x, y).
 void drawImage(PdfImage img, double x, double y, double rotation)
          Draws specified image, rotated by rotation degrees, at position (x, y).
 void drawImage(PdfImage img, double x, double y, double width, double height)
          Draws specified image at position (x, y) with specified width and height.
 void drawImage(PdfImage img, double x, double y, double width, double height, double rotation)
          Draw specified image, rotated by rotation degrees, at position (x, y) with specified height and width.
 void drawImage(PdfImage img, PdfPoint p)
          Draws specified image at specified point.
 void drawImage(PdfImage img, PdfPoint p, double rotation)
          Draws specified image, rotated by rotation degrees, at point p.
 void drawImage(PdfImage img, PdfPoint p, double width, double height)
          Draws specified image at point p with specified width and height.
 void drawImage(PdfImage img, PdfPoint p, double width, double height, double rotation)
          Draws specified image, rotated by rotation degrees, at point p with specified width and height.
 void drawImage(PdfImage img, PdfRect rect)
          Draws specified image on specified rectangle.
 void drawImage(PdfImage img, PdfRect rect, double rotation)
          Draws specified image, rotated by rotation degrees, on specified rectangle.
 void drawImage(String path, double x, double y)
          Draws image, specified by its pathname, at position (x, y).
 void drawImage(String path, double x, double y, double rotation)
          Draw image, specified by its pathname and rotated by rotation degrees, at position (x, y).
 void drawImage(String path, double x, double y, double width, double height)
          Draws image, specified by its pathname, at position (x, y) with specified width and height.
 void drawImage(String path, double x, double y, double width, double height, double rotation)
          Draws image, specified by its pathname and rotated by rotation degrees, at position (x, y) with specified width and height.
 void drawImage(String path, PdfPoint p)
          Draws image, specified by its pathname, at point p.
 void drawImage(String path, PdfPoint p, double rotation)
          Draws image, specified by its pathname and rotated by rotation degrees, at point p.
 void drawImage(String path, PdfPoint p, double width, double height)
          Draws image, specified by its pathname, at point p with specified width and height.
 void drawImage(String path, PdfPoint p, double width, double height, double rotation)
          Draws image, specified by its pathname and rotated by rotation degrees, at point p with specified width and height.
 void drawImage(String path, PdfRect rect)
          Draws image, specified by its pathname, on rectangle rect.
 void drawImage(String path, PdfRect rect, double rotation)
          Draws image, specified by its pathname and rotated by rotation degrees, on rectangle rect.
 void drawLine(double startx, double starty, double endx, double endy)
          Draws a line between positions (startx, starty) and (endx, endy).
 void drawLine(PdfPoint start, PdfPoint end)
          Draws a line between points start and end.
 void drawPie(double x, double y, double width, double height, double startAngle, double sweepAngle, boolean isFill, boolean isStroke)
          Draws a pie segment.
 void drawPolygon(double[] xPoints, double[] yPoints, int nPoints, boolean isFill, boolean isStroke)
          Draws a polygon.
 void drawPolyline(double[] xPoints, double[] yPoints, int nPoints)
          Draws a polyline.
 void drawRect(double x, double y, double width, double height)
          Draws a rectangle at position (x, y) with specified width and height.
 void drawRect(double x, double y, double width, double height, boolean isFill, boolean isStroke)
          Draws a rectangle at position (x, y) with specified width, height, brush, and pen settings.
 void drawRect(PdfPoint p, double width, double height)
          Draws a rectangle at specified point with specified width and height.
 void drawRect(PdfPoint p, double width, double height, boolean isFill, boolean isStroke)
          Draws a rectangle at specified point with specified width, height, brush, and pen settings.
 void drawRect(PdfRect r)
          Draws a rectangle.
 void drawRect(Rectangle r)
           
 void drawRoundRect(double x, double y, double width, double height, double arcWidth, double arcHeight, boolean isFill, boolean isStroke)
          Draws a rectangle with rounded corners.
 void drawRoundRect(PdfRect rect, double arcWidth, double arcHeight, boolean isFill, boolean isStroke)
          Draws rectangle rect with specified rounded corners.
 void drawSquare(double x, double y, double length)
          Draws a square at position (x, y).
 void drawSquare(double x, double y, double length, boolean isFill, boolean isStroke)
          Draws a square at position (x, y) with specified fill and stroke settings.
 void drawSquare(PdfPoint p, double length)
          Draws a square at point p.
 void drawSquare(PdfPoint p, double length, boolean isFill, boolean isStroke)
          Draws a square at point p with specified fill and stroke settings.
 void enableAllMargins()
          Enables all margins on this PdfPage.
 void flattenFormFields()
           
 void flattenFormFields(boolean flattenWithNewValue)
           
 void flattenFormFields(int type)
           
 void flattenFormFields(int type, boolean flattenWithNewValue)
           
 void flattenFormFields(String name)
           
 void flattenFormFields(String name, boolean flattenWithNewValue)
           
 List getAllAnnotations()
           
 List getAllAnnotations(int type)
           
 void getAllAnnotations(int type, List listToPopulate)
           
 void getAllAnnotations(List listToPopulate)
           
 List getAllFormFields()
           
 List getAllFormFields(int type)
           
 List getAllFormFields(String name)
           
 double getBottomMargin()
          Returns size of this page's bottom margin.
 PdfBrush getBrush()
          Returns default brush used on this page.
 int getColorSpace()
           
 double getCropBottom()
          Returns difference between bottom boundaries of this page's media box and crop box.
 double getCropLeft()
          Returns difference between left boundaries of this page's media box and crop box.
 double getCropRight()
          Returns difference between right boundaries of this page's media box and crop box.
 double getCropTop()
          Returns difference between top boundaries of this page's media box and crop box.
 double getDisplayDuration()
           
 double getFooterHeight()
          Returns height of this page's footer.
 double getHeaderHeight()
          Returns height of this page's footer.
 double getHeight()
          Returns height of this page.
 double getLeftMargin()
          Returns size of this page's left margin.
 int getMeasurementUnit()
          Returns default measurement unit currently used for this PdfPage.
 PdfPen getPen()
          Returns a PdfPen object representing this page's pen.
 PdfPagePresentation getPresentation()
           
 double getRightMargin()
          Returns size of this page's right margin.
 int getRotation()
          Returns angle of rotation for contents of this page.
 PdfTextFormatter getTextFormatter()
          Retrieves PdfTextFormatter object contained by this PdfPage.
 double getTopMargin()
          Returns the size of this page's top margin.
 double getWidth()
          Returns width of this page.
 void removeThumbnailImage()
           
 void setBrushColor(Color c)
          Specifies default color for this page's brush.
 void setColorSpace(int colorspace)
           
 void setCph(PdfCustomPlaceholderHandler cph)
           
 void setDisplayDuration(double displayDuration)
           
 void setHeight(double height, int unit)
           
 void setMeasurementUnit(int mu)
          Specifies default measurement unit to be used for this PdfPage.
 void setPen(PdfPen pen)
          Sets specified PdfPen object as this page's pen.
 void setPenCapStyle(int capStyle)
          Specifies default shape of endpoints of paths in this page.
 void setPenColor(Color color)
          Specifies default color for this page's pen.
 void setPenDashGap(double gap)
          Specifies length of gaps in default dash pattern of this page's pen.
 void setPenDashLength(double length)
          Specifies length of dashes in default dash pattern of this PdfDocument's pen.
 void setPenDashPhase(double phase)
          Specifies length of phase of default dash pattern of this page's pen.
 void setPenJoinStyle(int joinStyle)
          Specifies default shape of joints of paths that connect at an angle for this pages's pen.
 void setPenMiterLimit(int limit)
          Specifies default miter limit for this page's pen.
 void setPenWidth(double width)
          Specifies default width for this page's pen.
 void setPresentation(PdfPagePresentation presentation)
           
 void setTextFormatter(PdfTextFormatter tf)
          Specifies new text formatting settings.
 void setWidth(double width, int unit)
           
 void writeText(String str)
          Writes specified text on this PdfPage.
 void writeText(String str, boolean wrap)
          Writes text str with specified wrap setting on this PdfPage.
 void writeText(String str, double x, double y)
          Writes text str at position (x, y).
 void writeText(String str, double x, double y, boolean wrap)
          Writes text str at position (x, y) with specified wrap setting.
 void writeText(String str, double x, double y, double rotation)
          Writes text str, rotated by rotation degrees, at position (x, y).
 void writeText(String str, double x, double y, int alignment)
          Writes text str at position (x, y) with specified alignment.
 void writeText(String str, double x, double y, int alignment, boolean wrap)
          Writes str at position (x, y) with specified alignment and wrap setting.
 void writeText(String str, int alignment)
          Writes str with specified alignment.
 void writeText(String str, int alignment, boolean wrap)
          Writes text str with specified alignment and wrap setting.
 void writeText(String str, PdfFont f)
          Writes specified text with specified font.
 void writeText(String str, PdfFont f, boolean wrap)
          Writes text str with specified font and wrap setting.
 void writeText(String str, PdfFont f, double x, double y)
          Writes text str at position (x, y) with specified font.
 void writeText(String str, PdfFont f, double x, double y, boolean wrap)
          Writes text str at position (x, y) with specified font and wrap setting.
 void writeText(String str, PdfFont f, double x, double y, double rotation)
          Writes text str, rotated by rotation degrees, at specified position with specified font.
 void writeText(String str, PdfFont f, int alignment)
          Writes text str with specified font and alignment.
 void writeText(String str, PdfFont f, int alignment, boolean wrap)
          Writes text str with specified font, alignment, and wrap setting.
 void writeText(String str, PdfFont f, int alignment, double x, double y)
          Writes text str at position (x, y) with specified font and alignement
 void writeText(String str, PdfFont f, int alignment, double x, double y, boolean wrap)
          Writes text str at position (x, y) with specified font, alignment, and wrap setting.
 void writeText(String str, PdfFont f, int alignment, PdfPoint p)
          Writes text str with specified font and alignment at specified point.
 void writeText(String str, PdfFont f, int alignment, PdfPoint p, boolean wrap)
          Writes text str with specified font, alignment, and wrap setting at specified point.
 void writeText(String str, PdfFont f, PdfPoint p)
          Writes text str with specified font at specified point.
 void writeText(String str, PdfFont f, PdfPoint p, boolean wrap)
          Writes text str with specified font and wrap setting at specified point.
 void writeText(String str, PdfFont f, PdfPoint p, double rotation)
          Writes text str, rotated by rotation degrees, at specified point with specified font.
 void writeText(String str, PdfFont f, PdfRect rect)
          Writes text str with specified font inside specified rectangle.
 void writeText(String str, PdfFont f, PdfRect rect, double rotation, double firstLinePosition)
          Writes text str, rotated by rotation degrees, with specified font and first-line position inside specified rectangle.
 void writeText(String str, PdfFont f, PdfRect rect, int alignment)
          Writes text str with specified font and alignment inside specified rectangle.
 void writeText(String str, PdfFont f, PdfRect rect, int alignment, double rotation, double firstLinePosition)
          Writes text str, rotated by rotation degrees, with specified font, alignment, and first-line position inside specified rectangle.
 void writeText(String str, PdfPoint p)
          Writes specified text at specified point.
 void writeText(String str, PdfPoint p, boolean wrap)
          Writes text str with specified wrap setting at specified point.
 void writeText(String str, PdfPoint p, double rotation)
          Writes text str, rotated by rotation degrees, at specified point.
 void writeText(String str, PdfPoint p, int alignment)
          Writes text str with specified alignment at specified point.
 void writeText(String str, PdfPoint p, int alignment, boolean wrap)
          Writes text str with specified alignment and wrap setting at specified point.
 void writeText(String str, PdfRect rect)
          Writes specified text inside specified rectanlge.
 void writeText(String str, PdfRect rect, double rotation, double firstLinePosition)
          Writes text str, rotated by rotation degrees, with specified first-line position inside specified rectangle.
 void writeText(String str, PdfRect rect, int alignment)
          Writes text str with specified alignment inside specified rectangle.
 void writeText(String str, PdfRect rect, int alignment, double rotation, double firstLinePosition)
          Writes text str, rotated by rotation degrees, with specified alignment and first-line position inside specified rectangle.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HP_LEFT

public static final int HP_LEFT
Constant to specify horizontal alignment to the left (inside header, footer and watermarks)

See Also:
Constant Field Values

HP_MIDDLE

public static final int HP_MIDDLE
Constant to specify horizontal alignment to the middle (inside header, footer and watermarks)

See Also:
Constant Field Values

HP_RIGHT

public static final int HP_RIGHT
Constant to specify horizontal alignment to the right (inside header, footer and watermarks)

See Also:
Constant Field Values

VP_TOP

public static final int VP_TOP
Constant to specify vertical alignment to the top (inside header, footer and watermarks)

See Also:
Constant Field Values

VP_CENTRE

public static final int VP_CENTRE
Constant to specify vertical alignment to the center (inside header, footer and watermarks)

See Also:
Constant Field Values

VP_BOTTOM

public static final int VP_BOTTOM
Constant to specify vertical alignment to the bottom (inside header, footer and watermarks)

See Also:
Constant Field Values

UNDERLAY

public static final boolean UNDERLAY
Constant to specify z-order underlay

See Also:
Constant Field Values

OVERLAY

public static final boolean OVERLAY
Constant to specify z-order overlay

See Also:
Constant Field Values

COLORSPACE_RGB

public static final int COLORSPACE_RGB
See Also:
Constant Field Values

COLORSPACE_CMYK

public static final int COLORSPACE_CMYK
See Also:
Constant Field Values
Constructor Detail

PdfPage

public PdfPage()

PdfPage

public PdfPage(int pageSize)

PdfPage

public PdfPage(double width,
               double height)

PdfPage

public PdfPage(double width,
               double height,
               int measurementUnit)

PdfPage

public PdfPage(int pageSize,
               double pageLeftMargin,
               double pageTopMargin,
               double pageRightMargin,
               double pageBottomMargin,
               int measurementUnit)

PdfPage

public PdfPage(double width,
               double height,
               double pageLeftMargin,
               double pageTopMargin,
               double pageRightMargin,
               double pageBottomMargin,
               int measurementUnit)

PdfPage

public PdfPage(int pageSize,
               double pageHeaderHeight,
               double pageFooterHeight,
               double pageLeftMargin,
               double pageTopMargin,
               double pageRightMargin,
               double pageBottomMargin,
               int measurementUnit)

PdfPage

public PdfPage(double width,
               double height,
               double pageHeaderHeight,
               double pageFooterHeight,
               double pageLeftMargin,
               double pageTopMargin,
               double pageRightMargin,
               double pageBottomMargin,
               int measurementUnit)
Method Detail

clone

public Object clone()

getDisplayDuration

public double getDisplayDuration()

setDisplayDuration

public void setDisplayDuration(double displayDuration)

getPresentation

public PdfPagePresentation getPresentation()

setPresentation

public void setPresentation(PdfPagePresentation presentation)

addTable

public void addTable(PdfTable table,
                     double x,
                     double y)
              throws PdfException,
                     IOException
Throws:
PdfException
IOException

setWidth

public void setWidth(double width,
                     int unit)

setHeight

public void setHeight(double height,
                      int unit)
               throws IOException,
                      PdfException
Throws:
IOException
PdfException

flattenFormFields

public void flattenFormFields(boolean flattenWithNewValue)
                       throws IOException,
                              PdfException
Throws:
IOException
PdfException

flattenFormFields

public void flattenFormFields(int type,
                              boolean flattenWithNewValue)
                       throws IOException,
                              PdfException
Throws:
IOException
PdfException

flattenFormFields

public void flattenFormFields(String name,
                              boolean flattenWithNewValue)
                       throws IOException,
                              PdfException
Throws:
IOException
PdfException

flattenFormFields

public void flattenFormFields()
                       throws IOException,
                              PdfException
Throws:
IOException
PdfException

flattenFormFields

public void flattenFormFields(int type)
                       throws IOException,
                              PdfException
Throws:
IOException
PdfException

flattenFormFields

public void flattenFormFields(String name)
                       throws IOException,
                              PdfException
Throws:
IOException
PdfException

deleteFormFields

public void deleteFormFields()
                      throws IOException,
                             PdfException
Throws:
IOException
PdfException

deleteFormFields

public void deleteFormFields(int type)
                      throws IOException,
                             PdfException
Throws:
IOException
PdfException

deleteFormFields

public void deleteFormFields(String name)
                      throws IOException,
                             PdfException
Throws:
IOException
PdfException

getAllAnnotations

public void getAllAnnotations(List listToPopulate)
                       throws IOException,
                              PdfException
Throws:
IOException
PdfException

getAllAnnotations

public void getAllAnnotations(int type,
                              List listToPopulate)
                       throws PdfException,
                              IOException
Throws:
PdfException
IOException

getAllAnnotations

public List getAllAnnotations(int type)
                       throws PdfException,
                              IOException
Throws:
PdfException
IOException

getAllAnnotations

public List getAllAnnotations()
                       throws PdfException,
                              IOException
Throws:
PdfException
IOException

getAllFormFields

public List getAllFormFields()
                      throws PdfException,
                             IOException
Throws:
PdfException
IOException

getAllFormFields

public List getAllFormFields(String name)
                      throws PdfException,
                             IOException
Throws:
PdfException
IOException

getAllFormFields

public List getAllFormFields(int type)
                      throws PdfException,
                             IOException
Throws:
PdfException
IOException

addAnnotation

public void addAnnotation(PdfAnnot annotation)
                   throws PdfException
Description copied from class: com.gnostice.pdfone.PdfStdPage
Adds specified annotation to this PdfPage.

Parameters:
annotation - a link or text annotation
Throws:
PdfException - if an illegal argument is supplied.

addAnnotationList

public void addAnnotationList(List annotList)
                       throws PdfException
Throws:
PdfException

addAnnotationList

public void addAnnotationList(List annotList,
                              boolean removeExistingAnnots)
                       throws PdfException
Throws:
PdfException

addFormField

public void addFormField(PdfFormField f)

addFormFieldList

public void addFormFieldList(List formFieldList)

addThumbnailImage

public void addThumbnailImage(String path)
                       throws IOException,
                              PdfException
Throws:
IOException
PdfException

removeThumbnailImage

public void removeThumbnailImage()

setMeasurementUnit

public void setMeasurementUnit(int mu)
Specifies default measurement unit to be used for this PdfPage.

Parameters:
mu - constant specifying the new default measurement unit
Since:
1.0
See Also:
PdfStdPage.getMeasurementUnit()
Sample Code
See example.

getMeasurementUnit

public int getMeasurementUnit()
Returns default measurement unit currently used for this PdfPage.

Returns:
constant identifying the current default measurement unit
Since:
1.0
See Also:
PdfStdPage.setMeasurementUnit(int)
Sample Code
See example.

setPenWidth

public void setPenWidth(double width)
Specifies default width for this page's pen.

Parameters:
width - default width for the page's pen
Since:
1.0
Sample Code
See example.

setPenColor

public void setPenColor(Color color)
Specifies default color for this page's pen.

Parameters:
color - default color for the page's pen
Since:
1.0
Sample Code
See example.

setPenDashLength

public void setPenDashLength(double length)
Specifies length of dashes in default dash pattern of this PdfDocument's pen.

Parameters:
length - length of dashes in the default dash pattern
Since:
1.0
See Also:
PdfStdPage.setPenDashGap(double), PdfStdPage.setPenDashPhase(double)
Sample Code
See example.

setPenDashGap

public void setPenDashGap(double gap)
Specifies length of gaps in default dash pattern of this page's pen.

Parameters:
gap - length of gaps in the default dash pattern
Since:
1.0
See Also:
PdfStdPage.setPenDashLength(double), PdfStdPage.setPenDashPhase(double)
Sample Code
See example.

setPenDashPhase

public void setPenDashPhase(double phase)
Specifies length of phase of default dash pattern of this page's pen.

Parameters:
phase - length of phase of the default dash pattern
Since:
1.0
See Also:
PdfStdPage.setPenDashGap(double), PdfStdPage.setPenDashLength(double)
Sample Code
See example.

setPenCapStyle

public void setPenCapStyle(int capStyle)
Specifies default shape of endpoints of paths in this page.

Parameters:
capStyle - constant specifying the default shape
Since:
1.0
See Also:
PdfPen
Sample Code
See example.

setPenJoinStyle

public void setPenJoinStyle(int joinStyle)
Specifies default shape of joints of paths that connect at an angle for this pages's pen.

Parameters:
joinStyle - constant specifying the default shape
Since:
1.0
See Also:
PdfPen, PdfStdPage.setPenCapStyle(int)
Sample Code
See example.

setPenMiterLimit

public void setPenMiterLimit(int limit)
Specifies default miter limit for this page's pen.

Parameters:
limit - default miter limit for the page's pen
Since:
1.0
Sample Code
See example.

setBrushColor

public void setBrushColor(Color c)
Specifies default color for this page's brush.

Parameters:
c - default color for the page's brush
Since:
1.0
Sample Code
See example.

getTextFormatter

public PdfTextFormatter getTextFormatter()
Retrieves PdfTextFormatter object contained by this PdfPage.

Returns:
PdfTextFormatter object contained by the PdfPage
Since:
1.0
See Also:
PdfStdPage.setTextFormatter(PdfTextFormatter)
Sample Code
See example.

setTextFormatter

public void setTextFormatter(PdfTextFormatter tf)
Specifies new text formatting settings.

Parameters:
tf - new text formatting settings
Since:
1.0
See Also:
PdfStdPage.getTextFormatter()
Sample Code
See example.

disableAllMargins

public void disableAllMargins()
Disables all margins on this PdfPage.

Since:
1.0
See Also:
PdfStdPage.enableAllMargins()
Sample Code
See example.

enableAllMargins

public void enableAllMargins()
Enables all margins on this PdfPage.

Since:
1.0
See Also:
PdfStdPage.disableAllMargins()
Sample Code
See example.

getBottomMargin

public double getBottomMargin()
Returns size of this page's bottom margin.

Returns:
(expressed in points) size of the bottom margin
Since:
1.0

getFooterHeight

public double getFooterHeight()
Returns height of this page's footer.

Returns:
(expressed in points) height of the footer
Since:
1.0

getHeaderHeight

public double getHeaderHeight()
Returns height of this page's footer.

Returns:
(expressed in points) height of the footer
Since:
1.0

getLeftMargin

public double getLeftMargin()
Returns size of this page's left margin.

Returns:
(expressed in points) size of the left margin
Since:

getRightMargin

public double getRightMargin()
Returns size of this page's right margin.

Returns:
(expressed in points) size of the right margin
Since:
1.0

getTopMargin

public double getTopMargin()
Returns the size of this page's top margin.

Returns:
(expressed in points) size of the top margin
Since:
1.0

getBrush

public PdfBrush getBrush()
Returns default brush used on this page.

Returns:
default brush of the page
Since:
1.0

getCropBottom

public double getCropBottom()
Returns difference between bottom boundaries of this page's media box and crop box.

Returns:
(expressed in points) difference between bottom boundaries of the page's media box and crop box
Since:
1.0

getCropLeft

public double getCropLeft()
Returns difference between left boundaries of this page's media box and crop box.

Returns:
(expressed in points) difference between left boundaries of this page's media box and crop box
Since:
1.0

getCropRight

public double getCropRight()
Returns difference between right boundaries of this page's media box and crop box.

Returns:
(expressed in points) difference between right boundaries of this page's media box and crop box
Since:
1.0

getCropTop

public double getCropTop()
Returns difference between top boundaries of this page's media box and crop box.

Returns:
(expressed in points) difference between top boundaries of this page's media box and crop box.
Since:
1.0

getHeight

public double getHeight()
Returns height of this page.

Returns:
(expressed in points) height of the page
Since:
1.0

getWidth

public double getWidth()
Returns width of this page.

Returns:
(expressed in points) width of the page
Since:
1.0

getPen

public PdfPen getPen()
Returns a PdfPen object representing this page's pen.

Returns:
a PdfPen object representing the page's pen.
Since:
1.0
See Also:
PdfStdPage.setPen(PdfPen)
Sample Code
See example.

setPen

public void setPen(PdfPen pen)
Sets specified PdfPen object as this page's pen.

Parameters:
pen - PdfPen object to be set as this page's pen
Since:
1.0
See Also:
PdfStdPage.getPen()
Sample Code
See example.

getRotation

public int getRotation()
Returns angle of rotation for contents of this page. The angle of rotation will be expressed in integer multiples of 90 degrees.

Returns:
(expressed in integer multiples of 90 degrees and measured in counterclockwise direction) angle of rotation for contents of the page
Since:
1.0

setCph

public void setCph(PdfCustomPlaceholderHandler cph)

setColorSpace

public void setColorSpace(int colorspace)
                   throws PdfException
Throws:
PdfException

getColorSpace

public int getColorSpace()

addAction

public void addAction(int event,
                      int actionType,
                      String javascriptOrURI)
               throws PdfException
Adds action of resolving specified Uniform Resource Identifier URI) or executing a JavaScript script for the specified event.

Parameters:
event - constant specifying trigger event for executing the action
actionType - constant specifying resolution of URI or execution of JavaScript script
javascriptOrURI - specified URI or Javascript script
Throws:
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfAction, PdfAction.PdfEvent
Sample Code
See example.

addAction

public void addAction(int event,
                      int actionType,
                      String applicationToLaunch,
                      boolean isPrint)
               throws PdfException
Adds action of launching specified application, or displaying or printing specified file for the specified event.

Parameters:
event - constant specifying the trigger event for executing the named action
actionType - constant specifying action of launching an application, or displaying or printing a file
applicationToLaunch - pathname of the application that needs to be launched or the file that needs to be displayed or printed
isPrint - whether to file needs to be printed instead of being displayed
Throws:
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfAction, PdfAction.PdfEvent
Sample Code
See example.

addAction

public void addAction(int event,
                      int namedAction)
               throws PdfException
Adds specified named action for specified trigger event.

Parameters:
event - constant specifying the trigger event for executing the named action
namedAction - constant specifying the named action that needs to be executed when the trigger event occurs
Throws:
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfAction, PdfAction.PdfEvent
Sample Code
See example.

addWatermarkText

public void addWatermarkText(String text,
                             PdfFont font,
                             int position,
                             boolean applyMargins,
                             double angle,
                             boolean underlay)
                      throws IOException,
                             PdfException
Adds specified text as watermark with its exact position determined by position and applyMargins.

The text is rotated on center of its bounding box by angle degrees in anti-clockwise direction.

Parameters:
text - text that needs to be added as the watermark
font - font with which the watermark needs to be written
position - constant specifying the combination of vertical and horizontal alignment of the text
applyMargins - whether page margins need to be considered when positioning the text
angle - (measured in anti-clockwise direction and expressed in degrees) tilt of the text with reference to center of its bounding box
underlay - whether the text needs to be placed underneath other page contents
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

addWatermarkText

public void addWatermarkText(String text,
                             PdfFont font,
                             int position,
                             double angle,
                             boolean underlay)
                      throws IOException,
                             PdfException
Adds specified text as watermark.

The text is rotated on center of its bounding box by angle degrees in anti-clockwise direction.

Parameters:
text - text that needs to be added as the watermark
font - font with which the watermark needs to be written
position - constant specifying the combination of vertical and horizontal alignment of the text
angle - (measured in anti-clockwise direction and expressed in degrees) tilt of the text with reference to center of its bounding box
underlay - whether the text needs to be placed underneath other page contents
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

addWatermarkImage

public void addWatermarkImage(PdfImage image,
                              int position,
                              boolean applyMargins,
                              double angle,
                              boolean underlay)
                       throws IOException,
                              PdfException
Adds PdfImage object as watermark image with its exact position determined by position and applyMargins.

The image is rotated on center of its bounding box by angle degrees in anti-clockwise direction.

Parameters:
image - PdfImage object that needs to be used as the watermark image
position - constant specifying the combination of vertical and horizontal alignment of the image
applyMargins - whether page margins need to be considered when positioning the image
angle - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
underlay - whether the image needs to be placed underneath other page contents
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

addWatermarkImage

public void addWatermarkImage(PdfImage image,
                              int position,
                              double angle,
                              boolean underlay)
                       throws IOException,
                              PdfException
Adds PdfImage object as watermark image.

The image is rotated on center of its bounding box by angle degrees in anti-clockwise direction.

Parameters:
image - PdfImage object that needs to be used as the watermark image
position - constant specifying the combination of vertical and horizontal alignment of the image
angle - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
underlay - whether the image needs to be placed underneath other page contents
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

addWatermarkImage

public void addWatermarkImage(String path,
                              int position,
                              boolean applyMargins,
                              double angle,
                              boolean underlay)
                       throws IOException,
                              PdfException
Adds image, specified by its pathname, as watermark image with its exact position determined by position and applyMargins.

The image is rotated on center of its bounding box by angle degrees in anti-clockwise direction.

Parameters:
path - pathname of the watermark image
position - constant specifying the combination of vertical and horizontal alignment of the image
applyMargins - whether page margins need to be considered when positioning the image
angle - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
underlay - whether the image needs to be placed underneath other page contents
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

addWatermarkImage

public void addWatermarkImage(String path,
                              int position,
                              double angle,
                              boolean underlay)
                       throws IOException,
                              PdfException
Adds image, specified by its pathname, as watermark image.

The image is rotated on center of its bounding box by angle degrees in anti-clockwise direction.

Parameters:
path - pathname of the watermark image
position - constant specifying the combination of vertical and horizontal alignment of the image
angle - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
underlay - whether the image needs to be placed underneath other page contents
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

addHeaderText

public void addHeaderText(String text,
                          PdfFont font,
                          int position,
                          boolean underlay)
                   throws IOException,
                          PdfException
Adds specified text to header.

Parameters:
text - text that needs to be added to the header
font - font with which the text needs to be written
position - constant specifying the combination of vertical and horizontal alignment of the text within the header
underlay - whether the text needs to be placed underneath other content in the header
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

addHeaderImage

public void addHeaderImage(PdfImage img,
                           int position,
                           boolean underlay)
                    throws IOException,
                           PdfException
Adds PdfImage object to the header.

Parameters:
img - PdfImage object that needs to be added to the header
position - constant specifying the combination of vertical and horizontal alignment of the image within the header
underlay - whether the image needs to be placed underneath other content in the header
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

addHeaderImage

public void addHeaderImage(String path,
                           int position,
                           boolean underlay)
                    throws IOException,
                           PdfException
Adds image, specified by its pathname, to header.

Parameters:
path - pathname of the image, which needs to be added to the header
position - constant specifying the combination of vertical and horizontal alignment of the image within the header
underlay - whether the image needs to be placed underneath other content in the header
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

addFooterText

public void addFooterText(String text,
                          PdfFont font,
                          int position,
                          boolean underlay)
                   throws IOException,
                          PdfException
Adds specified text to footer.

Parameters:
text - text that needs to be added to the footer
font - font with which the text next needs to be written
position - constant specifying the combination of vertical and horizontal alignment of the text within the footer
underlay - whether the text needs to be placed underneath other content in the footer
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

addFooterImage

public void addFooterImage(PdfImage img,
                           int position,
                           boolean underlay)
                    throws IOException,
                           PdfException
Adds PdfImage object to footer.

Parameters:
img - PdfImage object that needs to be added to the footer
position - constant specifying the combination of vertical and horizontal alignment of the image within the footer
underlay - whether the image needs to be placed underneath other content in the footer
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

addFooterImage

public void addFooterImage(String path,
                           int position,
                           boolean underlay)
                    throws IOException,
                           PdfException
Adds image, specified by its pathname, to footer.

Parameters:
path - pathname of the image, which needs to be added to the footer
position - constant specifying the combination of vertical and horizontal alignment of the image within the footer
underlay - whether the image needs to be placed underneath other content in the footer
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str)
               throws IOException,
                      PdfException
Writes specified text on this PdfPage.

Parameters:
str - text that needs to be written
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      int alignment,
                      boolean wrap)
               throws IOException,
                      PdfException
Writes text str with specified alignment and wrap setting.

Parameters:
str - text that needs to be written
alignment - constant specifying how the text needs to be aligned
wrap - constant specifying how the text needs to be aligned
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      boolean wrap)
               throws IOException,
                      PdfException
Writes text str with specified wrap setting on this PdfPage.

Parameters:
str - text that needs to be written
wrap - constant specifying whether the text needs to be wrapped
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      int alignment)
               throws IOException,
                      PdfException
Writes str with specified alignment.

Parameters:
str - text that needs to be written
alignment - constant specifying how the text needs to be aligned
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f)
               throws IOException,
                      PdfException
Writes specified text with specified font.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      int alignment,
                      boolean wrap)
               throws IOException,
                      PdfException
Writes text str with specified font, alignment, and wrap setting.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
alignment - constant specifying how the text needs to be aligned
wrap - constant specifying whether the text needs to be wrapped
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      boolean wrap)
               throws IOException,
                      PdfException
Writes text str with specified font and wrap setting.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
wrap - constant specifying whether the text needs to be wrapped
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      int alignment)
               throws IOException,
                      PdfException
Writes text str with specified font and alignment.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
alignment - constant specifying how the text needs to be aligned
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      double x,
                      double y)
               throws IOException,
                      PdfException
Writes text str at position (x, y).

Parameters:
str - text that needs to be written
x - x-coordinate of the position where the text needs to be written
y - y-coordinate of the position where the text needs to be written
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfPoint p)
               throws IOException,
                      PdfException
Writes specified text at specified point.

Parameters:
str - text that needs to be written
p - PdfPoint where the text needs to be written
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      double x,
                      double y,
                      int alignment)
               throws IOException,
                      PdfException
Writes text str at position (x, y) with specified alignment.

Parameters:
str - text that needs to be written
x - x-coordinate of the position where the text needs to be written
y - y-coordinate of the position where the text needs to be written
alignment - constant specifying how the text needs to be aligned
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfPoint p,
                      int alignment)
               throws IOException,
                      PdfException
Writes text str with specified alignment at specified point.

Parameters:
str - text that needs to be written
p - PdfPoint where the text needs to be written
alignment - constant specifying how the text needs to be aligned
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      double x,
                      double y)
               throws IOException,
                      PdfException
Writes text str at position (x, y) with specified font.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
x - x-coordinate of the position where the text needs to be written
y - y-coordinate of the position where the text needs to be written
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      PdfPoint p)
               throws IOException,
                      PdfException
Writes text str with specified font at specified point.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
p - PdfPoint where the text needs to be written
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      int alignment,
                      double x,
                      double y)
               throws IOException,
                      PdfException
Writes text str at position (x, y) with specified font and alignement

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
alignment - constant specifying how the text needs to be aligned
x - x-coordinate of the position where the text needs to be written
y - y-coordinate of the position where the text needs to be written
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      int alignment,
                      PdfPoint p)
               throws IOException,
                      PdfException
Writes text str with specified font and alignment at specified point.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
alignment - constant specifying how the text needs to be aligned
p - PdfPoint where the text needs to be written
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      double x,
                      double y,
                      boolean wrap)
               throws IOException,
                      PdfException
Writes text str at position (x, y) with specified font and wrap setting.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
x - x-coordinate of the position where the text needs to be written
y - y-coordinate of the position where the text needs to be written
wrap - constant specifying whether the text needs to be wrapped
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      PdfPoint p,
                      boolean wrap)
               throws IOException,
                      PdfException
Writes text str with specified font and wrap setting at specified point.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
p - PdfPoint where the text needs to be written
wrap - constant specifying whether the text needs to be wrapped
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      int alignment,
                      double x,
                      double y,
                      boolean wrap)
               throws IOException,
                      PdfException
Writes text str at position (x, y) with specified font, alignment, and wrap setting.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
alignment - constant specifying how the text needs to be aligned
x - x-coordinate of the position where the text needs to be written
y - y-coordinate of the position where the text needs to be written
wrap - constant specifying whether the text needs to be wrapped
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      int alignment,
                      PdfPoint p,
                      boolean wrap)
               throws IOException,
                      PdfException
Writes text str with specified font, alignment, and wrap setting at specified point.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
alignment - constant specifying how the text needs to be aligned
p - PdfPoint where the text needs to be written
wrap - constant specifying whether the text needs to be wrapped
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      double x,
                      double y,
                      boolean wrap)
               throws IOException,
                      PdfException
Writes text str at position (x, y) with specified wrap setting.

Parameters:
str - text that needs to be written
x - x-coordinate of the position where the text needs to be written
y - y-coordinate of the position where the text needs to be written
wrap - constant specifying how the text needs to be aligned
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfPoint p,
                      boolean wrap)
               throws IOException,
                      PdfException
Writes text str with specified wrap setting at specified point.

Parameters:
str - text that needs to be written
p - PdfPoint where the text needs to be written
wrap - constant specifying whether the text needs to be wrapped
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      double x,
                      double y,
                      int alignment,
                      boolean wrap)
               throws IOException,
                      PdfException
Writes str at position (x, y) with specified alignment and wrap setting.

Parameters:
str - text that needs to be written
x - x-coordinate of the position where the text needs to be written
y - y-coordinate of the position where the text needs to be written
alignment - constant specifying how the text needs to be aligned
wrap - constant specifying whether the text needs to be wrapped
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfPoint p,
                      int alignment,
                      boolean wrap)
               throws IOException,
                      PdfException
Writes text str with specified alignment and wrap setting at specified point.

Parameters:
str - text that needs to be written
p - PdfPoint where the text needs to be written
alignment - constant specifying how the text needs to be aligned
wrap - constant specifying whether the text needs to be wrapped
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfPoint p,
                      double rotation)
               throws IOException,
                      PdfException
Writes text str, rotated by rotation degrees, at specified point.

The text is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

This method is recommended only for writing rotated single-line text. For writing rotated multi-line text, the PdfStdPage.writeText(String, PdfRect, double, double) method is preferred.

Parameters:
str - text that needs to be written
p - PdfPoint where the text needs to be written
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the text with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      double x,
                      double y,
                      double rotation)
               throws IOException,
                      PdfException
Writes text str, rotated by rotation degrees, at position (x, y).

The text is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
str - text that needs to be written
x - x-coordinate of the position where the text needs to be written
y - y-coordinate of the position where the text needs to be written
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the text with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      PdfPoint p,
                      double rotation)
               throws IOException,
                      PdfException
Writes text str, rotated by rotation degrees, at specified point with specified font.

The text is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

This method is recommended only for writing rotated single-line text. For writing rotated multi-line text, the PdfStdPage.writeText(String, PdfFont, PdfRect, double, double) method is preferred over this.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
p - PdfPoint where the text needs to be written
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the text with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      double x,
                      double y,
                      double rotation)
               throws IOException,
                      PdfException
Writes text str, rotated by rotation degrees, at specified position with specified font.

The text is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
x - x-coordinate of the position where the text needs to be written
y - y-coordinate of the position where the text needs to be written
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the text with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfRect rect)
               throws IOException,
                      PdfException
Writes specified text inside specified rectanlge.

Parameters:
str - text that needs to be written
rect - rectangle inside which the text needs to be written
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfRect rect,
                      double rotation,
                      double firstLinePosition)
               throws IOException,
                      PdfException
Writes text str, rotated by rotation degrees, with specified first-line position inside specified rectangle.

The text is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
str - text that needs to be written
rect - rectangle inside which the text needs to be written
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the text with reference to center of its bounding box
firstLinePosition - position inside the rectangle where the first line of text should begin
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfRect rect,
                      int alignment)
               throws IOException,
                      PdfException
Writes text str with specified alignment inside specified rectangle.

Parameters:
str - text that needs to be written
rect - rectangle inside which the text needs to be written
alignment - constant specifying how the text needs to be aligned inside the rectangle
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfRect rect,
                      int alignment,
                      double rotation,
                      double firstLinePosition)
               throws IOException,
                      PdfException
Writes text str, rotated by rotation degrees, with specified alignment and first-line position inside specified rectangle.

The text is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
str - text that needs to be written
rect - rectangle inside which the text needs to be written
alignment - constant specifying how the text needs to be aligned inside the rectangle
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the text with reference to center of its bounding box
firstLinePosition - position inside the rectangle where the first line of text should begin
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      PdfRect rect)
               throws IOException,
                      PdfException
Writes text str with specified font inside specified rectangle.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
rect - rectangle inside which the text needs to be written
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      PdfRect rect,
                      double rotation,
                      double firstLinePosition)
               throws IOException,
                      PdfException
Writes text str, rotated by rotation degrees, with specified font and first-line position inside specified rectangle.

The text is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
rect - rectangle inside which the text needs to be written
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the text with reference to center of its bounding box
firstLinePosition - position inside the rectangle where the first line of text should begin
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      PdfRect rect,
                      int alignment)
               throws IOException,
                      PdfException
Writes text str with specified font and alignment inside specified rectangle.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
rect - rectangle inside which the text needs to be written
alignment - constant specifying how the text needs to be aligned inside the rectangle
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
See Also:
PdfTextFormatter
Sample Code
See example.

writeText

public void writeText(String str,
                      PdfFont f,
                      PdfRect rect,
                      int alignment,
                      double rotation,
                      double firstLinePosition)
               throws IOException,
                      PdfException
Writes text str, rotated by rotation degrees, with specified font, alignment, and first-line position inside specified rectangle.

The text is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
str - text that needs to be written
f - font with which the text needs to be written
rect - rectangle inside which the text needs to be written
alignment - constant specifying how the text needs to be aligned inside the rectangle
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the text with reference to center of its bounding box
firstLinePosition - position inside the rectangle where the first line of text should begin
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(String path,
                      double x,
                      double y)
               throws IOException,
                      PdfException
Draws image, specified by its pathname, at position (x, y).

Parameters:
path - pathname of the image file
x - x-coordinate of the position where the image needs to be drawn
y - y-coordinate of the position where the image needs to be drawn
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(String path,
                      double x,
                      double y,
                      double width,
                      double height)
               throws IOException,
                      PdfException
Draws image, specified by its pathname, at position (x, y) with specified width and height.

Parameters:
path - pathname of the image file
x - x-coordinate of the position where the image needs to be drawn
y - y-coordinate of the position where the image needs to be drawn
width - width of the image
height - height of the image
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(String path,
                      PdfPoint p)
               throws IOException,
                      PdfException
Draws image, specified by its pathname, at point p.

Parameters:
path - pathname of the image file
p - point where the image needs to be drawn
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(String path,
                      PdfPoint p,
                      double width,
                      double height)
               throws IOException,
                      PdfException
Draws image, specified by its pathname, at point p with specified width and height.

Parameters:
path - pathname of the image file
p - point where the image needs to be drawn
width - width of the image
height - height of the image
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(String path,
                      PdfRect rect)
               throws IOException,
                      PdfException
Draws image, specified by its pathname, on rectangle rect.

Parameters:
path - pathname of the image file
rect - rectangle on which the image needs to be drawn
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(PdfImage img,
                      double x,
                      double y)
               throws IOException,
                      PdfException
Draws specified image at position (x, y).

Parameters:
img - image that needs to be drawn
x - x-coordinate of the position where the image needs to be drawn
y - y-coordinate of the position where the image needs to be drawn
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(PdfImage img,
                      double x,
                      double y,
                      double width,
                      double height)
               throws IOException,
                      PdfException
Draws specified image at position (x, y) with specified width and height.

Parameters:
img - image that needs to be drawn
x - x-coordinate of the position where the image needs to be drawn
y - y-coordinate of the position where the image needs to be drawn
width - width of the image
height - height of the image
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(PdfImage img,
                      PdfPoint p)
               throws IOException,
                      PdfException
Draws specified image at specified point.

Parameters:
img - image that needs to be drawn
p - point where the image needs to be drawn
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(PdfImage img,
                      PdfPoint p,
                      double width,
                      double height)
               throws IOException,
                      PdfException
Draws specified image at point p with specified width and height.

Parameters:
img - image that needs to be drawn
p - point where the image needs to be drawn
width - width of the image
height - height of the image
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(PdfImage img,
                      PdfRect rect)
               throws IOException,
                      PdfException
Draws specified image on specified rectangle.

Parameters:
img - image that needs to be drawn
rect - rectangle on which the image needs to be drawn
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(String path,
                      double x,
                      double y,
                      double rotation)
               throws IOException,
                      PdfException
Draw image, specified by its pathname and rotated by rotation degrees, at position (x, y).

The image is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
path - pathname of the image file
x - x-coordinate of the position where the image needs to be drawn
y - y-coordinate of the position where the image needs to be drawn
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(String path,
                      double x,
                      double y,
                      double width,
                      double height,
                      double rotation)
               throws IOException,
                      PdfException
Draws image, specified by its pathname and rotated by rotation degrees, at position (x, y) with specified width and height.

The image is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
path - pathname of the image file
x - x-coordinate of the position where the image needs to be drawn
y - y-coordinate of the position where the image needs to be drawn
width - width of the image
height - height of the image
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(String path,
                      PdfPoint p,
                      double rotation)
               throws IOException,
                      PdfException
Draws image, specified by its pathname and rotated by rotation degrees, at point p.

The image is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
path - pathname of the image file
p - point where the image needs to be drawn
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(String path,
                      PdfPoint p,
                      double width,
                      double height,
                      double rotation)
               throws IOException,
                      PdfException
Draws image, specified by its pathname and rotated by rotation degrees, at point p with specified width and height.

The image is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
path - pathname of the image file
p - point where the image needs to be drawn
width - width of the image
height - height of the image
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(String path,
                      PdfRect rect,
                      double rotation)
               throws IOException,
                      PdfException
Draws image, specified by its pathname and rotated by rotation degrees, on rectangle rect.

The image is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
path - pathname of the image file
rect - rectangle on which the image needs to be drawn
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(PdfImage img,
                      double x,
                      double y,
                      double rotation)
               throws IOException,
                      PdfException
Draws specified image, rotated by rotation degrees, at position (x, y).

The image is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
img - image that needs to be drawn
x - x-coordinate of the position where the image needs to be drawn
y - y-coordinate of the position where the image needs to be drawn
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(PdfImage img,
                      double x,
                      double y,
                      double width,
                      double height,
                      double rotation)
               throws IOException,
                      PdfException
Draw specified image, rotated by rotation degrees, at position (x, y) with specified height and width.

The image is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
img - image that needs to be drawn
x - x-coordinate of the position where the image needs to be drawn
y - y-coordinate of the position where the image needs to be drawn
width - width of the image
height - height of the image
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(PdfImage img,
                      PdfPoint p,
                      double rotation)
               throws IOException,
                      PdfException
Draws specified image, rotated by rotation degrees, at point p.

The image is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
img - image that needs to be drawn
p - point where the image needs to be drawn
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(PdfImage img,
                      PdfPoint p,
                      double width,
                      double height,
                      double rotation)
               throws IOException,
                      PdfException
Draws specified image, rotated by rotation degrees, at point p with specified width and height.

The image is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
img - image that needs to be drawn
p - point where the image needs to be drawn
width - width of the image
height - height of the image
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawImage

public void drawImage(PdfImage img,
                      PdfRect rect,
                      double rotation)
               throws IOException,
                      PdfException
Draws specified image, rotated by rotation degrees, on specified rectangle.

The image is rotated on center of its bounding box by rotation degrees in anti-clockwise direction.

Parameters:
img - image that needs to be drawn
rect - rectangle on which the image needs to be drawn
rotation - (measured in anti-clockwise direction and expressed in degrees) tilt of the image with reference to center of its bounding box
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawLine

public void drawLine(double startx,
                     double starty,
                     double endx,
                     double endy)
              throws IOException
Draws a line between positions (startx, starty) and (endx, endy).

Parameters:
startx - x-coordinate of the starting position of the line
starty - y-coordinate of the starting position of the line
endx - x-coordinate of the ending position of the line
endy - y-coordinate of the ending position of the line
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawLine

public void drawLine(PdfPoint start,
                     PdfPoint end)
              throws IOException
Draws a line between points start and end.

Parameters:
start - starting point of the line
end - ending point of the line
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawRect

public void drawRect(PdfPoint p,
                     double width,
                     double height,
                     boolean isFill,
                     boolean isStroke)
              throws IOException
Draws a rectangle at specified point with specified width, height, brush, and pen settings.

Parameters:
p - position of the top-left corner of the rectangle
width - width of the rectangle
height - height of the rectangle
isFill - whether the rectangle needs to be filled
isStroke - whether the rectangle needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawRect

public void drawRect(double x,
                     double y,
                     double width,
                     double height,
                     boolean isFill,
                     boolean isStroke)
              throws IOException
Draws a rectangle at position (x, y) with specified width, height, brush, and pen settings.

Parameters:
x - x-coordinate of top-left corner of the rectangle
y - y-coordinate of top-left corner of the rectangle
width - width of the rectangle
height - height of the rectangle
isFill - whether the rectangle needs to be filled
isStroke - whether the rectangle needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawRect

public void drawRect(Rectangle r)
              throws IOException
Throws:
IOException

drawRect

public void drawRect(PdfRect r)
              throws IOException
Draws a rectangle.

Parameters:
r - rectangle that needs to be drawn
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawRect

public void drawRect(double x,
                     double y,
                     double width,
                     double height)
              throws IOException
Draws a rectangle at position (x, y) with specified width and height.

Parameters:
x - x-coordinate of top-left corner of the rectangle
y - y-coordinate of top-left corner of the rectangle
width - width of the rectangle
height - height of the rectangle
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawRect

public void drawRect(PdfPoint p,
                     double width,
                     double height)
              throws IOException
Draws a rectangle at specified point with specified width and height.

Parameters:
p - position of the top-left corner of the rectangle
width - width of the rectangle
height - height of the rectangle
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawSquare

public void drawSquare(double x,
                       double y,
                       double length,
                       boolean isFill,
                       boolean isStroke)
                throws IOException
Draws a square at position (x, y) with specified fill and stroke settings.

Parameters:
x - x-coordinate of the top-left corner of the square
y - y-coordinate of the top-left corner of the square
length - length of a side of the square
isFill - whether the square needs to be filled
isStroke - whether the square needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawSquare

public void drawSquare(double x,
                       double y,
                       double length)
                throws IOException
Draws a square at position (x, y).

Parameters:
x - x-coordinate of the top-left corner of the square
y - y-coordinate of the top-left corner of the square
length - length of a side of the square
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawSquare

public void drawSquare(PdfPoint p,
                       double length,
                       boolean isFill,
                       boolean isStroke)
                throws IOException
Draws a square at point p with specified fill and stroke settings.

Parameters:
p - position of top-left corner of the rectangle
length - length of a side of the square
isFill - whether the square needs to be filled
isStroke - whether the square needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawSquare

public void drawSquare(PdfPoint p,
                       double length)
                throws IOException
Draws a square at point p.

Parameters:
p - position of top-left corner of the rectangle
length - length of a side of the square
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawBezierCurve

public void drawBezierCurve(PdfPoint start,
                            PdfPoint controlPoint1,
                            PdfPoint controlPoint2,
                            PdfPoint end,
                            boolean isFill,
                            boolean isStroke)
                     throws IOException
Draws a Bézier curve with two control points.

Parameters:
start - starting point of the curve
controlPoint1 - first control point of the curve
controlPoint2 - second control point of the curve
end - end point of the curve
isFill - whether the curve needs to be filled
isStroke - whether the curve needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawBezierCurve

public void drawBezierCurve(double startX,
                            double startY,
                            double ctrlX1,
                            double ctrlY1,
                            double ctrlX2,
                            double ctrlY2,
                            double endX,
                            double endY,
                            boolean isFill,
                            boolean isStroke)
                     throws IOException
Draws a Bézier curve with control points at (ctrlX1, ctrlY1) and (ctrlX2, ctrlY2).

Parameters:
startX - x-coordinate of starting point of the curve
startY - y-coordinate of starting point of the curve
ctrlX1 - x-coordinate of first control point of the curve
ctrlY1 - y-coordinate of first control point of the curve
ctrlX2 - x-coordinate of second control point of the curve
ctrlY2 - y-coordinate of second control point of the curve
endX - x-coordinate of end point of the curve
endY - y-coordinate of end point of the curve
isFill - whether the curve needs to be filled
isStroke - whether the curve needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawBezierCurve

public void drawBezierCurve(PdfPoint start,
                            PdfPoint control,
                            PdfPoint end,
                            boolean isFill,
                            boolean isStroke)
                     throws IOException
Draws a Bézier curve with a single control point.

Parameters:
start - starting point of the curve
control - control point of the curve
end - end point of the curve
isFill - whether the curve needs to be filled
isStroke - whether the curve needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawBezierCurve

public void drawBezierCurve(double startX,
                            double startY,
                            double ctrlX,
                            double ctrlY,
                            double endX,
                            double endY,
                            boolean isFill,
                            boolean isStroke)
                     throws IOException
Draws a Bézier curve with a control point specified by (ctrlX, ctrlY).

Parameters:
startX - x-coordinate of starting point of the curve
startY - y-coordinate of starting point of the curve
ctrlX - x-coordinate of control point of the curve
ctrlY - y-coordinate of control point of the curve
endX - x-coordinate of end point of the curve
endY - y-coordinate of end point of the curve
isFill - whether the curve needs to be filled
isStroke - whether the curve needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawEllipse

public void drawEllipse(double x1,
                        double y1,
                        double x2,
                        double y2,
                        boolean isFill,
                        boolean isStroke)
                 throws IOException
Draws an ellipse whose bounding box has its top-left corner at (x1, y1) and its bottom-right corner at (x2, y2).

Parameters:
x1 - x-coordinate of the top-left corner of the ellipse's bounding box
y1 - y-coordinate of the top-left corner of the ellipse's bounding box
x2 - x-coordinate of the bottom-right corner of the ellipse's bounding box
y2 - y-coordinate of the bottom-right corner of the ellipse's bounding box
isFill - whether the ellipse needs to be filled
isStroke - whether the ellipse needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawEllipse

public void drawEllipse(PdfPoint p1,
                        PdfPoint p2,
                        boolean isFill,
                        boolean isStroke)
                 throws IOException
Draws an ellipse whose bounding box has its top-left corner at point1 and its bottom-right corner at point2.

Parameters:
p1 - top-left corner of the ellipse's bounding box
p2 - bottom-right corner of the ellipse's bounding box
isFill - whether the ellipse needs to be filled
isStroke - whether the ellipse needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawCircle

public void drawCircle(double x,
                       double y,
                       double radius,
                       boolean isFill,
                       boolean isStroke)
                throws IOException
Draws a circle with its center at position (x, y).

Parameters:
x - x-coordinate of the center of the circle
y - y-coordinate of the center of the circle
radius - radius of the circle
isFill - whether the circle needs to be filled
isStroke - whether the circle needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawCircle

public void drawCircle(PdfPoint center,
                       double radius,
                       boolean isFill,
                       boolean isStroke)
                throws IOException
Draws a circle with its center at the specified point.

Parameters:
center - position of the center of the circle
radius - radius of the circle
isFill - whether the circle needs to be filled
isStroke - whether the circle needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawPolyline

public void drawPolyline(double[] xPoints,
                         double[] yPoints,
                         int nPoints)
                  throws IOException,
                         PdfException
Draws a polyline.

Parameters:
xPoints - array containing x-coordinates of the kinks in the polyline
yPoints - array containing y-coordinates of the kinks in the polyline
nPoints - number of kinks in the polyline
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawPolygon

public void drawPolygon(double[] xPoints,
                        double[] yPoints,
                        int nPoints,
                        boolean isFill,
                        boolean isStroke)
                 throws IOException,
                        PdfException
Draws a polygon.

Parameters:
xPoints - array containing x-coordinates of the corners of the polygon
yPoints - array containing y-coordinates of the corners of the polygon
nPoints - number of sides of the polygon
isFill - whether the polygon needs to be filled
isStroke - whether the polygon needs to be stroked
Throws:
IOException - if an I/O error occurs.
PdfException - if an illegal argument is supplied.
Since:
1.0
Sample Code
See example.

drawArc

public void drawArc(PdfRect rect,
                    double startAngle,
                    double sweepAngle)
             throws IOException
Draws an arc. Rectangle rect specifies bounding box of an imaginary circle, which completes the arc. The arc begins at startAngle degrees and spans for sweepAngle degrees. startAngle is measured in anti-clockwise direction.

Parameters:
rect - bounding box of the imaginary circle that completes the arc
startAngle - (measured in anti-clockwise direction and expressed in degrees) angle from which the arc needs to begin
sweepAngle - (expressed in degrees) angle for which the arc needs to span
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawPie

public void drawPie(double x,
                    double y,
                    double width,
                    double height,
                    double startAngle,
                    double sweepAngle,
                    boolean isFill,
                    boolean isStroke)
             throws IOException
Draws a pie segment. The position (x, y) represents the top-left corner of the bounding box of an imaginary ellipse, which the pie segment can neatly fit into.

Parameters:
x - x-coordinate of top-left corner of the bounding box of the imaginary ellipse that contains the pie segment
y - x-coordinate of top-left corner of the bounding box of the imaginary ellipse that contains the pie segment
width - width of the bounding box of the imaginary ellipse that contains the pie segment
height - height of the bounding box of the imaginary ellipse that contains the pie segment
startAngle - (measured in anti-clockwise direction and expressed in degrees) angle from which the pie segment needs to start
sweepAngle - (expressed in degrees) angle for which the pie segment needs to span
isFill - whether the pie segment needs to be filled
isStroke - whether the pie segment needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawRoundRect

public void drawRoundRect(PdfRect rect,
                          double arcWidth,
                          double arcHeight,
                          boolean isFill,
                          boolean isStroke)
                   throws IOException
Draws rectangle rect with specified rounded corners.

Parameters:
rect - rectangle that needs to be drawn
arcWidth - width of the rounded corners
arcHeight - height of the rounded corners
isFill - whether the rectangle needs to be filled
isStroke - whether the rectangle needs to be stroked
Throws:
IOException - if an I/O error occurs.
Since:
1.0
Sample Code
See example.

drawRoundRect

public void drawRoundRect(double x,
                          double y,
                          double width,
                          double height,
                          double arcWidth,
                          double arcHeight,
                          boolean isFill,
                          boolean isStroke)
                   throws IOException
Draws a rectangle with rounded corners. The corners of the rectangle are actually arcs whose dimensions are specified by arcWidth and arcHeight. The dimensions of the whole rectangle are specified by width and height.

Parameters:
x - x-coordinate of top-left corner of the rectangle
y - y-coordinate of top-left corner of the rectangle
width - width of the rectangle
height - height of the rectangle
arcWidth - width of the rounded corners
arcHeight - height of the rounded corners
isFill - whether the rectangle needs to be filled
isStroke - whether the rectangle needs to be stroked
Throws:
IOException
Since:
1.0
Sample Code
See example.

Gnostice PDFOne
Pro. Ed. v1.41

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