org.odftoolkit.simple.form

Class Button

java.lang.Object

org.odftoolkit.simple.Component

org.odftoolkit.simple.form.FormControl

org.odftoolkit.simple.form.Button

public class Button
extends FormControl

This class represents the form control of Button, provides methods to get/set the form properties and the style formatting of this control.

Since:

0.8

Field Summary

Fields inherited from class org.odftoolkit.simple.form.FormControl

drawingShape, formElement, mElement, mFormProperties

Method Summary

Modifier and Type	Method and Description
String	getId() Get the control id.
static Button	getInstanceOf(FormButtonElement element) Get an instance of button by an instance of FormButtonElement, while searching the document content to make a bind with the DrawControl which already reference to this button.
String	getLabel() Get the label content of this button
String	getName() Get the control name.
static Iterator<FormControl>	getSimpleIterator(Form container) Get a simple iterator for buttons.
void	setControlImplementation(String controlImpl) Set the implementation of this control.
void	setId(String id) Set the control id.
void	setLabel(String label) Set the label content of this button
void	setName(String name) Set the control name.
void	setValue(String value) Set the default value of this control, it will be override by current value.

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

getInstanceOf

public static Button getInstanceOf(FormButtonElement element)

Get an instance of button by an instance of FormButtonElement, while searching the document content to make a bind with the DrawControl which already reference to this button.

Parameters:

element - - an instance of FormButtonElement

Returns:

an instance of button

setControlImplementation

public void setControlImplementation(String controlImpl)

Description copied from class: FormControl

Set the implementation of this control.

Specified by:

setControlImplementation in class FormControl

Parameters:

controlImpl - - the implementation description of this control

setId

public void setId(String id)

Description copied from class: FormControl

Set the control id.

Specified by:

setId in class FormControl

Parameters:

id - -the control id.

getId

public String getId()

Description copied from class: FormControl

Get the control id.

Specified by:

getId in class FormControl

Returns:

the control id.

getName

public String getName()

Description copied from class: FormControl

Get the control name.

Specified by:

getName in class FormControl

Returns:

the control name.

setName

public void setName(String name)

Description copied from class: FormControl

Set the control name.

Specified by:

setName in class FormControl

Parameters:

name - - the control name.

setLabel

public void setLabel(String label)

Set the label content of this button

Parameters:

label - - the label

getLabel

public String getLabel()

Get the label content of this button

Returns:

the label

setValue

public void setValue(String value)

Set the default value of this control, it will be override by current value.

Parameters:

value - - the default value

getSimpleIterator

public static Iterator<FormControl> getSimpleIterator(Form container)

Get a simple iterator for buttons.

Parameters:

container - - an instance of form where to traverse the buttons