|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.odftoolkit.simple.Component
org.odftoolkit.simple.form.FormControl
org.odftoolkit.simple.form.ListBox
public class ListBox
This class represents the form control of List Box, provides methods to get/set the form properties and the style formatting of this control.
Field Summary |
---|
Fields inherited from class org.odftoolkit.simple.form.FormControl |
---|
drawingShape, formElement, mElement, mFormProperties |
Method Summary | |
---|---|
void |
addItem(String item)
Add a list item to this list box. |
void |
addItems(String[] items)
Add a group of list items to this list box |
String |
getDataField()
Get the data field referenced by this combo box |
ArrayList<String> |
getEntries()
Get the list entries if they are initiated through a list of string. |
boolean |
getFormDropdown()
Get the visibility of the drop-down list |
boolean |
getFormMultiSelection()
Get if the list box support multi-selection |
String |
getId()
Get the control id. |
static ListBox |
getInstanceOf(FormListboxElement element)
Get an instance of list box by an instance of FormListboxElement, while searching the document content to make a bind with the DrawControl which already reference to this list box. |
String |
getListSource()
Get the source of this data list. |
FormTypeDefinition.FormListSourceType |
getListSourceType()
Get the source type of the data list. |
String |
getName()
Get the control name. |
static Iterator<FormControl> |
getSimpleIterator(Form container)
Get a simple iterator for list boxes. |
void |
setControlImplementation(String controlImpl)
Set the implementation of this control. |
void |
setDataField(String dataField)
Set the data field referenced by this combo box |
void |
setFormDropdown(boolean isDropDown)
Set the visibility of the drop-down list |
void |
setFormMultiSelection(boolean isMultiSelection)
Set if the list box support multi-selection |
void |
setId(String id)
Set the control id. |
void |
setListSource(String listSource)
Set the source of this data list. |
void |
setListSourceType(FormTypeDefinition.FormListSourceType type)
Set the source type of the data list. |
void |
setName(String name)
Set the control name. |
Methods inherited from class org.odftoolkit.simple.form.FormControl |
---|
getDrawControl, getOdfElement, getRectangle, remove, setAnchorType, setFormProperty, setRectangle |
Methods inherited from class org.odftoolkit.simple.Component |
---|
getComponentByElement, getOwnerDocument, registerComponent, unregisterComponent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static ListBox getInstanceOf(FormListboxElement element)
element
- - an instance of FormComboboxElement
public void setControlImplementation(String controlImpl)
FormControl
setControlImplementation
in class FormControl
controlImpl
- - the implementation description of this controlpublic String getId()
FormControl
getId
in class FormControl
public void setId(String id)
FormControl
setId
in class FormControl
id
- -the control id.public String getName()
FormControl
getName
in class FormControl
public void setName(String name)
FormControl
setName
in class FormControl
name
- - the control name.public void setFormMultiSelection(boolean isMultiSelection)
isMultiSelection
- - specify if the list box supports multi-selectionpublic boolean getFormMultiSelection()
public void setFormDropdown(boolean isDropDown)
isDropDown
- - specify if the drop-down list is visiblepublic boolean getFormDropdown()
public void addItem(String item)
item
- - a list itempublic ArrayList<String> getEntries()
public void addItems(String[] items)
items
- -a group of list itemspublic void setListSourceType(FormTypeDefinition.FormListSourceType type)
type
- - the source type of this listpublic FormTypeDefinition.FormListSourceType getListSourceType()
public void setListSource(String listSource)
listSource
- - the source of this data list.public String getListSource()
public void setDataField(String dataField)
dataField
- - the data field referenced by this combo boxpublic String getDataField()
public static Iterator<FormControl> getSimpleIterator(Form container)
container
- - an instance of form where to traverse the list boxes
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |