Gnostice PDFOne
Pro. Ed. v5.0.0


com.gnostice.pdfone
Class PdfFormPushButton

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

public class PdfFormPushButton
extends com.gnostice.pdfone.PdfFormButtonField

This class represents a push button that can be used to submit or reset a form. It can also be used to updated calculated fields.

A push button can have an icon and a caption, but does not hold any value.


Field Summary
static int CAPTION_ABOVE
          Constant specifying a push button having its caption above its icon.
static int CAPTION_BELOW
          Constant specifying a push button having its caption below its icon.
static int CAPTION_LEFTSIDE
          Constant specifying a push button having its caption on the left side of its icon.
static int CAPTION_OFF
          Constant specifying a push button having an icon but no caption.
static int CAPTION_ON
          Constant specifying a push button having a caption but no icon.
static int CAPTION_OVERLAID
          Constant specifying a push button having its caption right over the icon.
static int CAPTION_RIGHTSIDE
          Constant specifying a push button having its caption on the right side of its icon.
static int SCALE_ALWAYS
          Constant specifying that the viewer application should always scale the icon within the bounding box of the push button.
static int SCALE_NEVER
          Constant specifying that the viewer application should never scale the icon within the bounding box of the push button.
static int SCALE_TYPE_ANAMORPHIC
          Constant for specifying scaling the icon within the bounding box of a push button without maintaining the aspect ratio (width-height ratio).
static int SCALE_TYPE_PROPORTIONAL
          Constant for specifying scaling the icon within the bounding box of a push button while maintaining the aspect ratio (width-height ratio).
static int SCALE_WHEN_ICON_IS_BIGGER
          Constant specifying that the viewer application should scale the icon within the bounding box of the push button when the icon is bigger than the bounding box.
static int SCALE_WHEN_ICON_IS_SMALLER
          Constant specifying that the viewer application should scale the icon within the bounding box of the push button when the icon is smaller than the bounding box.
 
Fields inherited from class com.gnostice.pdfone.PdfFormField
ALIGNMENT_CENTER, ALIGNMENT_LEFT, ALIGNMENT_RIGHT, BUTTON_STATE_OFF, BUTTON_STATE_ON, FLAG_CHOICE_COMMIT_ON_SEL_CHANGE, FLAG_CHOICE_MULTISELECT, FLAG_NO_EXPORT, FLAG_NO_SPELLCHECK, FLAG_NONE, FLAG_RADIO_IN_UNISON, FLAG_RADIO_NO_TOGGLE_TO_OFF, FLAG_READONLY, FLAG_REQUIRED, FLAG_SUBMIT_TYPE_FDF, HIGHLIGHT_MODE_INVERT, HIGHLIGHT_MODE_NONE, HIGHLIGHT_MODE_OUTLINE, HIGHLIGHT_MODE_PUSH, HIGHLIGHT_MODE_TOGGLE, ROTATION_0, ROTATION_180, ROTATION_270, ROTATION_90, SUBMIT_ACTION_TYPE_FDF, SUBMIT_ACTION_TYPE_HTML_POST, SUBMIT_ACTION_TYPE_XFDF, TYPE_CHECKGROUP, TYPE_COMBOBOX, TYPE_LISTBOX, TYPE_PUSHBUTTON, TYPE_RADIOGROUP, TYPE_SIGNATURE, TYPE_TEXTFIELD
 
Fields inherited from class com.gnostice.pdfone.PdfAnnot
ANNOT_TYPE_CARET, ANNOT_TYPE_CIRCLE, ANNOT_TYPE_FILE_ATTACHMENT, ANNOT_TYPE_FREE_TEXT, ANNOT_TYPE_INK, ANNOT_TYPE_LINE, ANNOT_TYPE_LINK, ANNOT_TYPE_MARKUP, ANNOT_TYPE_POLYGON, ANNOT_TYPE_POLYLINE, ANNOT_TYPE_POPUP, ANNOT_TYPE_SQUARE, ANNOT_TYPE_STAMP, ANNOT_TYPE_TEXT, ANNOT_TYPE_WATERMARK, BORDERSTYLE_BEVELED, BORDERSTYLE_DASHED, BORDERSTYLE_INSET, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAG_HIDDEN, FLAG_INVISIBLE, FLAG_LOCKED, FLAG_NO_ROTATE, FLAG_NO_VIEW, FLAG_NO_ZOOM, FLAG_PRINT, FLAG_TOGGLE_NO_VIEW
 
