com.cete.dynamicpdf.pageelements.forms
Class ChoiceField

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

Direct Known Subclasses:

ComboBox, ListBox

public abstract class ChoiceField
extends FormElement

Represents the choice field of a interactive forms. A base class for all form field of type choice form field.

A choice field contains several text items, one or more of which may be selected as the field value.

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

Constructor Summary

protected

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

Method Summary

Font	getFont() Gets the font of the field.
float	getFontSize() Gets the font size of the field.
ChoiceItemList	getItems() Gets the list of items for the "ChoiceField.
boolean	isNoExport() Gets the export state of a choice field.
void	setFont(Font font) Sets the font for the field.
void	setFontSize(float fontSize) Sets the font size for the field.
void	setNoExport(boolean value) Sets the export state of a choice field.

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

draw, 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

ChoiceField

protected ChoiceField(java.lang.String name,
                      float x,
                      float y,
                      float width,
                      float height)

Creates a new instance of ChoiceField class.

Parameters:

name - Name of a choice field.

x - X coordinate of a choice field.

y - Y coordinate of a choice field.

width - Width of a choice field.

height - Height of a choice field.

Method Detail

setFont

public void setFont(Font font)

Sets the font for the field.

Parameters:

font - the font for the field.

getFont

public Font getFont()

Gets the font of the field.

Returns:

the font of the field.

setFontSize

public void setFontSize(float fontSize)

Sets the font size for the field.

Parameters:

fontSize - the font size for the field.

getFontSize

public float getFontSize()

Gets the font size of the field.

Returns:

the font size of the field.

isNoExport

public boolean isNoExport()

Gets the export state of a choice field.

Returns:

the export state of a choice field.

setNoExport

public void setNoExport(boolean value)

Sets the export state of a choice field.

If set, the field will not be exported by a submit-form action.

Parameters:

value - the export state of a choice field.

getItems

public ChoiceItemList getItems()

Gets the list of items for the "ChoiceField.

Returns:

the list.