com.cete.dynamicpdf.pageelements.forms
Class ComboBox

java.lang.Object
  com.cete.dynamicpdf.PageElement
      com.cete.dynamicpdf.pageelements.TaggablePageElement
          com.cete.dynamicpdf.pageelements.forms.FormElement
              com.cete.dynamicpdf.pageelements.forms.ChoiceField
                  com.cete.dynamicpdf.pageelements.forms.ComboBox

public class ComboBox
extends ChoiceField

Represents the combo box field of a interactive forms.

A combo box consisting of a drop list.

NOTE: This page element cannot be used within a table cell, or tranformation group.

Licensing:
This class is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Enterprise Edition

View Example

Constructor Summary

ComboBox(java.lang.String name, float x, float y, float width, float height)
Creates a new instance of ComboBox class.

Method Summary

void	draw(PageWriter writer) Draws the combo box to the given PageWriter object.
boolean	isEditable() Gets the editable state of a combo box.
boolean	isRequired() Gets the value specifying the required state of a field.
void	setEditable(boolean value) Sets the editable state of a combo box.
void	setRequired(boolean value) Sets the required state for a field.

Methods inherited from class com.cete.dynamicpdf.pageelements.forms.ChoiceField

getFont, getFontSize, getItems, isNoExport, setFont, setFontSize, setNoExport

Methods inherited from class com.cete.dynamicpdf.pageelements.forms.FormElement

getBackgroundColor, getBorderColor, getBorderStyle, getHeight, getMappingName, getName, getOutput, getReaderEvents, getRotate, getTextColor, getToolTip, getWidth, getX, getY, isPrintable, isReadOnly, isVisible, setBackgroundColor, setBorderColor, setBorderStyle, setHeight, setMappingName, setName, setOutput, setPrintable, setReadOnly, setRotate, setTag, setTextColor, setToolTip, setVisible, setWidth, setX, setY

Methods inherited from class com.cete.dynamicpdf.pageelements.TaggablePageElement

getTag, getTagOrder, setTagOrder

Methods inherited from class com.cete.dynamicpdf.PageElement

getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComboBox

public ComboBox(java.lang.String name,
                float x,
                float y,
                float width,
                float height)

Creates a new instance of ComboBox class.

Parameters:

name - Name of a combo box.

x - X coordinate of a combo box.

y - Y coordinate of a combo box.

width - Width of a combo box.

height - Height of a combo box.

Method Detail

isEditable

public boolean isEditable()

Gets the editable state of a combo box.

Returns:

the editable state of a combo box.

setEditable

public void setEditable(boolean value)

Sets the editable state of a combo box.

If set, the combo box includes an editable text box as well as a drop list; if clear, it includes only a drop list.

Parameters:

value - the editable state of a combo box.

isRequired

public boolean isRequired()

Gets the value specifying the required state of a field.

Returns:

the required state of a field.

setRequired

public void setRequired(boolean value)

Sets the required state for a field.

If set, the field must have a value at the time it is exported by a submit-form action.

Parameters:

value - the required state for a field.

draw

public void draw(PageWriter writer)

Draws the combo box to the given PageWriter object.

Overrides:

draw in class TaggablePageElement

Throws:

GeneratorException - If Form Field with the same name already exist.

Parameters:

writer - PageWriter object to receive the combo box's output.

See Also:

PageWriter