Fields inherited from interface com.gnostice.pdfone.Usable
INCHES_TO_POINTS, MM_TO_INCHES, MM_TO_POINTS, PDF_A, PDF_AA, PDF_AC, PDF_ACROFORM, PDF_ACTION, PDF_ALTERNATEPRESENTATIONS, PDF_ANNOT, PDF_ANNOT_DEFAULT_TITLE, PDF_ANNOT_NAME, PDF_ANNOT_SUBJECT, PDF_ANNOTS, PDF_AP, PDF_ARRAYEND, PDF_ARRAYSTART, PDF_ARTBOX, PDF_AS, PDF_ASCENT, PDF_ASCII85, PDF_ASCII85_NEW, PDF_ASCIIHEX, PDF_ASCIIHEX_NEW, PDF_AuthEvent, PDF_AUTHOR, PDF_AVGWIDTH, PDF_B, PDF_BASEFONT, PDF_BBOX, PDF_BC, PDF_BE, PDF_BEFOREFORMAT, PDF_BEGINTEXT, PDF_BG, PDF_BINARYDATA, PDF_BITS_PER_COMPONENT, PDF_BL, PDF_BLEEDBOX, PDF_BLINDS, PDF_BMC, PDF_BORDER, PDF_BOX, PDF_BS, PDF_BTN, PDF_BYTERANGE, PDF_C, PDF_CA, PDF_CA_SMALL, PDF_CAPHEIGHT, PDF_CARETANNOT, PDF_CARRIAGE, PDF_CATALOG, PDF_CENTER_WINDOW, PDF_CF, PDF_CFM, PDF_CH, PDF_CID_TO_GID_MAP, PDF_CIDFONT_TYPE1, PDF_CIDFONT_TYPE2, PDF_CIDSYSTEM_INFO, PDF_CIRCLEANNOT, PDF_CL, PDF_CM, PDF_COLOMNS, PDF_COLOR, PDF_COLORSPACE, PDF_COLORSPACE_CALGRAY, PDF_COLORSPACE_CALRGB, PDF_COLORSPACE_DEVICEN, PDF_COLORSPACE_ICCBASED, PDF_COLORSPACE_LAB, PDF_COLORSPACE_SEPARATION, PDF_CONTACTINFO, PDF_CONTENTS, PDF_COUNT, PDF_COVER, PDF_CREATIONDATE, PDF_CREATOR, PDF_CROPBOX, PDF_CS, PDF_CSP, PDF_D, PDF_DA, PDF_DATE, PDF_DATE_FORMAT, PDF_DCTDECODE, PDF_DCTDECODE_NEW, PDF_DECODEPARMS, PDF_DESC, PDF_DESCENDANT, PDF_DESCENDANT_FONTS, PDF_DESCENDENTFONTS, PDF_DESCENT, PDF_DESTINATION, PDF_DESTS, PDF_DEVICE_CMYK, PDF_DEVICE_GRAY, PDF_DEVICE_RGB, PDF_DI, PDF_DICTEND, PDF_DICTSTART, PDF_DIFFERENCES, PDF_DIRECTION, PDF_DISPLAY_DOCTITLE, PDF_DISPLAY_DURATION, PDF_DISSOLVE, PDF_DM, PDF_DOC_SUBJECT, PDF_DOCMDP, PDF_DOS, PDF_DP, PDF_DR, PDF_DS, PDF_DV, PDF_DW, PDF_E, PDF_EF, PDF_EMBEDDEDFILE, PDF_EMBEDDEDFILES, PDF_EMC, PDF_ENCODING, PDF_ENCRYPT, PDF_ENCRYPTMETADATA, PDF_ENDOBJ, PDF_ENDPATH, PDF_ENDSTREAM, PDF_ENDTEXT, PDF_EOCLIP, PDF_EOF, PDF_EXTGSTATE, PDF_F, PDF_FADE, PDF_FALSE, PDF_FDESCRIPTOR, PDF_FIELD_FLAG, PDF_FIELDS, PDF_FILEATTACHMENTANNOT, PDF_FILESPEC, PDF_FILTER, PDF_FIRST, PDF_FIRST_PAGE, PDF_FIRSTCHAR, PDF_FIT, PDF_FIT_WINDOW, PDF_FITB, PDF_FITBH, PDF_FITBV, PDF_FITH, PDF_FITR, PDF_FITV, PDF_FIXEDPRINT, PDF_FLAGS, PDF_FLATE, PDF_FLATE_NEW, PDF_FLY, PDF_FO, PDF_FONT, PDF_FONTBBOX, PDF_FONTDESCRIPTOR, PDF_FONTFILE, PDF_FONTFILE_2, PDF_FontFile_3, PDF_FONTFILE2, PDF_FONTNAME, PDF_FONTNAMEPREFIX, PDF_FORM, PDF_FORMFEED, PDF_FORMFONTPREFIX, PDF_FREE_TEXT_CALLOUT, PDF_FREE_TEXT_TYPEWRITER, PDF_FREETEXTANNOT, PDF_FS, PDF_FT, PDF_FULLSCREEN, PDF_GLITTER, PDF_GOTO_ACTION, PDF_GROUP, PDF_GS, PDF_H, PDF_HEADER, PDF_HEIGHT, PDF_HEXSTRINGEND, PDF_HEXSTRINGSTART, PDF_HIDE_MENUBAR, PDF_HIDE_TOOLBAR, PDF_HIDE_WINDOWUI, PDF_HIGHLIGHT, PDF_HORIZ_STEM, PDF_HORIZONTAL, PDF_I, PDF_IC, PDF_ID, PDF_IDS, PDF_IF, PDF_IMAGE, PDF_IMAGEB, PDF_IMAGEC, PDF_IMAGEI, PDF_IMPORTDATA, PDF_INDEX, PDF_INDEXED, PDF_INFO, PDF_INK, PDF_INKLIST, PDF_INWARD, PDF_IT, PDF_ITALANGLE, PDF_IX, PDF_JAVASCRIPT, PDF_JAVASCRIPT_ACTION, PDF_JS, PDF_KEYSTROKE, PDF_KEYWORDS, PDF_KIDS, PDF_L, PDF_L2R, PDF_LANG, PDF_LAST, PDF_LAST_PAGE, PDF_LASTCHAR, PDF_LAUNCH_ACTION, PDF_LE, PDF_LEGAL, PDF_LENGTH, PDF_LENGTH_1, PDF_LENGTH_2, PDF_LENGTH_3, PDF_LF, PDF_LINEANNOT, PDF_LINKANNOT, PDF_LITERALSTRINGEND, PDF_LITERALSTRINGSTART, PDF_LOCATION, PDF_LZWDECODE, PDF_M, PDF_MAC, PDF_MARKINFO, PDF_MATRIX, PDF_MAXLEN, PDF_MAXWIDTH, PDF_MEDIABOX, PDF_METADATA, PDF_MISSINGWIDTH, PDF_MK, PDF_MODDATE, PDF_N, PDF_NAME, PDF_NAMED, PDF_NAMED_ACT_FIND, PDF_NAMED_ACT_OPEN, PDF_NAMED_ACT_PRINT, PDF_NAMED_ACT_SEARCH, PDF_NAMES, PDF_NAMESTART, PDF_NEEDAPPEARANCES, PDF_NEWLINE, PDF_NEWWINDOW, PDF_NEXT, PDF_NEXT_PAGE, PDF_NO_COMP_OBJ, PDF_NONFULLSCREEN_PAGEMODE, PDF_NULL, PDF_O, PDF_OBJ, PDF_OBJSTREAM, PDF_OCPROPERTIES, PDF_OFF, PDF_ONECOLUMN, PDF_OPEN, PDF_OPEN_ACTION, PDF_OPT, PDF_OUTLINES, PDF_OUTPUTINTENTS, PDF_OUTWARD, PDF_P, PDF_PAGE, PDF_PAGECLOSE, PDF_PAGEINVISIBLE, PDF_PAGELABELS, PDF_PAGELAYOUT, PDF_PAGEMODE, PDF_PAGEOPEN, PDF_PAGES, PDF_PAGEVISIBLE, PDF_PAINT_TYPE, PDF_PARAMS, PDF_PARENT, PDF_PATTERN, PDF_PATTERN_TYPE, PDF_PBD, PDF_PC, PDF_PDC, PDF_PDF, PDF_PERMS, PDF_PFD, PDF_PH, PDF_PIECEINFO, PDF_POLYGONANNOT, PDF_POLYLINEANNOT, PDF_POPUP, PDF_PREDICTOR, PDF_PREV, PDF_PREV_PAGE, PDF_PROCSET, PDF_PRODUCER, PDF_PROPERTIES, PDF_PUSH, PDF_PV, PDF_Q, PDF_QUADPOINTS, PDF_R, PDF_R2L, PDF_RC, PDF_RD, PDF_RE, PDF_REASON, PDF_RECALCULATE, PDF_RECT, PDF_REMOTEGOTO_ACTION, PDF_RENDITIONS, PDF_REPLACE, PDF_RESET_FORM, PDF_RESOURCES, PDF_RESTORE_GS, PDF_RI, PDF_ROOT, PDF_ROTATE, PDF_RUNLENGTH, PDF_RUNLENGTH_NEW, PDF_S, PDF_SCN, PDF_SHADING, PDF_SHOWIMG, PDF_SHOWTEXT, PDF_SHOWTEXT_TJ, PDF_SIG, PDF_SIG_FILTER_ADOBE_PPKLITE, PDF_SIG_FILTER_ADOBE_PPKMS, PDF_SIG_SUBFILTER_ADBE_PKCS7_DETACHED, PDF_SIG_SUBFILTER_ADBE_PKCS7_SHA1, PDF_SINGLE_QUOTES, PDF_SINGLEPAGE, PDF_SIZE, PDF_SP, PDF_SPIDERINFO, PDF_SPLIT, PDF_SQUAREANNOT, PDF_SQUIGGLY, PDF_SS, PDF_STAMPANNOT, PDF_STARTXREF, PDF_StmF, PDF_STORE_GS, PDF_STREAM, PDF_StrF, PDF_STRIKEOUT, PDF_STRUCT_TREE, PDF_SUBFILTER, PDF_SUBMIT_FORM, PDF_SUBTYPE, PDF_T, PDF_TAB, PDF_TEMPLATES, PDF_TEXT, PDF_TEXTANNOT, PDF_TEXTDIMENSION, PDF_TEXTFONT, PDF_TEXTLEAD, PDF_TEXTMATRIX, PDF_TEXTNEWLINESTART, PDF_TEXTRENDER, PDF_TEXTWIDTH, PDF_THREADS, PDF_THUMB, PDF_TILING_TYPE, PDF_TITLE, PDF_TJ_OPERAND_END, PDF_TJ_OPERAND_START, PDF_TM, PDF_TOUNICODE, PDF_TP, PDF_TRAILER, PDF_TRANSITION, PDF_TRIMBOX, PDF_TRUE, PDF_TRUETYPE, PDF_TU, PDF_TWOCOLUMN_LEFT, PDF_TWOCOLUMN_RIGHT, PDF_TWOPAGE_LEFT, PDF_TWOPAGE_RIGHT, PDF_TX, PDF_TYPE, PDF_TYPE0, PDF_TYPE1, PDF_U, PDF_UNCOVER, PDF_UNDERLINE, PDF_UNIX, PDF_URI_ACTION, PDF_URL, PDF_URLS, PDF_USEATTACHMENTS, PDF_USENONE, PDF_USEOC, PDF_USEOUTLINES, PDF_USETHUMBS, PDF_V, PDF_VALUECHANGE, PDF_VERSION, PDF_VERT_STEM, PDF_VERTICAL, PDF_VERTICES, PDF_VIEWER_PREFERENCES, PDF_W, PDF_WATERMARKANNOT, PDF_WIDGET, PDF_WIDTH, PDF_WIDTHS, PDF_WINANSIENCODING, PDF_WIPE, PDF_X, PDF_XOBJECT, PDF_XREF, PDF_XREFSTMOFFSET, PDF_XREFSTREAM, PDF_XSTEP, PDF_XYZ, PDF_YES, PDF_YSTEP, PIXEL_PER_INCH, RUBICON_EMBEDDED, SITE, TEXT, TWIPS_TO_POINTS
 
Constructor Summary
PdfFormPushButton(PdfRect rect)
          Constructs a push button form field with specified bounding box.
PdfFormPushButton(PdfRect r, String name)
          Constructs a push button form field with specified bounding box and name.
PdfFormPushButton(PdfRect r, String name, Color borderColor, Color backgroundColor)
          Constructs a push button form field with specified bounding box, name, border color, and background color.
PdfFormPushButton(PdfRect r, String name, int fieldFlags)
          Constructs a push button form field with specified bounding box, name, and flags.
PdfFormPushButton(PdfRect r, String name, int fieldFlags, Color borderColor, Color backgroundColor)
          Constructs a push button form field with specified bounding box, name, flags, border color, and background color.
PdfFormPushButton(PdfRect r, String name, String normalCaption)
           
PdfFormPushButton(PdfRect r, String name, String alternateName, String mappingName)
          Constructs a push button form field with specified bounding box, name, alternate name, and mapping name.
PdfFormPushButton(PdfRect r, String name, String alternateName, String mappingName, Color borderColor, Color backgroundColor)
          Constructs a push button form field with specified bounding box, name, alternate name, mapping name, border color, and background color.
PdfFormPushButton(PdfRect r, String name, String alternateName, String mappingName, int fieldFlags)
          Constructs a push button form field with specified bounding box, name, alternate name, mapping name, and flags.
