|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Form
This class represents form object. It provides method to get/set form properties, content, layout and styles. A form is a container to hold controls like buttons, combo boxes, labels, fields, check boxes, radio buttons, text boxes, list boxes and etc.
Method Summary | |
---|---|
FormControl |
createButton(ControlContainer parent,
FrameRectangle rectangle,
String name,
String label)
Create a button control in this form. |
FormControl |
createCheckBox(ControlContainer parent,
FrameRectangle rectangle,
String name,
String label,
String value)
Create a check box in this form. |
FormControl |
createComboBox(ControlContainer parent,
FrameRectangle rectangle,
String name,
String defaultText,
boolean isDropDown)
Create a combo box in this form. |
FormControl |
createCurrencyField(ControlContainer parent,
FrameRectangle rectangle,
String name,
String defaultValue)
Create a currency field in this form. |
FormControl |
createDateField(ControlContainer parent,
FrameRectangle rectangle,
String name,
String defaultValue)
Create a date field in this form. |
FormControl |
createLabel(ControlContainer parent,
FrameRectangle rectangle,
String name,
String text)
Create a label control in this form. |
FormControl |
createListBox(ControlContainer parent,
FrameRectangle rectangle,
String name,
boolean isMultiSelection,
boolean isDropDown)
Create a list box in this form. |
FormControl |
createNumericField(ControlContainer parent,
FrameRectangle rectangle,
String name,
String defaultValue)
Create a numeric field in this form. |
FormControl |
createPatternField(ControlContainer parent,
FrameRectangle rectangle,
String name,
String defaultValue)
Create a pattern field in this form. |
FormControl |
createRadioButton(ControlContainer parent,
FrameRectangle rectangle,
String name,
String label,
String value)
Create a radio button in this form. |
FormControl |
createTextBox(ControlContainer parent,
FrameRectangle rectangle,
String name,
String defaultText,
boolean isMultipleLine)
Create a textbox in this form. |
FormControl |
createTimeField(ControlContainer parent,
FrameRectangle rectangle,
String name,
String defaultValue)
Create a time field in this form. |
String |
getCommand()
Get the command to execute on a data source |
FormTypeDefinition.FormCommandType |
getCommandType()
Get the type of command to execute on a data source |
String |
getControlImplementation()
Get the implementation of the created control |
String |
getDataSource()
Get the name of data source |
String |
getFormName()
Get the form name |
FormFormElement |
getOdfElement()
Get the instance of FormFormElemnt element. |
void |
setCommand(String command)
Set a command to execute on a data source |
void |
setCommandType(FormTypeDefinition.FormCommandType commandType)
Set the type of command to execute on a data source. |
void |
setControlImplementation(String controlImpl)
Set the implementation of the created control |
void |
setDataSource(String dataSource)
Set the data source to be used by the form |
void |
setFormName(String name)
Set the name of this form |
Method Detail |
---|
FormControl createButton(ControlContainer parent, FrameRectangle rectangle, String name, String label)
parent
- - the element that contains this form controlrectangle
- - the bounding rectangle used by this buttonname
- - the name of the controllabel
- - the text label of the button
FormControl createLabel(ControlContainer parent, FrameRectangle rectangle, String name, String text)
parent
- - the element that contains this form controlrectangle
- - the bounding rectangle used by this buttonname
- - the name of the controltext
- -default text of the label
FormControl createTextBox(ControlContainer parent, FrameRectangle rectangle, String name, String defaultText, boolean isMultipleLine)
parent
- - the element that contains this form controlrectangle
- - the bounding rectangle used by this buttonname
- - the name of the controldefaultText
- -default text of the textboxisMultipleLine
- - if this textbox supports multiple lines input
FormControl createListBox(ControlContainer parent, FrameRectangle rectangle, String name, boolean isMultiSelection, boolean isDropDown)
parent
- - the element that contains this form controlrectangle
- - the bounding rectangle used by this buttonname
- - the name of the controlisMultiSelection
- - support multi-selection or notisDropDown
- - the drop-down list is visible or not
FormControl createComboBox(ControlContainer parent, FrameRectangle rectangle, String name, String defaultText, boolean isDropDown)
parent
- - the element that contains this form controlrectangle
- - the bounding rectangle used by this buttonname
- - the name of the controldefaultText
- - the default text of comboboxisDropDown
- - the drop-down list is visible or not
FormControl createRadioButton(ControlContainer parent, FrameRectangle rectangle, String name, String label, String value)
parent
- - the element that contains this form controlrectangle
- - the bounding rectangle used by this buttonname
- - the name of the controllabel
- - the label of this radio buttonvalue
- - the value assign to this option
FormControl createCheckBox(ControlContainer parent, FrameRectangle rectangle, String name, String label, String value)
parent
- - the element that contains this form controlrectangle
- - the bounding rectangle used by this buttonname
- - the name of the controllabel
- - the label of this check boxvalue
- - the value assign to this option
FormControl createDateField(ControlContainer parent, FrameRectangle rectangle, String name, String defaultValue)
parent
- - the element that contains this form controlrectangle
- - the bounding rectangle used by this buttonname
- - the name of the controldefaultValue
- - the default value of this input field
FormControl createTimeField(ControlContainer parent, FrameRectangle rectangle, String name, String defaultValue)
parent
- - the element that contains this form controlrectangle
- - the bounding rectangle used by this buttonname
- - the name of the controldefaultValue
- - the default value of this input field
FormControl createNumericField(ControlContainer parent, FrameRectangle rectangle, String name, String defaultValue)
parent
- - the element that contains this form controlrectangle
- - the bounding rectangle used by this buttonname
- - the name of the controldefaultValue
- - the default value of this input field
FormControl createPatternField(ControlContainer parent, FrameRectangle rectangle, String name, String defaultValue)
parent
- - the element that contains this form controlrectangle
- - the bounding rectangle used by this buttonname
- - the name of the controldefaultValue
- - the default value of this input field
FormControl createCurrencyField(ControlContainer parent, FrameRectangle rectangle, String name, String defaultValue)
parent
- - the element that contains this form controlrectangle
- - the bounding rectangle used by this buttonname
- - the name of the controldefaultValue
- - the default value of this input field
void setFormName(String name)
name
- - the form nameString getFormName()
void setControlImplementation(String controlImpl)
controlImpl
- - implementation of controlString getControlImplementation()
void setDataSource(String dataSource)
dataSource
- - name of data sourceString getDataSource()
void setCommandType(FormTypeDefinition.FormCommandType commandType)
commandType
- the command typeFormTypeDefinition.FormCommandType getCommandType()
void setCommand(String command)
command
- String getCommand()
FormFormElement getOdfElement()
FormFormElemnt
element.
FormFormElemnt
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |