Overview  Package   Class  Tree  Deprecated  Index  Help 

Gnostice PDFOne Java
Std. Ed. v2.10
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.gnostice.pdfone
Class PdfFormCheckBox

java.lang.Object
  extended by com.gnostice.pdfone.PdfAnnot
      extended by com.gnostice.pdfone.PdfFormField
          extended by com.gnostice.pdfone.PdfFormCheckBox
All Implemented Interfaces:
Usable, Cloneable
public class PdfFormCheckBox
extends PdfFormField

This class represents a check box form field. Viewer applications allow users to select or deselect a check box form field. When the check box is selected, it is supposed to be in an on state. When it is selected, the field is supposed to be in an off state. When the form is submitted, a check box in an onstate submits its name as the value. If the check box is not selected, then the field's value will be "off" and it will not be among the fields that are submitted by the users.

A set of check box form fields can be added to an PdfFormField object of type PdfFormField.TYPE_CHECKGROUP. 

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

// Create a check box
PdfFormCheckBox cb1 = new PdfFormCheckBox(
                               new PdfRect(200, 100, 10, 10),
                               "isMarried");
cb1.setBorderColor(Color.BLACK);
cb1.setState(PdfFormField.BUTTON_STATE_OFF);

// Create another check box
PdfFormCheckBox cb2 = new PdfFormCheckBox(
                               new PdfRect(200, 120, 10, 10),
                               "isEmployed");
cb2.setBorderColor(Color.BLACK);
cb2.setState(PdfFormField.BUTTON_STATE_OFF);

// Add the check box form fields to the page
page.addFormField(cb1);
page.addFormField(cb2);

page.writeText("Married", 220, 98);
page.writeText("Employed", 220, 118);

Field Summary
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, HIGHLIGHT_MODE_INVERT, HIGHLIGHT_MODE_NONE, HIGHLIGHT_MODE_OUTLINE, HIGHLIGHT_MODE_PUSH, HIGHLIGHT_MODE_TOGGLE, TYPE_CHECKGROUP, TYPE_COMBOBOX, TYPE_LISTBOX, TYPE_PUSHBUTTON, TYPE_RADIOGROUP, 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_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_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_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_FONTDESCRIPTOR, PDF_FONTFILE, PDF_FONTFILE_2, PDF_FontFile_3, PDF_FONTFILE2, 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
PdfFormCheckBox(PdfRect rect)
           
PdfFormCheckBox(PdfRect r, String name)
           
PdfFormCheckBox(PdfRect r, String name, Color borderColor, Color backgroundColor)
           
PdfFormCheckBox(PdfRect r, String name, int fieldFlags)
           
PdfFormCheckBox(PdfRect r, String name, int fieldFlags, Color borderColor, Color backgroundColor)
           
PdfFormCheckBox(PdfRect r, String name, String alternateName, String mappingName)
           
PdfFormCheckBox(PdfRect r, String name, String alternateName, String mappingName, Color borderColor, Color backgroundColor)
           
PdfFormCheckBox(PdfRect r, String name, String alternateName, String mappingName, int fieldFlags)
           
PdfFormCheckBox(PdfRect r, String name, String alternateName, String mappingName, int fieldFlags, Color borderColor, Color backgroundColor)
           
PdfFormCheckBox(String name)
           
PdfFormCheckBox(String name, Color borderColor, Color backgroundColor)
           
PdfFormCheckBox(String name, int fieldFlags)
           
PdfFormCheckBox(String name, int fieldFlags, Color borderColor, Color backgroundColor)
           
PdfFormCheckBox(String name, String alternateName, String mappingName)
           
PdfFormCheckBox(String name, String alternateName, String mappingName, Color borderColor, Color backgroundColor)
           
PdfFormCheckBox(String name, String alternateName, String mappingName, int fieldFlags)
           
PdfFormCheckBox(String name, String alternateName, String mappingName, int fieldFlags, Color borderColor, Color backgroundColor)
           
 
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()
           
 List getChildList()
           
 PdfAppearanceStream getDownAppearance()
          Returns the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.
 int getHighlightMode()
          Returns highlight style used by viewer applications for the form field when the user interacts with the field.
 PdfAppearanceStream getNormalAppearance()
          Returns the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).
 String getNormalCaption()
          Returns text that viewer applications display on the form field when the user is not interacting with the field.
 PdfAppearanceStream getRolloverAppearance()
          Returns the appearance stream that needs to be used by a viewer application to display the annotation when the user places the mouse pointer over the annotation (and does not hold down the mouse button).
 int getState()
          Returns button state for the form field.
 void setDownAppearance(PdfAppearanceStream downAppearance)
          Deprecated. Use addDownAppearance(PdfAppearanceStream, int) method instead.
 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 setNormalAppearance(PdfAppearanceStream normalAppearance)
          Deprecated. Use addNormalAppearance(PdfAppearanceStream, int) method instead.
 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 setRolloverAppearance(PdfAppearanceStream rolloverAppearance)
          Deprecated. Use addRolloverAppearance(PdfAppearanceStream, int) method instead.
 void setState(int appearanceState)
           
 
Methods inherited from class com.gnostice.pdfone.PdfFormField
addAction, addAction, addAction, addActionFormReset, addActionFormReset, addActionFormReset, addActionFormSubmit, addActionFormSubmit, addActionFormSubmit, addActionImportData, addChildField, delete, flatten, flatten, getAlternateName, getBackgroundColor, getBorderColor, getCheckGroupItems, getCheckGroupSelectedIndices, getCheckGroupSelectedValues, getChildCount, getDefaultValue, getFieldFlags, getFont, getFullyQualifiedName, getMappingName, getName, getPopup, getRadioGroupSelectedIndices, getRadioGroupSelectedValues, getRotation, getType, getValue, isNameAsUnicode, isNoExport, isNoSpellCheck, isRadioInUnison, isRadioNoToggleToOff, isReadOnly, isRequired, setAlternateName, setBackgroundColor, setBorderColor, setDefaultValue, setFieldFlags, setFont, setMappingName, setName, setNameAsUnicode, setNoExport, setNoSpellCheck, setParentAsNull, setPopup, setRadioInUnison, setRadioNoToggleToOff, setReadOnly, setRequired, setRotation, setType, setValue
 
Methods inherited from class com.gnostice.pdfone.PdfAnnot
getAnnotName, getBorderStyle, getBorderWidth, getBottom, getColor, getContents, getDashPattern, getFlags, getLeft, getRect, getRight, getSubject, getTitle, getTop, hashCode, 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

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

PdfFormCheckBox

public PdfFormCheckBox(String name,
                       int fieldFlags)

PdfFormCheckBox

public PdfFormCheckBox(String name,
                       String alternateName,
                       String mappingName,
                       int fieldFlags)

PdfFormCheckBox

public PdfFormCheckBox(String name,
                       String alternateName,
                       String mappingName)

PdfFormCheckBox

public PdfFormCheckBox(String name)

PdfFormCheckBox

public PdfFormCheckBox(PdfRect rect)

PdfFormCheckBox

public PdfFormCheckBox(PdfRect r,
                       String name,
                       int fieldFlags)

PdfFormCheckBox

public PdfFormCheckBox(PdfRect r,
                       String name)

PdfFormCheckBox

public PdfFormCheckBox(PdfRect r,
                       String name,
                       String alternateName,
                       String mappingName,
                       int fieldFlags)

PdfFormCheckBox

public PdfFormCheckBox(PdfRect r,
                       String name,
                       String alternateName,
                       String mappingName)

PdfFormCheckBox

public PdfFormCheckBox(String name,
                       int fieldFlags,
                       Color borderColor,
                       Color backgroundColor)

PdfFormCheckBox

public PdfFormCheckBox(String name,
                       String alternateName,
                       String mappingName,
                       int fieldFlags,
                       Color borderColor,
                       Color backgroundColor)

PdfFormCheckBox

public PdfFormCheckBox(String name,
                       String alternateName,
                       String mappingName,
                       Color borderColor,
                       Color backgroundColor)

PdfFormCheckBox

public PdfFormCheckBox(String name,
                       Color borderColor,
                       Color backgroundColor)

PdfFormCheckBox

public PdfFormCheckBox(PdfRect r,
                       String name,
                       int fieldFlags,
                       Color borderColor,
                       Color backgroundColor)

PdfFormCheckBox

public PdfFormCheckBox(PdfRect r,
                       String name,
                       Color borderColor,
                       Color backgroundColor)

PdfFormCheckBox

public PdfFormCheckBox(PdfRect r,
                       String name,
                       String alternateName,
                       String mappingName,
                       int fieldFlags,
                       Color borderColor,
                       Color backgroundColor)

PdfFormCheckBox

public PdfFormCheckBox(PdfRect r,
                       String name,
                       String alternateName,
                       String mappingName,
                       Color borderColor,
                       Color backgroundColor)
Method Detail

clone

public Object clone()

setNormalAppearance

public void setNormalAppearance(PdfAppearanceStream normalAppearance)
Deprecated. Use addNormalAppearance(PdfAppearanceStream, int) method instead.

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

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

getNormalAppearance

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

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

setDownAppearance

public void setDownAppearance(PdfAppearanceStream downAppearance)
Deprecated. Use addDownAppearance(PdfAppearanceStream, int) method instead.

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

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

getDownAppearance

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

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

setRolloverAppearance

public void setRolloverAppearance(PdfAppearanceStream rolloverAppearance)
Deprecated. Use addRolloverAppearance(PdfAppearanceStream, int) method instead.

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

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

getRolloverAppearance

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

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

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:
getNormalCaption()

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:
setNormalCaption(String)

getChildList

public List getChildList()
Overrides:
getChildList in class PdfFormField

setState

public void setState(int appearanceState)

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

addNormalAppearance

public 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.

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

addRolloverAppearance

public 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.

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

addDownAppearance

public 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.

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
Overview  Package   Class  Tree  Deprecated  Index  Help 
Gnostice PDFOne Java
Std. Ed. v2.10
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
To contact our support team, send an e-mail to support@gnostice.com.
 
© 2008 Gnostice Information Technologies Private Limited. All rights reserved.
www.gnostice.com