PdfFormPushButton(PdfRect r, String name, String alternateName, String mappingName, int fieldFlags, Color borderColor, Color backgroundColor)
          Constructs a push button form field with specified bounding box, name, alternate name, mapping name, flags, border color, and background color.
PdfFormPushButton(PdfRect r, String name, String normalCaption, String rolloverCaption, String downCaption)
          Constructs a push button form field with specified bounding box, name, normal caption, rollover caption, and down caption.
PdfFormPushButton(String name)
          Constructs a push button form field with specified name.
PdfFormPushButton(String name, Color borderColor, Color backgroundColor)
          Constructs a push button form field with specified name, border color, and background color.
PdfFormPushButton(String name, int fieldFlags)
          Constructs a push button form field with specified name and flags.
PdfFormPushButton(String name, int fieldFlags, Color borderColor, Color backgroundColor)
          Constructs a push button form field with specified name, flags, border color, and background color.
PdfFormPushButton(String name, String alternateName, String mappingName)
          Constructs a push button form field with specified name, alternate name, and mapping name.
PdfFormPushButton(String name, String alternateName, String mappingName, Color borderColor, Color backgroundColor)
          Constructs a push button form field with specified name, alternate name, mapping name, border color, and background color.
PdfFormPushButton(String name, String alternateName, String mappingName, int fieldFlags)
          Constructs a push button form field with specified name, alternate name, mapping name, and flags.
PdfFormPushButton(String name, String alternateName, String mappingName, int fieldFlags, Color borderColor, Color backgroundColor)
          Constructs a push button form field with specified name, alternate name, mapping name, flags, border color, and background color.
 
Method Summary
 void addDownAppearance(PdfAppearanceStream ap, int state)
          Adds an appearance stream for specified button state of the form field that the viewer applications should use when the user presses the mouse pointer over the field.
 void addNormalAppearance(PdfAppearanceStream ap, int state)
          Adds an appearance stream for specified button state of the form field that the viewer applications should use when the user is not interacting with the field.
 void addRolloverAppearance(PdfAppearanceStream ap, int state)
          Adds an appearance stream for specified button state of the form field that the viewer applications should use when the user hovers the mouse pointer over the field.
 Object clone()
           
 int getCaptionPosition()
          Returns position of the caption on the push button.
 String getDownCaption()
          Returns caption used for the form field when it is depressed by the user on viewer applications.
 int getHighlightMode()
          Returns highlight style used by viewer applications for the form field when the user interacts with the field.
 double getIconBottomPadding()
          Returns bottom padding for the icon with the form field bounding box.
 double getIconLeftPadding()
          Returns left padding for the icon with the form field bounding box.
 String getNormalCaption()
          Returns text that viewer applications display on the form field when the user is not interacting with the field.
 String getRolloverCaption()
          Returns caption used by the viewer applications on the form field when the user moves the mouse pointer over the field.
 int getScaleEvent()
          Returns when viewer applications will scale the icon within the bounding box of the push button.
 int getScaleType()
          Returns how viewer applications will scale the icon within the bounding box of the push button.
 int getState()
          Returns button state for the form field.
 boolean isIconFitToRect()
          Returns whether width of the border of the push button will be considered when scaling the icon of the push button within button's bounding box.
 void setCaptionPosition(int captionPosition)
           
 void setDownCaption(String downCaption)
          Specifies caption that needs to be used for the form field when it is depressed by the user on viewer applications.
 void setDownIcon(PdfImage downIcon)
          Specifies icon that the viewer application should display for the push button when the user presses down on the button.
 void setHighlightMode(int highlightMode)
          Specifies highlight style for the form field that viewer applications need to use when the user interacts with the field.
 void setIconBottomPadding(double iconBottomPadding)
          Specifies bottom padding for the icon with the form field bounding box.
 void setIconFitToRect(boolean iconFitToRect)
          Specifies whether width of the border of the push button needs to be considered when scaling the icon of the push button within button's bounding box.
 void setIconLeftPadding(double iconLeftPadding)
          Specifies left padding for the icon with the form field bounding box.
 void setNormalCaption(String normalCaption)
          Specifies text that viewer applications should display on the form field when the user is not interacting with the field.
 void setNormalIcon(PdfImage normalIcon)
          Specifies icon that the viewer application should display for the push button when the user is not interacting with the button.
 void setRolloverCaption(String rolloverCaption)
          Specifies caption used by the viewer applications on the form field when the user moves the mouse pointer over the field.
 void setRollOverIcon(PdfImage rollOverIcon)
          Specifies icon used by the viewer applications on the form field when the user moves the mouse pointer over the field.
 void setScaleEvent(int scaleEvent)
          Specifies when viewer applications should scale the icon within the bounding box of the push button.
 void setScaleType(int scaleType)
          Specifies how viewer applications should scale the icon within the bounding box of the push button.
 
Methods inherited from class com.gnostice.pdfone.PdfFormField
addAction, addAction, addAction, addActionFormReset, addActionFormReset, addActionFormReset, addActionFormSubmit, addActionFormSubmit, addActionFormSubmit, addActionImportData, addChildField, flatten, flatten, getAlternateName, getBackgroundColor, getBorderColor, getCheckGroupItems, getCheckGroupSelectedIndices, getCheckGroupSelectedValues, getChildCount, getChildList, getDefaultValue, getDownAppearance, getFieldFlags, getFont, getFullyQualifiedName, getMappingName, getName, getNormalAppearance, getPopup, getRadioGroupSelectedIndices, getRadioGroupSelectedValues, getRolloverAppearance, getRotation, getType, getValue, isFlattened, isNameAsUnicode, isNoExport, isNoSpellCheck, isRadioInUnison, isRadioNoToggleToOff, isReadOnly, isRequired, setAlternateName, setBackgroundColor, setBorderColor, setDefaultValue, setDownAppearance, setFieldFlags, setFont, setIncludeNoValueFieldsOnSubmit, setMappingName, setName, setNameAsUnicode, setNoExport, setNormalAppearance, setNoSpellCheck, setParentAsNull, setPopup, setRadioInUnison, setRadioNoToggleToOff, setReadOnly, setRequired, setRolloverAppearance, setRotation, setSubmitActionType, setType, setValue
 
Methods inherited from class com.gnostice.pdfone.PdfAnnot
delete, getAnnotName, getBorderStyle, getBorderWidth, getBottom, getColor, getContents, getDashPattern, getFlags, getLeft, getRect, getRight, getSubject, getTitle, getTop, hashCode, isDeleted, isShowRect, setAnnotName, setBorderStyle, setBorderWidth, setColor, setContents, setDashPattern, setFlags, setRect, setRect, setRect, setRect, setRect, setShowRect, setSubject, setTitle
 
Methods inherited from class java.lang.Object
equals, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CAPTION_ON

public static final int CAPTION_ON
Constant specifying a push button having a caption but no icon.

See Also:
Constant Field Values

CAPTION_OFF

public static final int CAPTION_OFF
Constant specifying a push button having an icon but no caption.

See Also:
Constant Field Values

CAPTION_BELOW

public static final int CAPTION_BELOW
Constant specifying a push button having its caption below its icon.

See Also:
Constant Field Values

CAPTION_ABOVE

public static final int CAPTION_ABOVE
Constant specifying a push button having its caption above its icon.

See Also:
Constant Field Values

CAPTION_RIGHTSIDE

public static final int CAPTION_RIGHTSIDE
Constant specifying a push button having its caption on the right side of its icon.

See Also:
Constant Field Values

CAPTION_LEFTSIDE

public static final int CAPTION_LEFTSIDE
Constant specifying a push button having its caption on the left side of its icon.

See Also:
Constant Field Values

