org.odftoolkit.simple.form
Class TextBox

java.lang.Object
  extended by org.odftoolkit.simple.Component
      extended by org.odftoolkit.simple.form.FormControl
          extended by org.odftoolkit.simple.form.TextBox

public class TextBox
extends FormControl

This class represents the form control of Text Box, 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
 String getCurrentValue()
          Get the current value of this control
 String getId()
          Get the control id.
static TextBox getInstanceOf(OdfElement element)
          Get an instance of text box by an instance of OdfElement, while searching the document content to make a bind with the DrawControl which already reference to this text box.
 String getName()
          Get the control name.
static Iterator<FormControl> getSimpleIterator(Form container)
          Get a simple iterator for text boxes.
 String getValue()
          Get the default value of this control
 void setControlImplementation(String controlImpl)
          Set the implementation of this control.
 void setCurrentValue(String currentValue)
          Set the current value of this control, it override the default value.
 void setId(String id)
          Set the control id.
 void setName(String name)
          Set the control name.
 void setValue(String defaultValue)
          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 TextBox getInstanceOf(OdfElement element)
Get an instance of text box by an instance of OdfElement, while searching the document content to make a bind with the DrawControl which already reference to this text box.

Parameters:
element - - an instance of OdfElement
Returns:
an instance of text box

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

getId

public String getId()
Description copied from class: FormControl
Get the control id.

Specified by:
getId in class FormControl
Returns:
the control id.

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.

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.

setValue

public void setValue(String defaultValue)
Set the default value of this control, it will be override by current value.

Parameters:
value - - default value

getValue

public String getValue()
Get the default value of this control

Returns:
default value

setCurrentValue

public void setCurrentValue(String currentValue)
Set the current value of this control, it override the default value.

Parameters:
currentValue - - current value

getCurrentValue

public String getCurrentValue()
Get the current value of this control

Returns:
current value

getSimpleIterator

public static Iterator<FormControl> getSimpleIterator(Form container)
Get a simple iterator for text boxes.

Parameters:
container - - an instance of form where to traverse the text boxes


Copyright © 2010-2017 The Apache Software Foundation. All Rights Reserved.