com.cete.dynamicpdf.pageelements.forms
Class ListBox

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

public class ListBox
extends ChoiceField

Represents the list box field of a interactive forms.

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

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

Method Summary

void	draw(PageWriter writer) Draws the list box to the given PageWriter object.
boolean	isMultiselect() Gets the multiselect flag status of list box.
void	setMultiselect(boolean value) Sets the multiselect flag status of list box.

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

ListBox

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

Creates a new instance of ListBox class.

Parameters:

name - Name of a list box.

x - X coordinate of a list box.

y - Y coordinate of a list box.

width - Width of a list box.

height - Height of a list box.

Method Detail

isMultiselect

public boolean isMultiselect()

Gets the multiselect flag status of list box.

Returns:

the multiselect flag status of list box.

setMultiselect

public void setMultiselect(boolean value)

Sets the multiselect flag status of list box.

If set, more than one of the field�s option items may be selected simultaneously; if clear, no more than one item at a time may be selected.

Parameters:

value - the multiselect flag status of list box.

draw

public void draw(PageWriter writer)

Draws the list 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 listbox's output.

See Also:

PageWriter