CAPTION_OVERLAID

public static final int CAPTION_OVERLAID
Constant specifying a push button having its caption right over the icon.

See Also:
Constant Field Values

SCALE_ALWAYS

public static final int SCALE_ALWAYS
Constant specifying that the viewer application should always scale the icon within the bounding box of the push button.

See Also:
Constant Field Values

SCALE_NEVER

public static final int SCALE_NEVER
Constant specifying that the viewer application should never scale the icon within the bounding box of the push button.

See Also:
Constant Field Values

SCALE_WHEN_ICON_IS_BIGGER

public static final int SCALE_WHEN_ICON_IS_BIGGER
Constant specifying that the viewer application should scale the icon within the bounding box of the push button when the icon is bigger than the bounding box.

See Also:
Constant Field Values

SCALE_WHEN_ICON_IS_SMALLER

public static final int SCALE_WHEN_ICON_IS_SMALLER
Constant specifying that the viewer application should scale the icon within the bounding box of the push button when the icon is smaller than the bounding box.

See Also:
Constant Field Values

SCALE_TYPE_PROPORTIONAL

public static final int SCALE_TYPE_PROPORTIONAL
Constant for specifying scaling the icon within the bounding box of a push button while maintaining the aspect ratio (width-height ratio).

See Also:
Constant Field Values

SCALE_TYPE_ANAMORPHIC

public static final int SCALE_TYPE_ANAMORPHIC
Constant for specifying scaling the icon within the bounding box of a push button without maintaining the aspect ratio (width-height ratio). The icon fits the whole of the bounding box.

See Also:
Constant Field Values
Constructor Detail

PdfFormPushButton

public PdfFormPushButton(String name,
                         int fieldFlags)
Constructs a push button form field with specified name and flags.

Parameters:
name - name for the push button in the document
fieldFlags - form field flags
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(String name,
                         String alternateName,
                         String mappingName,
                         int fieldFlags)
Constructs a push button form field with specified name, alternate name, mapping name, and flags.

Parameters:
name - name for the push button in the document
alternateName - alternate name for the push button in the document
mappingName - mapping name for the push button in the document
fieldFlags - form field flags
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(String name,
                         String alternateName,
                         String mappingName)
Constructs a push button form field with specified name, alternate name, and mapping name.

Parameters:
name - name for the push button in the document
alternateName - alternate name for the push button in the document
mappingName - mapping name for the push button in the document
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(String name)
Constructs a push button form field with specified name.

Parameters:
name - name for the push button in the document
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(PdfRect rect)
Constructs a push button form field with specified bounding box.

Parameters:
rect - bounding box of the push button

PdfFormPushButton

public PdfFormPushButton(PdfRect r,
                         String name,
                         int fieldFlags)
Constructs a push button form field with specified bounding box, name, and flags.

Parameters:
r - bounding box of the push button
name - name for the push button in the document
fieldFlags - form field flags
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(PdfRect r,
                         String name)
Constructs a push button form field with specified bounding box and name.

Parameters:
r - bounding box of the push button
name - name for the push button in the document
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(PdfRect r,
                         String name,
                         String alternateName,
                         String mappingName,
                         int fieldFlags)
Constructs a push button form field with specified bounding box, name, alternate name, mapping name, and flags.

Parameters:
r - bounding box of the push button
name - name for the push button in the document
alternateName - alternate name for the push button in the document
mappingName - mapping name for the push button in the document
fieldFlags - form field flags

PdfFormPushButton

public PdfFormPushButton(PdfRect r,
                         String name,
                         String alternateName,
                         String mappingName)
Constructs a push button form field with specified bounding box, name, alternate name, and mapping name.

Parameters:
r - bounding box of the push button
name - name for the push button in the document
alternateName - mapping name for the push button in the document
mappingName - mapping name for the push button in the document
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(String name,
                         int fieldFlags,
                         Color borderColor,
                         Color backgroundColor)
Constructs a push button form field with specified name, flags, border color, and background color.

Parameters:
name - name for the push button in the document
fieldFlags - form field flags
borderColor - border color of the push button
backgroundColor - background color of the push button
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(String name,
                         String alternateName,
                         String mappingName,
                         int fieldFlags,
                         Color borderColor,
                         Color backgroundColor)
Constructs a push button form field with specified name, alternate name, mapping name, flags, border color, and background color.

Parameters:
name - name for the push button in the document
alternateName - alternate name for the push button in the document
mappingName - mapping name for the push button in the document
fieldFlags - form field flags
borderColor - border color of the push button
backgroundColor - background color of the push button
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(String name,
                         String alternateName,
                         String mappingName,
                         Color borderColor,
                         Color backgroundColor)
Constructs a push button form field with specified name, alternate name, mapping name, border color, and background color.

Parameters:
name - name for the push button in the document
alternateName - alternate name for the push button in the document
mappingName - mapping name for the push button in the document
borderColor - border color of the push button
backgroundColor - background color of the push button
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(String name,
                         Color borderColor,
                         Color backgroundColor)
Constructs a push button form field with specified name, border color, and background color.

Parameters:
name - name for the push button in the document
borderColor - border color of the push button
backgroundColor - background color of the push button
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(PdfRect r,
                         String name,
                         int fieldFlags,
                         Color borderColor,
                         Color backgroundColor)
