com.gnostice.pdfone

Class PdfFormComboBox

java.lang.Object

com.gnostice.pdfone.PdfAnnot

com.gnostice.pdfone.PdfFormField

com.gnostice.pdfone.PdfFormComboBox

All Implemented Interfaces:

Usable, Cloneable

public class PdfFormComboBox
extends PdfFormField

This class represents a combo box. A combo box provides a drop-down list containing several text options. If the list is made editable, then users can be allowed to enter a text option that is not already in the list.

Here are the steps to use a combo box form field.

1. construct a combo box form field object
2. add text options using PdfFormComboBox.addItem(String) method
3. set other properties such as flags
4. add the combo box to a page using the method PdfPage.addFormField(PdfFormField)

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

// Create a list box
PdfFormComboBox cmb = 
    new PdfFormComboBox(
            new PdfRect(300, 100, 150, 20), 
            "Country", 
            PdfFormField.FLAG_REQUIRED, 
            Color.BLACK, 
            Color.YELLOW);

// Add options to the list box
cmb.addItem("India");
cmb.addItem("United States", true);
cmb.addItem("United Kingdom");
cmb.addItem("Russia", "Russian Federation");

// Add the list box form field to the page
page.addFormField(cmb);

page.writeText("Your location", 220, 100);

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_EDITABLE Flag for specifying that viewer applications can allow the user to enter a new option not already listed for a specific combo box.

Fields inherited from class com.gnostice.pdfone.PdfFormField

ALIGNMENT_CENTER, ALIGNMENT_LEFT, ALIGNMENT_RIGHT, BUTTON_STATE_OFF, BUTTON_STATE_ON, FIELD_FLAG_NO_EXPORT, FIELD_FLAG_READONLY, FIELD_FLAG_REQUIRED, 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_TYPE0, 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_TEXTCHARSPACE, PDF_TEXTDIMENSION, PDF_TEXTFONT, PDF_TEXTHORIZONTALSCALE, PDF_TEXTLEAD, PDF_TEXTMATRIX, PDF_TEXTNEWLINESTART, PDF_TEXTRENDER, PDF_TEXTWORDSPACE, 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_XML, 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

Constructors

Constructor and Description
PdfFormComboBox(PdfRect rect) Constructs a combo box form field with specified bounding box.
PdfFormComboBox(PdfRect r, String name) Constructs a combo box form field with specified bounding box and name.
PdfFormComboBox(PdfRect r, String name, Color borderColor, Color backgroundColor) Constructs a combo box form field with specified bounding box, name, border color, and background color.
PdfFormComboBox(PdfRect r, String name, int fieldFlags) Constructs a combo box form field with specified bounding box, name, and flags.
PdfFormComboBox(PdfRect r, String name, int fieldFlags, Color borderColor, Color backgroundColor) Constructs a combo box form field with specified bounding box, name, flags, border color, and background color.
PdfFormComboBox(PdfRect r, String name, String alternateName, String mappingName) Constructs a combo box form field with specified bounding box, name, alternate name, and mapping name.
PdfFormComboBox(PdfRect r, String name, String alternateName, String mappingName, Color borderColor, Color backgroundColor) Constructs a combo box form field with specified bounding box, name, alternate name, mapping name, border color, and background color.
PdfFormComboBox(PdfRect r, String name, String alternateName, String mappingName, int fieldFlags) Constructs a combo box form field with specified bounding box, name, alternate name, mapping name, and flags.
PdfFormComboBox(PdfRect r, String name, String alternateName, String mappingName, int fieldFlags, Color borderColor, Color backgroundColor) Constructs a combo box form field with specified bounding box, name, alternate name, mapping name, flags, border color, and background color.
PdfFormComboBox(String name) Constructs a combo box form field with specified name.
PdfFormComboBox(String name, Color borderColor, Color backgroundColor) Constructs a combo box form field with specified name, border color, and background color.
PdfFormComboBox(String name, int fieldFlags) Constructs a combo box form field with specified name and flags.
PdfFormComboBox(String name, int fieldFlags, Color borderColor, Color backgroundColor) Constructs a combo box form field with specified name, flags, border color, and background color.
PdfFormComboBox(String name, String alternateName, String mappingName) Constructs a combo box form field with specified name, alternate name, and mapping name.
PdfFormComboBox(String name, String alternateName, String mappingName, Color borderColor, Color backgroundColor) Constructs a combo box form field with specified name, alternate name, mapping name, border color, and background color.
PdfFormComboBox(String name, String alternateName, String mappingName, int fieldFlags) Constructs a combo box form field with specified name, alternate name, mapping name, and flags.
PdfFormComboBox(String name, String alternateName, String mappingName, int fieldFlags, Color borderColor, Color backgroundColor) Constructs a combo box form field with specified name, alternate name, mapping name, flags, border color, and background color.

Method Summary

Modifier and Type	Method and Description
void	addItem(String item) Adds a new option with specified value to this list box/combo box form field.
void	addItem(String item, boolean keepSelected) Adds a new option with specified value and selection state to this list box/combo box form field.
void	addItem(String item, String exportValue) Adds a new option with specified value and export value to this list box/combo box form field.
void	addItem(String item, String exportValue, boolean keepSelected) Adds a new option with specified value, export value and selection state to this list box/combo box form field.
Object	clone()
int	getAlignment() Returns how values of the options in the combo box/list box are aligned.
List	getDisplayValues() Returns display values of all options in the combo box/list box form field.
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.
List	getExportValues() Returns export values of all options in the combo box/list box form 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).
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).
String	getValue() Returns value of selected option in the combo box/list box form field.
boolean	isAutoAdjustTextHeight() Returns whether the viewer application will adjust the font size to accommodate the entire value of the options in the combo box/list box form field.
boolean	isCommitOnSelectionChange() Returns whether actions associated with the combo box/list box are set to be executed immediately when an option is selected.
boolean	isEditable() Returns whether the FLAG_EDITABLE flag has been set for the combo box.
boolean	isMultiselect() Returns whether multiple options can be selected in the combo box/list box form field.
void	removeItem(int index) Deletes option with specified ordinal from the combo box/list box.
void	removeItem(String item) Deletes option with specified value from the combo box/list box.
void	setAlignment(int alignment) Specifies how values of the options in the combo box/list box need to be aligned.
void	setAutoAdjustTextHeight(boolean autoAdjustFieldTextHeight) Specifies whether the size of text inside the field needs to be adjusted by the viewer application so that the text is fully accommodated inside the field without any cropping.
void	setCommitOnSelectionChange(boolean commitOnSelectionChange) Specifies whether actions associated with the combo box/list box need to be executed immediately when an option is selected.
void	setDownAppearance(PdfAppearanceStream downAppearance) Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.
void	setEditable(boolean editable) Specifies whether the FLAG_EDITABLE flag needs to be set for the combo box.
void	setNormalAppearance(PdfAppearanceStream normalAppearance) Specifies the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).
void	setRolloverAppearance(PdfAppearanceStream rolloverAppearance) Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field (and does not hold down the mouse button).
void	setValue(String value) Sets specified value as the selected option.

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, getFieldFlags, getFont, getFullyQualifiedName, getMappingName, getName, getPopup, getRadioGroupSelectedIndices, getRadioGroupSelectedValues, getRotation, getType, isFlattened, isNameAsUnicode, isNoExport, isNoSpellCheck, isRadioInUnison, isRadioNoToggleToOff, isReadOnly, isRequired, setAlternateName, setBackgroundColor, setBorderColor, setDefaultValue, setFieldFlags, setFont, setIncludeNoValueFieldsOnSubmit, setMappingName, setName, setNameAsUnicode, setNoExport, setNoSpellCheck, setParentAsNull, setPopup, setRadioInUnison, setRadioNoToggleToOff, setReadOnly, setRequired, setRotation, setSubmitActionType, setType

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

