Class ControlReader
This class reads a form control in an OOo document (a form:control node). A control always has an owner form. Properties and events are ignored.
-
Constructor Summary
ConstructorsConstructorDescriptionControlReader
(Element control, FormReader ownerForm) The constructor reads the content of a control element -
Method Summary
Modifier and TypeMethodDescriptiongetAttribute
(String sName) Get an attribute of the control.The type of the control is identified by a name, eg. form:submitgetId()
A control in OOo is identified by id (form:control-id
attribute.getItemAttribute
(int nIndex, String sName) Get an attribute of an option/item.int
Return the number of options/items in this control.getItemValue
(int nIndex) Get the value of an option/item.A control in OOo belongs to a form.getTypeAttribute
(String sName) Get an attribute specific to this type of control.
-
Constructor Details
-
ControlReader
The constructor reads the content of a control element
The representation in OpenDocument differs slightly from OOo 1.x.- Parameters:
control
- a DOM element, which must be control node
-
-
Method Details
-
getId
A control in OOo is identified by id (
form:control-id
attribute. The id is accessed by this method.- Returns:
- the id of the control
-
getOwnerForm
A control in OOo belongs to a form.
- Returns:
- the form containing this control
-
getAttribute
Get an attribute of the control. If the attribute does not exist, this method returns
null
.- Parameters:
sName
- the name of the attribute- Returns:
- the value of the attribute, or
null
-
getControlType
The type of the control is identified by a name, eg. form:submit
- Returns:
- the type of this control
-
getTypeAttribute
Get an attribute specific to this type of control. If the attribute does not exist, this method returns
null
.- Parameters:
sName
- the name of the attribute- Returns:
- the value of the attribute, or
null
-
getItemCount
public int getItemCount()Return the number of options/items in this control. Only listbox (options) and combobox (items) controls can have these, for other controls this will return 0.
- Returns:
- the number of options/items
-
getItemAttribute
Get an attribute of an option/item. If the index and/or the attribute does not exist, this method returns
null
.- Parameters:
nIndex
- the index of the option/itemsName
- the name of the attribute- Returns:
- the value of the attribute, or
null
-
getItemValue
Get the value of an option/item. If the index does not exist, this method returns
null
.- Parameters:
nIndex
- the index of the option/item- Returns:
- the value of the option/item, or
null
-