com.aspose.pdf

Class ListBoxField

java.lang.Object

com.aspose.pdf.BaseParagraph

com.aspose.pdf.Annotation

com.aspose.pdf.WidgetAnnotation

com.aspose.pdf.Field

com.aspose.pdf.ChoiceField

com.aspose.pdf.ListBoxField

All Implemented Interfaces:

com.aspose.ms.System.Collections.ICollection, com.aspose.ms.System.Collections.IEnumerable, Cloneable, Iterable

public final class ListBoxField
extends ChoiceField

Class represents ListBox field.

Field Summary

Fields inherited from class com.aspose.pdf.Field

_FileSelect, _Password

Fields inherited from class com.aspose.pdf.Annotation

_disableUpdateAppearance

Constructor Summary

Constructors

Constructor and Description
ListBoxField() Constructor for ListBoxField to be used in Generator.
ListBoxField(Page page, Rectangle rect) Creates new ListBox field.

Method Summary

Methods

Modifier and Type	Method and Description
int	getTopIndex() Gets index of the top visible element of the list.
void	setSelected(int value) Gets index of the selected item.
void	setSelectedItems(int[] value) Gets array of the selected items in the multiselect list.
void	setTopIndex(int value) Sets index of the top visible element of the list.

Methods inherited from class com.aspose.pdf.ChoiceField

addOption, addOption, deleteOption, getCommitImmediately, getMultiSelect, getOptions, getSelected, getSelectedItems, getValue, setCommitImmediately, setMultiSelect, setValue

Methods inherited from class com.aspose.pdf.Field

copyTo, flatten, get_Item, get_Item, getAlternateName, getAnnotationIndex, getMappingName, getPageIndex, getPartialName, getRect, getSyncRoot, isGroup, isSharedField, isSharedField, isSynchronized, iterator, recalculate, setAlternateName, setAnnotationIndex, setFieldImage, setFitIntoRectangle, setMappingName, setPartialName, setPosition, setRect, size, updateAppearances

Methods inherited from class com.aspose.pdf.WidgetAnnotation

accept, getActions, getDefaultAppearance, getExportable, getHighlighting, getOnActivated, getParent, getReadOnly, getRequired, setDefaultAppearance, setExportable, setHighlighting, setOnActivated, setReadOnly, setRequired

Methods inherited from class com.aspose.pdf.Annotation

createAnnotation, getActiveState, getAlignment, getAppearance, getBorder, getCharacteristics, getColor, getContents, getEngineDict, getEngineObj, getFlags, getFullName, getHeight, getHorizontalAlignment_Annotation_New, getModified, getModifiedInternal, getName, getNormalAppearance, getPage, getPageIndex, getStates, getWidth, initialize, setActiveState, setAlignment, setBorder, setColor, setContents, setFlags, setHeight, setHorizontalAlignment_Annotation_New, setModified, setModifiedInternal, setName, setWidth

Methods inherited from class com.aspose.pdf.BaseParagraph

deepClone, getMargin, isKeptWithNext, isKeptWithNext, setHorizontalAlignment, setMargin, setVerticalAlignment

Methods inherited from class java.lang.Object

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

Constructor Detail

ListBoxField

public ListBoxField()

Constructor for ListBoxField to be used in Generator.

Parameters:

page -

ListBoxField

public ListBoxField(Page page,
            Rectangle rect)

Creates new ListBox field.

Parameters:

page - Page where list box will be placed.

rect - Rectangle where list box will be placed on the page.

Method Detail

getTopIndex

public int getTopIndex()

Gets index of the top visible element of the list.

setTopIndex

public void setTopIndex(int value)

Sets index of the top visible element of the list.

setSelected

public void setSelected(int value)

Gets index of the selected item. Items are numbered from 1.

Overrides:

setSelected in class ChoiceField

setSelectedItems

public void setSelectedItems(int[] value)

Gets array of the selected items in the multiselect list. For single-select list returns array with single item.

Overrides:

setSelectedItems in class ChoiceField