Constructs a push button form field with specified bounding box, name, flags, border color, and background color.

Parameters:
r - bounding box of the push button
name - name for the push button in the document
fieldFlags - form field flags
borderColor - border color of the push button
backgroundColor - background color of the push button
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(PdfRect r,
                         String name,
                         Color borderColor,
                         Color backgroundColor)
Constructs a push button form field with specified bounding box, name, border color, and background color.

Parameters:
r - bounding box of the push button
name - name for the push button in the document
borderColor - border color of the push button
backgroundColor - background color of the push button
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(PdfRect r,
                         String name,
                         String alternateName,
                         String mappingName,
                         int fieldFlags,
                         Color borderColor,
                         Color backgroundColor)
Constructs a push button form field with specified bounding box, name, alternate name, mapping name, flags, border color, and background color.

Parameters:
r - bounding box of the push button
name - name for the push button in the document
alternateName - alternate name for the push button in the document
mappingName - mapping name for the push button in the document
fieldFlags - form field flags
borderColor - border color of the push button
backgroundColor - background color of the push button
See Also:
PdfFormField

PdfFormPushButton

public PdfFormPushButton(PdfRect r,
                         String name,
                         String alternateName,
                         String mappingName,
                         Color borderColor,
                         Color backgroundColor)
Constructs a push button form field with specified bounding box, name, alternate name, mapping name, border color, and background color.

Parameters:
r - bounding box of the push button
name - name for the push button in the document
alternateName - alternate name for the push button in the document
mappingName - mapping name for the push button in the document
borderColor - border color of the push button
backgroundColor - background color of the push button

PdfFormPushButton

public PdfFormPushButton(PdfRect r,
                         String name,
                         String normalCaption)

PdfFormPushButton

public PdfFormPushButton(PdfRect r,
                         String name,
                         String normalCaption,
                         String rolloverCaption,
                         String downCaption)
Constructs a push button form field with specified bounding box, name, normal caption, rollover caption, and down caption.

Parameters:
r - bounding box of the push button
name - name for the push button in the document
normalCaption - caption that viewer applications should display when the user is not interacting with the button
rolloverCaption - caption that viewer applications should display when the user moves the mouse pointer over the button
downCaption - that viewer applications should display when the user presses down on the button
Method Detail

clone

public Object clone()

addNormalAppearance

public void addNormalAppearance(PdfAppearanceStream ap,
                                int state)
Deprecated. Use setNormalAppearance(PdfAppearanceStream) instead.

Description copied from class: com.gnostice.pdfone.PdfFormButtonField
Adds an appearance stream for specified button state of the form field that the viewer applications should use when the user is not interacting with the field.

Parameters:
ap - appearance stream for specified button state of the form field that the viewer applications should use when the user is not interacting with the field
state - constant specifying the button state

addDownAppearance

public void addDownAppearance(PdfAppearanceStream ap,
                              int state)
Deprecated. Use setDownAppearance(PdfAppearanceStream) instead.

Description copied from class: com.gnostice.pdfone.PdfFormButtonField
Adds an appearance stream for specified button state of the form field that the viewer applications should use when the user presses the mouse pointer over the field.

Parameters:
ap - appearance stream for specified button state of the form field that the viewer applications should use when the user presses the mouse pointer over the field
state - constant specifying the button state

addRolloverAppearance

public void addRolloverAppearance(PdfAppearanceStream ap,
                                  int state)
Deprecated. Use setRolloverAppearance(PdfAppearanceStream) instead.

Description copied from class: com.gnostice.pdfone.PdfFormButtonField
Adds an appearance stream for specified button state of the form field that the viewer applications should use when the user hovers the mouse pointer over the field.

Parameters:
ap - appearance stream for specified button state of the form field that the viewer applications should use when the user hovers the mouse pointer over the field
state - constant specifying the button state

getIconBottomPadding

public double getIconBottomPadding()
Returns bottom padding for the icon with the form field bounding box.

Returns:
bottom padding for the icon with the form field bounding box
See Also:
setIconBottomPadding(double)

setIconBottomPadding

public void setIconBottomPadding(double iconBottomPadding)
Specifies bottom padding for the icon with the form field bounding box. The padding will take effect only if setScaleType(int) is called with SCALE_TYPE_ANAMORPHIC. If a value of 0 (zero) is specified, then the icon will be positioned at the bottom edge of the bounding box. A value of 0.5 will position the icon right between the top and bottom edges of the bounding box.

Parameters:
iconBottomPadding - value between 0 and 1 indicating the fraction of the bottom padding and the total height of the bounding box
See Also:
getIconBottomPadding(), setIconLeftPadding(double)

isIconFitToRect

public boolean isIconFitToRect()
Returns whether width of the border of the push button will be considered when scaling the icon of the push button within button's bounding box.

Returns:
whether width of the border of the push button will be considered when scaling the icon of the push button within button's bounding box.
See Also:
setIconFitToRect(boolean), setScaleType(int)

setIconFitToRect

public void setIconFitToRect(boolean iconFitToRect)
Specifies whether width of the border of the push button needs to be considered when scaling the icon of the push button within button's bounding box.

