|
Oracle UIX API Reference Release 2.1.22.0.0 B12196-01 |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
|
+--oracle.cabo.ui.DeprecatedUINode
|
+--oracle.cabo.ui.BaseUINode
|
+--oracle.cabo.ui.BaseMutableUINode
|
+--oracle.cabo.ui.beans.BaseWebBean
|
+--oracle.cabo.ui.beans.MarlinBean
|
+--oracle.cabo.ui.beans.form.FormElementBean
|
+--oracle.cabo.ui.beans.form.TextInputBean
User interface single- and multi-line text controls, including password fields.
The textinput control creates a browser input text widget. Depending on the numer of rows, this control either maps to a textfield (for single row controls) or textarea (for multiple row text controls). If the input should be hidden from the user while displayed, such as for passwords, the secret property should be used.
Text will be entered in numeric format (right aligned for most locales) if a DecimalValidater is attached.
Simple text input box with the some default text.
<form name="myform" method="GET">
<contents>
<textInput text="Some text " name="textbtn1"/>
</contents>
</form>A slightly more interesting example showing a text box twenty five characters in length with hidden input text.
<form name="myform" method="GET">
<contents>
<textInput name="SecretTextVar"
columns="25"
required="no"
secret="true"
text="secret text:"/>
</contents>
</form>A text input box which will display three rows of wrapped input text, with a vertical scrollbar. If the text is changed, an alert will say so.
<form name="myform" method="GET">
<contents>
<textInput name="ChangeNotifiedTextBox"
rows="3"
wrap="soft"
onChange="alert('ChangeNotifiedTextBox has changed.')"
text="Alert on change."/>
</contents>
</form>A text input, the contents of which will be in numeric format (right aligned for most locales). The validater ensures the contents is a number as user leaves box.
<form name="myform" method="GET">
<contents>
<textInput name="numeric format" required="yes">
<onBlurValidater>
<decimal/>
</onBlurValidater>
<contents/>
</textInput>
</contents>
</form>
It does not support any children.
| Constructor Summary | |
|
TextInputBean()
Construct an instance of the TextInputBean. |
protected |
TextInputBean(boolean ignored,
java.lang.String localName)
Construct an instance of the TextInputBean. |
|
TextInputBean(java.lang.String name)
Construct an instance of the TextInputBean. |
|
TextInputBean(java.lang.String name,
java.lang.String text)
Construct an instance of the TextInputBean. |
|
TextInputBean(java.lang.String name,
java.lang.String text,
int columns,
int rows)
Construct an instance of the TextInputBean. |
| Method Summary | |
int |
getColumns()
Gets the number of columns to display in the text control. |
static int |
getColumns(MutableUINode bean)
Gets the number of columns to display in the text control. |
int |
getMaximumLength()
Gets the maximum number of characters per line that can be entered into the text control. |
static int |
getMaximumLength(MutableUINode bean)
Gets the maximum number of characters per line that can be entered into the text control. |
ClientValidater |
getOnBlurValidater()
Gets ClientValidater to fire on the client whenever the TextInputBean loses keyboard focus. |
static ClientValidater |
getOnBlurValidater(MutableUINode bean)
Gets ClientValidater to fire on the client whenever the TextInputBean loses keyboard focus. |
java.lang.String |
getOnChange()
Gets event handler for when the value is changed. |
static java.lang.String |
getOnChange(MutableUINode bean)
Gets event handler for when the value is changed. |
java.lang.String |
getOnSelect()
Gets event handler for when text becomes selected. |
static java.lang.String |
getOnSelect(MutableUINode bean)
Gets event handler for when text becomes selected. |
ClientValidater |
getOnSubmitValidater()
Gets ClientValidater to fire on the client whenever the form containing the TextInputBean is submitted. |
static ClientValidater |
getOnSubmitValidater(MutableUINode bean)
Gets ClientValidater to fire on the client whenever the form containing the TextInputBean is submitted. |
java.lang.String |
getRequired()
Gets whether the associated control requires user input. |
static java.lang.String |
getRequired(MutableUINode bean)
Gets whether the associated control requires user input. |
int |
getRows()
Gets the number of rows to display in the text control. |
static int |
getRows(MutableUINode bean)
Gets the number of rows to display in the text control. |
java.lang.String |
getText()
Gets the text value of the input field. |
static java.lang.String |
getText(MutableUINode bean)
Gets the text value of the input field. |
java.lang.String |
getWrap()
Gets the type of text wrapping to be used in a multi-row text control. |
static java.lang.String |
getWrap(MutableUINode bean)
Gets the type of text wrapping to be used in a multi-row text control. |
boolean |
isSecret()
Gets a boolean value that only applies to single line text controls. |
static boolean |
isSecret(MutableUINode bean)
Gets a boolean value that only applies to single line text controls. |
void |
setColumns(int columns)
Sets the number of columns to display in the text control. |
static void |
setColumns(MutableUINode bean,
int columns)
Sets the number of columns to display in the text control. |
void |
setMaximumLength(int maximumLength)
Sets the maximum number of characters per line that can be entered into the text control. |
static void |
setMaximumLength(MutableUINode bean,
int maximumLength)
Sets the maximum number of characters per line that can be entered into the text control. |
void |
setOnBlurValidater(ClientValidater onBlurValidater)
Sets ClientValidater to fire on the client whenever the TextInputBean loses keyboard focus. |
static void |
setOnBlurValidater(MutableUINode bean,
ClientValidater onBlurValidater)
Sets ClientValidater to fire on the client whenever the TextInputBean loses keyboard focus. |
static void |
setOnChange(MutableUINode bean,
java.lang.String onChange)
Sets event handler for when the value is changed. |
void |
setOnChange(java.lang.String onChange)
Sets event handler for when the value is changed. |
static void |
setOnSelect(MutableUINode bean,
java.lang.String onSelect)
Sets event handler for when text becomes selected. |
void |
setOnSelect(java.lang.String onSelect)
Sets event handler for when text becomes selected. |
void |
setOnSubmitValidater(ClientValidater onSubmitValidater)
Sets ClientValidater to fire on the client whenever the form containing the TextInputBean is submitted. |
static void |
setOnSubmitValidater(MutableUINode bean,
ClientValidater onSubmitValidater)
Sets ClientValidater to fire on the client whenever the form containing the TextInputBean is submitted. |
static void |
setRequired(MutableUINode bean,
java.lang.String required)
Sets whether the associated control requires user input. |
void |
setRequired(java.lang.String required)
Sets whether the associated control requires user input. |
void |
setRows(int rows)
Sets the number of rows to display in the text control. |
static void |
setRows(MutableUINode bean,
int rows)
Sets the number of rows to display in the text control. |
void |
setSecret(boolean secret)
Sets a boolean value that only applies to single line text controls. |
static void |
setSecret(MutableUINode bean,
boolean secret)
Sets a boolean value that only applies to single line text controls. |
static void |
setText(MutableUINode bean,
java.lang.String text)
Sets the text value of the input field. |
void |
setText(java.lang.String text)
Sets the text value of the input field. |
void |
setTextBinding(BoundValue boundValue)
Binds the the text value of the input field. |
static void |
setTextBinding(MutableUINode bean,
BoundValue boundValue)
Binds the the text value of the input field. |
static void |
setTextBinding(MutableUINode bean,
java.lang.Object selectKey)
Binds the the text value of the input field. |
static void |
setTextBinding(MutableUINode bean,
java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the text value of the input field. |
void |
setTextBinding(java.lang.Object selectKey)
Binds the the text value of the input field. |
void |
setTextBinding(java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the text value of the input field. |
static void |
setTranslatableText(MutableUINode bean,
java.lang.String bundleName,
java.lang.String key)
Binds to a ResourceBundle the the text value of the input field. |
void |
setTranslatableText(java.lang.String bundleName,
java.lang.String key)
Binds to a ResourceBundle the the text value of the input field. |
static void |
setWrap(MutableUINode bean,
java.lang.String wrap)
Sets the type of text wrapping to be used in a multi-row text control. |
void |
setWrap(java.lang.String wrap)
Sets the type of text wrapping to be used in a multi-row text control. |
| Methods inherited from class oracle.cabo.ui.beans.form.FormElementBean |
getName, getName, getOnBlur, getOnBlur, getOnFocus, getOnFocus, isDisabled, isDisabled, isReadOnly, isReadOnly, setDisabled, setDisabled, setName, setName, setNameBinding, setNameBinding, setNameBinding, setNameBinding, setNameBinding, setNameBinding, setOnBlur, setOnBlur, setOnFocus, setOnFocus, setReadOnly, setReadOnly |
| Methods inherited from class oracle.cabo.ui.beans.MarlinBean |
isEqualMarlinName |
| Methods inherited from class oracle.cabo.ui.BaseUINode |
getAttributeNames, getAttributeValue, getAttributeValueImpl, getChildArray, getChildNames, getIndexedChild, getIndexedChild, getIndexedChildCount, getLocalName, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getPreorderDescendentAttributeValue, getRawAttributeValue, getRenderedUINode, getRenderer, getRenderer, render, render, toString |
| Methods inherited from class oracle.cabo.ui.DeprecatedUINode |
getAttributeValue, getChildNames, getNamedChild |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface oracle.cabo.ui.UINode |
getAttributeNames, getAttributeValue, getAttributeValue, getChildNames, getChildNames, getIndexedChild, getIndexedChild, getIndexedChildCount, getLocalName, getNamedChild, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getRawAttributeValue, render, render |
| Constructor Detail |
public TextInputBean()
public TextInputBean(java.lang.String name)
name - the name used to identify the element in client-to-client or
client-to-server events.
public TextInputBean(java.lang.String name,
java.lang.String text)
name - the name used to identify the element in client-to-client or
client-to-server events.text - the text value of the input field.
public TextInputBean(java.lang.String name,
java.lang.String text,
int columns,
int rows)
name - the name used to identify the element in client-to-client or
client-to-server events.text - the text value of the input field.columns - the number of columns to display in the text
control.rows - the number of rows to display in the text control.
protected TextInputBean(boolean ignored,
java.lang.String localName)
| Method Detail |
public final ClientValidater getOnBlurValidater()
public final void setOnBlurValidater(ClientValidater onBlurValidater)
public final ClientValidater getOnSubmitValidater()
public final void setOnSubmitValidater(ClientValidater onSubmitValidater)
public final java.lang.String getText()
public final void setText(java.lang.String text)
public final void setTranslatableText(java.lang.String bundleName,
java.lang.String key)
bundleName - the name of the ResourceBundlekey - the key of the string to retrieve from the ResourceBundlepublic final void setTextBinding(BoundValue boundValue)
boundValue - a BoundValue implementation to be used
to retrieve the value.public final void setTextBinding(java.lang.Object selectKey)
selectKey - the key to be passed to selectValue() on the
current DataObject, e.g., the DataObject for the current
table row.
public final void setTextBinding(java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
dataNamespace - the namespace to be passed to
RenderingContext.getDataObject()dataName - the name to be passed to
RenderingContext.getDataObject()selectKey - the key to be passed to selectValue() on the
DataObject.public final int getRows()
public final void setRows(int rows)
public final int getColumns()
public final void setColumns(int columns)
public final int getMaximumLength()
public final void setMaximumLength(int maximumLength)
public final java.lang.String getWrap()
public final void setWrap(java.lang.String wrap)
public final boolean isSecret()
public final void setSecret(boolean secret)
public final java.lang.String getRequired()
UIConstants.REQUIRED_YESUser input in this field is required and any attached validater must succeed.
UIConstants.REQUIRED_NOEither this field is empty or any attached validater must succeed.
UIConstants.VALIDATER_ONLYAny attached validater must succeed. Thus validation success is only dependent on the validater and not whether any text has been entered into this field.
The default of this attribute is "no".
public final void setRequired(java.lang.String required)
UIConstants.REQUIRED_YESUser input in this field is required and any attached validater must succeed.
UIConstants.REQUIRED_NOEither this field is empty or any attached validater must succeed.
UIConstants.VALIDATER_ONLYAny attached validater must succeed. Thus validation success is only dependent on the validater and not whether any text has been entered into this field.
The default of this attribute is "no".
public final java.lang.String getOnChange()
public final void setOnChange(java.lang.String onChange)
public final java.lang.String getOnSelect()
public final void setOnSelect(java.lang.String onSelect)
public static ClientValidater getOnBlurValidater(MutableUINode bean)
public static void setOnBlurValidater(MutableUINode bean,
ClientValidater onBlurValidater)
public static ClientValidater getOnSubmitValidater(MutableUINode bean)
public static void setOnSubmitValidater(MutableUINode bean,
ClientValidater onSubmitValidater)
public static java.lang.String getText(MutableUINode bean)
public static void setText(MutableUINode bean,
java.lang.String text)
public static void setTranslatableText(MutableUINode bean,
java.lang.String bundleName,
java.lang.String key)
bundleName - the name of the ResourceBundlekey - the key of the string to retrieve from the ResourceBundle
public static void setTextBinding(MutableUINode bean,
BoundValue boundValue)
boundValue - a BoundValue implementation to be used
to retrieve the value.
public static void setTextBinding(MutableUINode bean,
java.lang.Object selectKey)
selectKey - the key to be passed to selectValue() on the
current DataObject, e.g., the DataObject for the current
table row.
public static void setTextBinding(MutableUINode bean,
java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
dataNamespace - the namespace to be passed to
RenderingContext.getDataObject()dataName - the name to be passed to
RenderingContext.getDataObject()selectKey - the key to be passed to selectValue() on the
DataObject.public static int getRows(MutableUINode bean)
public static void setRows(MutableUINode bean,
int rows)
public static int getColumns(MutableUINode bean)
public static void setColumns(MutableUINode bean,
int columns)
public static int getMaximumLength(MutableUINode bean)
public static void setMaximumLength(MutableUINode bean,
int maximumLength)
public static java.lang.String getWrap(MutableUINode bean)
public static void setWrap(MutableUINode bean,
java.lang.String wrap)
public static boolean isSecret(MutableUINode bean)
public static void setSecret(MutableUINode bean,
boolean secret)
public static java.lang.String getRequired(MutableUINode bean)
UIConstants.REQUIRED_YESUser input in this field is required and any attached validater must succeed.
UIConstants.REQUIRED_NOEither this field is empty or any attached validater must succeed.
UIConstants.VALIDATER_ONLYAny attached validater must succeed. Thus validation success is only dependent on the validater and not whether any text has been entered into this field.
The default of this attribute is "no".
public static void setRequired(MutableUINode bean,
java.lang.String required)
UIConstants.REQUIRED_YESUser input in this field is required and any attached validater must succeed.
UIConstants.REQUIRED_NOEither this field is empty or any attached validater must succeed.
UIConstants.VALIDATER_ONLYAny attached validater must succeed. Thus validation success is only dependent on the validater and not whether any text has been entered into this field.
The default of this attribute is "no".
public static java.lang.String getOnChange(MutableUINode bean)
public static void setOnChange(MutableUINode bean,
java.lang.String onChange)
public static java.lang.String getOnSelect(MutableUINode bean)
public static void setOnSelect(MutableUINode bean,
java.lang.String onSelect)
|
Oracle UIX API Reference Release 2.1.22.0.0 B12196-01 |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||