FLAG_EDITABLE

public static final int FLAG_EDITABLE

Flag for specifying that viewer applications can allow the user to enter a new option not already listed for a specific combo box.

See Also:

Constant Field Values

Constructor Detail

PdfFormComboBox

public PdfFormComboBox(String name,
                       int fieldFlags)

Constructs a combo box form field with specified name and flags.

Parameters:

name - name of the list box in the document

fieldFlags - form field flags

See Also:

PdfFormField

PdfFormComboBox

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

Constructs a combo box form field with specified name, alternate name, mapping name, and flags.

Parameters:

name - name of the combo box in the document

alternateName - alternate name of the combo box in the document

mappingName - mapping name of the combo box in the document

fieldFlags - form field flags

See Also:

PdfFormField

PdfFormComboBox

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

Constructs a combo box form field with specified name, alternate name, and mapping name.

Parameters:

name - name of the combo box in the document

alternateName - alternate name of the combo box in the document

mappingName - mapping name of the combo box in the document

See Also:

PdfFormField

PdfFormComboBox

public PdfFormComboBox(String name)

Constructs a combo box form field with specified name.

Parameters:

name - name of the combo box in the document

PdfFormComboBox

public PdfFormComboBox(PdfRect rect)

Constructs a combo box form field with specified bounding box. This field cannot be used unless a name is specified for it.

Parameters:

rect - bounding box of the combo box

See Also:

PdfFormField

PdfFormComboBox

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

Constructs a combo box form field with specified bounding box, name, and flags.

Parameters:

r - bounding box of the combo box

name - name of the combo box in the document

fieldFlags - form field flags

See Also:

PdfFormField

PdfFormComboBox

public PdfFormComboBox(PdfRect r,
                       String name)

Constructs a combo box form field with specified bounding box and name.

Parameters:

r - bounding box of the combo box

name - name of the combo box in the document

See Also:

PdfFormField

PdfFormComboBox

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

Constructs a combo box form field with specified bounding box, name, alternate name, mapping name, and flags.

Parameters:

r - bounding box of the combo box

name - name of the combo box in the document

alternateName - alternate name of the combo box in the document

mappingName - mapping name of the combo box in the document

fieldFlags - form field flags

See Also:

PdfFormField

PdfFormComboBox

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

Constructs a combo box form field with specified bounding box, name, alternate name, and mapping name.

Parameters:

r - bounding box of the combo box

name - name of the combo box in the document

alternateName - alternate name of the combo box in the document

mappingName - mapping name of the combo box in the document

See Also:

PdfFormField

PdfFormComboBox

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

Constructs a combo box form field with specified name, flags, border color, and background color.

Parameters:

name - name of the combo box in the document

fieldFlags - form field flags

borderColor - border color of the combo box

backgroundColor - background color of the combo box

See Also:

PdfFormField

PdfFormComboBox

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

Constructs a combo box form field with specified name, alternate name, mapping name, flags, border color, and background color.

Parameters:

name - name of the combo box in the document

alternateName - alternate name of the combo box in the document

mappingName - mapping name of the combo box in the document

fieldFlags - form field flags

borderColor - border color of the combo box

backgroundColor - background color of the combo box

See Also:

PdfFormField

PdfFormComboBox

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

Constructs a combo box form field with specified name, alternate name, mapping name, border color, and background color.

Parameters:

name - name of the combo box in the document

alternateName - alternate name of the combo box in the document

mappingName - mapping name of the combo box in the document

borderColor - border color of the combo box

backgroundColor - background color of the combo box

See Also:

PdfFormField

PdfFormComboBox

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

Constructs a combo box form field with specified name, border color, and background color.

Parameters:

name - name of the combo box in the document

borderColor - border color of the combo box

backgroundColor - background color of the combo box

See Also:

PdfFormField

PdfFormComboBox

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

Constructs a combo box form field with specified bounding box, name, flags, border color, and background color.

Parameters:

r - bounding box of the combo box

name - name of the combo box in the document

fieldFlags - form field flags

borderColor - border color of the combo box

backgroundColor - background color of the combo box

See Also:

PdfFormField

PdfFormComboBox

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

Constructs a combo box form field with specified bounding box, name, border color, and background color.

Parameters:

r - bounding box of the combo box

name - name of the combo box in the document

borderColor - border color of the combo box

backgroundColor - background color of the combo box

See Also:

PdfFormField

PdfFormComboBox

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

Constructs a combo box form field with specified bounding box, name, alternate name, mapping name, flags, border color, and background color.

Parameters:

r - bounding box of the combo box

name - name of the combo box in the document

alternateName - alternate name of the combo box in the document

mappingName - mapping name of the combo box in the document

fieldFlags - form field flags

borderColor - border color of the combo box

backgroundColor - background color of the combo box

See Also:

PdfFormField

PdfFormComboBox

public PdfFormComboBox(PdfRect r,
                       String name,
                       String alternateName,
                       String mappingName,
                       Color borderColor,
                       Color backgroundColor)

Constructs a combo box form field with specified bounding box, name, alternate name, mapping name, border color, and background color.

Parameters:

r - bounding box of the combo box

name - name of the combo box in the document

alternateName - alternate name of the combo box in the document

mappingName - alternate name of the combo box in the document

borderColor - border color of the combo box

backgroundColor - background color of the combo box

See Also:

PdfFormField

Method Detail

clone

public Object clone()

isEditable

public boolean isEditable()

Returns whether the FLAG_EDITABLE flag has been set for the combo box.

Returns:

whether the FLAG_EDITABLE flag has been set

See Also:

setEditable(boolean)

setEditable

public void setEditable(boolean editable)

Specifies whether the FLAG_EDITABLE flag needs to be set for the combo box.

Parameters:

editable - whether the FLAG_EDITABLE flag needs to be set

See Also:

isEditable()

isAutoAdjustTextHeight

public boolean isAutoAdjustTextHeight()

Returns whether the viewer application will adjust the font size to accommodate the entire value of the options in the combo box/list box form field.

Returns:

whether the viewer application will adjust the font size to accommodate the entire value of the options in the combo box/list box form field

See Also:

setAutoAdjustTextHeight(boolean)

setAutoAdjustTextHeight

public void setAutoAdjustTextHeight(boolean autoAdjustFieldTextHeight)

Specifies whether the size of text inside the field needs to be adjusted by the viewer application so that the text is fully accommodated inside the field without any cropping.

Parameters:

autoAdjustFieldTextHeight - whether the size of text inside text box, list box and combo box form fields needs to be adjusted

getAlignment

public int getAlignment()

Returns how values of the options in the combo box/list box are aligned.

Returns:

constant specifying the alignment

See Also:

setAlignment(int)

setAlignment

public void setAlignment(int alignment)

Specifies how values of the options in the combo box/list box need to be aligned.

Parameters:

alignment - constant specifying the alignment

See Also:

getAlignment()

removeItem

public void removeItem(String item)

Deletes option with specified value from the combo box/list box.

Parameters:

item - value of the option that needs to be deleted

removeItem

public void removeItem(int index)

Deletes option with specified ordinal from the combo box/list box.

Parameters:

index - ordinal of the option that needs to be deleted

addItem

public void addItem(String item)

Adds a new option with specified value to this list box/combo box form field.

Parameters:

item - displayed value of the new option that needs to be added

addItem

public void addItem(String item,
                    String exportValue)

Adds a new option with specified value and export value to this list box/combo box form field. Export value will be the value that will be submitted by viewer application for this list box/combo box. Display value will be the value that is displyed in the list box by viewer applications.

Parameters:

item - display value of the new option that needs to be added

exportValue - export value of the new option that needs to be added

addItem

public void addItem(String item,
                    boolean keepSelected)

Adds a new option with specified value and selection state to this list box/combo box form field.

Parameters:

item - display value of the new option that needs to be added

keepSelected - whether the option needs to be selected

addItem

public void addItem(String item,
                    String exportValue,
                    boolean keepSelected)

Adds a new option with specified value, export value and selection state to this list box/combo box form field. Export value will be the value that will be submitted by viewer application for this list box/combo box. Display value will be the value that is displyed in the list box by viewer applications.

Parameters:

item - display value of the new option that needs to be added

exportValue - export value of the new option that needs to be added

keepSelected - whether the option needs to be selected

isMultiselect

public boolean isMultiselect()

Returns whether multiple options can be selected in the combo box/list box form field.

Returns:

whether multiple options can be selected in the combo box/list box form field

See Also:

setMultiselect(boolean)

isCommitOnSelectionChange

public boolean isCommitOnSelectionChange()

Returns whether actions associated with the combo box/list box are set to be executed immediately when an option is selected.

Returns:

whether actions associated with the combo box/list box are set to be executed immediately when an option is selected

See Also:

setCommitOnSelectionChange(boolean)

setCommitOnSelectionChange

public void setCommitOnSelectionChange(boolean commitOnSelectionChange)

Specifies whether actions associated with the combo box/list box need to be executed immediately when an option is selected.

Parameters:

commitOnSelectionChange - whether actions associated with the combo box/list box need to be executed immediately when an option is selected

See Also:

isCommitOnSelectionChange()

setValue

public void setValue(String value)

Sets specified value as the selected option.

Overrides:

setValue in class PdfFormField

Parameters:

value - value that needs to be set as the selected option

See Also:

getValue()

getValue

public String getValue()

Returns value of selected option in the combo box/list box form field. If multiple options can be selected, then the method returns value of the first option.

Overrides:

getValue in class PdfFormField

Returns:

value of selected option in the combo box/list box form field

See Also:

setValue(String)

getDisplayValues

public List getDisplayValues()

Returns display values of all options in the combo box/list box form field.

Returns:

list containing display values of all options in the combo box/list box form field

See Also:

getExportValues()

getExportValues

public List getExportValues()

Returns export values of all options in the combo box/list box form field.

Returns:

export values of all options in the combo box/list box form field

See Also:

getDisplayValues()

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.

Returns:

appearance that needs to be displayed

See Also:

getNormalAppearance(), getDownAppearance(), setNormalAppearance(PdfAppearanceStream), setRolloverAppearance(PdfAppearanceStream), setDownAppearance(PdfAppearanceStream)

setDownAppearance

public void setDownAppearance(PdfAppearanceStream downAppearance)

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

See Also:

getNormalAppearance(), getDownAppearance(), getRolloverAppearance(), setNormalAppearance(PdfAppearanceStream), setRolloverAppearance(PdfAppearanceStream)

getNormalAppearance

public PdfAppearanceStream getNormalAppearance()

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

See Also:

getDownAppearance(), getRolloverAppearance(), setNormalAppearance(PdfAppearanceStream), setDownAppearance(PdfAppearanceStream), setRolloverAppearance(PdfAppearanceStream)

setNormalAppearance

public void setNormalAppearance(PdfAppearanceStream normalAppearance)

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

Parameters:

normalAppearance - the specified appearance stream

See Also:

setDownAppearance(PdfAppearanceStream), setRolloverAppearance(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)

setRolloverAppearance

public void setRolloverAppearance(PdfAppearanceStream rolloverAppearance)

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

Parameters:

rolloverAppearance - the specified appearance stream

See Also:

setNormalAppearance(PdfAppearanceStream), setDownAppearance(PdfAppearanceStream), getNormalAppearance(), getDownAppearance(), getRolloverAppearance()