Parameters:
iconFitToRect - whether width of the border of the push button needs to be considered when scaling the icon of the push button within button's bounding box
See Also:
isIconFitToRect(), setScaleType(int)

getIconLeftPadding

public double getIconLeftPadding()
Returns left padding for the icon with the form field bounding box.

Returns:
left padding for the icon with the form field bounding box
See Also:
setIconLeftPadding(double)

setIconLeftPadding

public void setIconLeftPadding(double iconLeftPadding)
Specifies left padding for the icon with the form field bounding box. The padding will take effect only if setScaleType(int) is called with SCALE_TYPE_ANAMORPHIC. If a value of 0 (zero) is specified, then the icon will be positioned at the left edge of the bounding box. A value of 0.5 will position the icon right between the top and bottom edges of the bounding box.

Parameters:
iconLeftPadding - value between 0 and 1 indicating the fraction of the left padding and the total width of the bounding box
See Also:
getIconLeftPadding(), setIconBottomPadding(double)

getScaleEvent

public int getScaleEvent()
Returns when viewer applications will scale the icon within the bounding box of the push button.

Returns:
constant specifying when viewer applications will scale the icon within the bounding box of the push button
See Also:
setScaleEvent(int)

setScaleEvent

public void setScaleEvent(int scaleEvent)
Specifies when viewer applications should scale the icon within the bounding box of the push button.

Parameters:
scaleEvent - constant specifying when viewer applications should scale the icon within the bounding box of the push button; either PdfFormButtonField.SCALE_ALWAYS or PdfFormButtonField.SCALE_NEVER.
See Also:
getScaleEvent()

getScaleType

public int getScaleType()
Returns how viewer applications will scale the icon within the bounding box of the push button.

Returns:
constant specifying how viewer applications will scale the icon within the bounding box of the push button
See Also:
setScaleType(int)

setScaleType

public void setScaleType(int scaleType)
Specifies how viewer applications should scale the icon within the bounding box of the push button.

Parameters:
scaleType - constant specifying how viewer applications should scale the icon within the bounding box of the push button
See Also:
getScaleType()

getCaptionPosition

public int getCaptionPosition()
Returns position of the caption on the push button.

Returns:
constant specifying the position of the caption

setCaptionPosition

public void setCaptionPosition(int captionPosition)
Parameters:
captionPosition -

getDownCaption

public String getDownCaption()
Returns caption used for the form field when it is depressed by the user on viewer applications.

Returns:
caption used for the form field when it is depressed by the user
See Also:
setDownCaption(String)

setDownCaption

public void setDownCaption(String downCaption)
Specifies caption that needs to be used for the form field when it is depressed by the user on viewer applications.

Parameters:
downCaption - caption that needs to be used for the form field when it is depressed by the user
See Also:
getDownCaption()

getRolloverCaption

public String getRolloverCaption()
Returns caption used by the viewer applications on the form field when the user moves the mouse pointer over the field.

Returns:
caption used by the viewer applications on the form field when moves the mouse pointer over the field
See Also:
setRolloverCaption(String)

setRolloverCaption

public void setRolloverCaption(String rolloverCaption)
Specifies caption used by the viewer applications on the form field when the user moves the mouse pointer over the field.

Parameters:
rolloverCaption - caption used by the viewer applications on the form field when the user moves the mouse pointer over the field
See Also:
setRolloverCaption(String)

setDownIcon

public void setDownIcon(PdfImage downIcon)
Specifies icon that the viewer application should display for the push button when the user presses down on the button.

Parameters:
downIcon - image (icon) that the viewer application should display for the push button when the user presses down on the button.

setNormalIcon

public void setNormalIcon(PdfImage normalIcon)
Specifies icon that the viewer application should display for the push button when the user is not interacting with the button.

Parameters:
normalIcon - image (icon) that the viewer application should display for the push button when the user is not interacting with the button

setRollOverIcon

public void setRollOverIcon(PdfImage rollOverIcon)
Specifies icon used by the viewer applications on the form field when the user moves the mouse pointer over the field.

Parameters:
rollOverIcon - image (icon) used by the viewer applications on the form field when the user moves the mouse pointer over the field

getNormalCaption

public String getNormalCaption()
Returns text that viewer applications display on the form field when the user is not interacting with the field.

Returns:
text that viewer applications display on the form field when the user is not interacting with the field
See Also:
PdfFormButtonField.setNormalCaption(String)

setNormalCaption

public void setNormalCaption(String normalCaption)
Specifies text that viewer applications should display on the form field when the user is not interacting with the field.

Parameters:
normalCaption - text that viewer applications should display on the form field when the user is not interacting with the field
See Also:
PdfFormButtonField.getNormalCaption()

getHighlightMode

public int getHighlightMode()
Returns highlight style used by viewer applications for the form field when the user interacts with the field.

Returns:
constant specifying the highlight style

setHighlightMode

public void setHighlightMode(int highlightMode)
Specifies highlight style for the form field that viewer applications need to use when the user interacts with the field.

Parameters:
highlightMode - constant specifying the highlight style

getState

public int getState()
Returns button state for the form field.

Returns:
constant specifying the button state

Gnostice PDFOne
Pro. Ed. v5.0.0

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