oracle.adf.view.faces.component.core.input
Class CoreInputText

java.lang.Object
  |
  +--javax.faces.component.UIComponent
        |
        +--oracle.adf.view.faces.component.UIXComponent
              |
              +--oracle.adf.view.faces.component.UIXComponentBase
                    |
                    +--oracle.adf.view.faces.component.UIXValueComponentBase
                          |
                          +--oracle.adf.view.faces.component.UIXValue
                                |
                                +--oracle.adf.view.faces.component.UIXEditableValueComponentBase
                                      |
                                      +--oracle.adf.view.faces.component.UIXEditableValue
                                            |
                                            +--oracle.adf.view.faces.component.UIXInput
                                                  |
                                                  +--oracle.adf.view.faces.component.core.input.CoreInputText

All Implemented Interfaces:

javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class CoreInputText

extends UIXInput

The UIXInputText component creates a browser input text widget. Depending on the value of "rows", this component either maps to a single-row text field or a multi-row text area. If the input should be hidden from the user while displayed, such as for passwords, the secret property should be set to "true". It also supports displaying a label, text, and messages.

Example:

Simple text input box with the some default text and a label.

    <af:form>
      <af:inputText label="Input:" value="Some text"/>
    </af:form>

A slightly more interesting example showing a text box twenty five characters in length with hidden input text.

      <af:inputText label="Password:"
                 columns="25"
                 required="no"
                 secret="true"/>

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.

      <af:inputText label="Alert:"
                 rows="3"
                 wrap="soft"
                 onchange="alert('Text box has changed.')"
                 text="Alert on change."/>

Events:

Type	Phases	Description
javax.faces.event.ValueChangeEvent	Process Validations Apply Request Values	Event delivered when a new value is entered by a user.

It does not support any children.

Field Summary

static PropertyKey	ACCESS_KEY_KEY
static PropertyKey	AUTO_SUBMIT_KEY
static PropertyKey	COLUMNS_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	DISABLED_KEY
static PropertyKey	INLINE_STYLE_KEY
static PropertyKey	LABEL_KEY
static PropertyKey	MAXIMUM_LENGTH_KEY
static PropertyKey	MESSAGE_DESC_URL_KEY
static PropertyKey	MESSAGE_TARGET_FRAME_KEY
static PropertyKey	ONBLUR_KEY
static PropertyKey	ONCHANGE_KEY
static PropertyKey	ONCLICK_KEY
static PropertyKey	ONDBLCLICK_KEY
static PropertyKey	ONFOCUS_KEY
static PropertyKey	ONKEYDOWN_KEY
static PropertyKey	ONKEYPRESS_KEY
static PropertyKey	ONKEYUP_KEY
static PropertyKey	ONMOUSEDOWN_KEY
static PropertyKey	ONMOUSEMOVE_KEY
static PropertyKey	ONMOUSEOUT_KEY
static PropertyKey	ONMOUSEOVER_KEY
static PropertyKey	ONMOUSEUP_KEY
static PropertyKey	ONSELECT_KEY
static PropertyKey	READ_ONLY_KEY
static PropertyKey	ROWS_KEY
static PropertyKey	SECRET_KEY
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	SHOW_REQUIRED_KEY
static PropertyKey	SIMPLE_KEY
static PropertyKey	STYLE_CLASS_KEY
static PropertyKey	TIP_KEY
static FacesBean.Type	TYPE
static PropertyKey	VALIGN_KEY
static PropertyKey	WRAP_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXEditableValue

IMMEDIATE_KEY, REQUIRED_KEY, VALIDATOR_KEY, VALUE_CHANGE_LISTENER_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXEditableValueComponentBase

LOCAL_VALUE_SET_KEY, SUBMITTED_VALUE_KEY, VALID_KEY, VALIDATORS_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXValue

CONVERTER_KEY, VALUE_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

CoreInputText()
Construct an instance of the CoreInputText.

Method Summary

char	getAccessKey() Gets Character used to gain quick access to the form element specified by the for, if set.
protected FacesBean.Type	getBeanType()
int	getColumns() Gets the number of columns to display in the text control.
java.lang.String	getFamily()
Style	getInlineStyle() Gets the inline CSS style for this element
java.lang.String	getLabel() Gets the label of the bean.
int	getMaximumLength() Gets the maximum number of characters per line that can be entered into the text control.
java.lang.String	getMessageDescUrl() Gets an URL to a page with more information about the message.
java.lang.String	getMessageTargetFrame() Gets the target frame for the message description URL, if any.
java.lang.String	getOnblur() Gets the event handler for when the element loses focus.
java.lang.String	getOnchange() Gets event handler for when the value is changed.
java.lang.String	getOnclick() Gets an onclick Javascript handler.
java.lang.String	getOndblclick() Gets an ondblclick Javascript handler.
java.lang.String	getOnfocus() Gets the event handler for when the element receives focus.
java.lang.String	getOnkeydown() Gets an onkeydown Javascript handler.
java.lang.String	getOnkeypress() Gets an onkeypress Javascript handler.
java.lang.String	getOnkeyup() Gets an onkeyup Javascript handler.
java.lang.String	getOnmousedown() Gets an onmousedown Javascript handler.
java.lang.String	getOnmousemove() Gets an onmousemove Javascript handler.
java.lang.String	getOnmouseout() Gets an onmouseout Javascript handler.
java.lang.String	getOnmouseover() Gets an onmouseover Javascript handler.
java.lang.String	getOnmouseup() Gets an onmouseup Javascript handler.
java.lang.String	getOnselect() Gets event handler for when text becomes selected.
int	getRows() Gets the number of rows to display in the text control.
java.lang.String	getShortDesc() Gets the short description of the bean.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
java.lang.String	getTip() Gets the tip text associated with the control
java.lang.String	getValign() Gets the vertical alignment of the label and other contents.
java.lang.String	getWrap() Gets the type of text wrapping to be used in a multi-row text control.
boolean	isAutoSubmit() Gets If set to TRUE on a form element, the component will automatically submit the enclosing form when an appropriate action takes place (a click, text change, etc.).
boolean	isDisabled() Gets whether the element is disabled.
boolean	isReadOnly() Gets whether the element is read-only.
boolean	isSecret() Gets a boolean value that only applies to single line text controls.
boolean	isShowRequired() Gets whether the associated control displays a visual indication of required user input.
boolean	isSimple() Gets a boolean value that controls whether the component provides label and message support; when set to "true", the component will not display messaging support or the label (these attributes are ignored), and may use simpler layout primitives
void	setAccessKey(char accessKey) Sets Character used to gain quick access to the form element specified by the for, if set.
void	setAutoSubmit(boolean autoSubmit) Sets If set to TRUE on a form element, the component will automatically submit the enclosing form when an appropriate action takes place (a click, text change, etc.).
void	setColumns(int columns) Sets the number of columns to display in the text control.
void	setDisabled(boolean disabled) Sets whether the element is disabled.
void	setInlineStyle(Style inlineStyle) Sets the inline CSS style for this element
void	setLabel(java.lang.String label) Sets the label of the bean.
void	setMaximumLength(int maximumLength) Sets the maximum number of characters per line that can be entered into the text control.
void	setMessageDescUrl(java.lang.String messageDescUrl) Sets an URL to a page with more information about the message.
void	setMessageTargetFrame(java.lang.String messageTargetFrame) Sets the target frame for the message description URL, if any.
void	setOnblur(java.lang.String onblur) Sets the event handler for when the element loses focus.
void	setOnchange(java.lang.String onchange) Sets event handler for when the value is changed.
void	setOnclick(java.lang.String onclick) Sets an onclick Javascript handler.
void	setOndblclick(java.lang.String ondblclick) Sets an ondblclick Javascript handler.
void	setOnfocus(java.lang.String onfocus) Sets the event handler for when the element receives focus.
void	setOnkeydown(java.lang.String onkeydown) Sets an onkeydown Javascript handler.
void	setOnkeypress(java.lang.String onkeypress) Sets an onkeypress Javascript handler.
void	setOnkeyup(java.lang.String onkeyup) Sets an onkeyup Javascript handler.
void	setOnmousedown(java.lang.String onmousedown) Sets an onmousedown Javascript handler.
void	setOnmousemove(java.lang.String onmousemove) Sets an onmousemove Javascript handler.
void	setOnmouseout(java.lang.String onmouseout) Sets an onmouseout Javascript handler.
void	setOnmouseover(java.lang.String onmouseover) Sets an onmouseover Javascript handler.
void	setOnmouseup(java.lang.String onmouseup) Sets an onmouseup Javascript handler.
void	setOnselect(java.lang.String onselect) Sets event handler for when text becomes selected.
void	setReadOnly(boolean readOnly) Sets whether the element is read-only.
void	setRows(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.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the bean.
void	setShowRequired(boolean showRequired) Sets whether the associated control displays a visual indication of required user input.
void	setSimple(boolean simple) Sets a boolean value that controls whether the component provides label and message support; when set to "true", the component will not display messaging support or the label (these attributes are ignored), and may use simpler layout primitives
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.
void	setTip(java.lang.String tip) Sets the tip text associated with the control
void	setValign(java.lang.String valign) Sets the vertical alignment of the label and other contents.
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.adf.view.faces.component.UIXEditableValue

getValidator, getValueChangeListener, isImmediate, isRequired, setImmediate, setRequired, setValidator, setValueChangeListener

Methods inherited from class oracle.adf.view.faces.component.UIXEditableValueComponentBase

addValidator, addValueChangeListener, broadcast, compareValues, getConvertedValue, getSubmittedValue, getValidators, getValueChangeListeners, isLocalValueSet, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setLocalValueSet, setSubmittedValue, setValid, updateModel, validate, validateValue

Methods inherited from class oracle.adf.view.faces.component.UIXValue

getConverter, getValue, setConverter, setValue

Methods inherited from class oracle.adf.view.faces.component.UIXValueComponentBase

getLocalValue

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addFacesListener, createFacesBean, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttribute, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getIntProperty, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreState, saveState, setAttribute, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter, setValue

Field Detail

TYPE

public static final FacesBean.Type TYPE

ROWS_KEY

public static final PropertyKey ROWS_KEY

COLUMNS_KEY

public static final PropertyKey COLUMNS_KEY

MAXIMUM_LENGTH_KEY

public static final PropertyKey MAXIMUM_LENGTH_KEY

WRAP_KEY

public static final PropertyKey WRAP_KEY

SECRET_KEY

public static final PropertyKey SECRET_KEY

READ_ONLY_KEY

public static final PropertyKey READ_ONLY_KEY

DISABLED_KEY

public static final PropertyKey DISABLED_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

LABEL_KEY

public static final PropertyKey LABEL_KEY

TIP_KEY

public static final PropertyKey TIP_KEY

SIMPLE_KEY

public static final PropertyKey SIMPLE_KEY

ONFOCUS_KEY

public static final PropertyKey ONFOCUS_KEY

ONBLUR_KEY

public static final PropertyKey ONBLUR_KEY

ONCHANGE_KEY

public static final PropertyKey ONCHANGE_KEY

ONSELECT_KEY

public static final PropertyKey ONSELECT_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

SHOW_REQUIRED_KEY

public static final PropertyKey SHOW_REQUIRED_KEY

MESSAGE_DESC_URL_KEY

public static final PropertyKey MESSAGE_DESC_URL_KEY

MESSAGE_TARGET_FRAME_KEY

public static final PropertyKey MESSAGE_TARGET_FRAME_KEY

VALIGN_KEY

public static final PropertyKey VALIGN_KEY

ACCESS_KEY_KEY

public static final PropertyKey ACCESS_KEY_KEY

AUTO_SUBMIT_KEY

public static final PropertyKey AUTO_SUBMIT_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

CoreInputText

public CoreInputText()

Construct an instance of the CoreInputText.

Method Detail

getRows

public final int getRows()

Gets the number of rows to display in the text control. The default is one. Setting to more than one row precludes the use of some attributes, such as "secret".

setRows

public final void setRows(int rows)

Sets the number of rows to display in the text control. The default is one. Setting to more than one row precludes the use of some attributes, such as "secret".

getColumns

public final int getColumns()

Gets the number of columns to display in the text control. If no value is specified, a default of 30 columns is used. One column is approximately one character in the browser's current display font.

setColumns

public final void setColumns(int columns)

Sets the number of columns to display in the text control. If no value is specified, a default of 30 columns is used. One column is approximately one character in the browser's current display font.

getMaximumLength

public final int getMaximumLength()

Gets the maximum number of characters per line that can be entered into the text control. Note that this value is independent of the "cols" displayed.

setMaximumLength

public final void setMaximumLength(int maximumLength)

Sets the maximum number of characters per line that can be entered into the text control. Note that this value is independent of the "cols" displayed.

getWrap

public final java.lang.String getWrap()

Gets the type of text wrapping to be used in a multi-row text control. This attribute is ignored for single row controls. By default, multirow text wraps visually, but does not include carriage returns in the submitted value. Setting this to "off" will disable wrapping; the multirow text will scroll horizontally. Setting it to "hard" specifies that the value of the text should include any carriage returns needed to wrap the lines.

setWrap

public final void setWrap(java.lang.String wrap)

Sets the type of text wrapping to be used in a multi-row text control. This attribute is ignored for single row controls. By default, multirow text wraps visually, but does not include carriage returns in the submitted value. Setting this to "off" will disable wrapping; the multirow text will scroll horizontally. Setting it to "hard" specifies that the value of the text should include any carriage returns needed to wrap the lines.

isSecret

public final boolean isSecret()

Gets a boolean value that only applies to single line text controls. When set to "true", it hides the actual value of the text from the user, and will prevent the actual "value" from being shown to the user.

setSecret

public final void setSecret(boolean secret)

Sets a boolean value that only applies to single line text controls. When set to "true", it hides the actual value of the text from the user, and will prevent the actual "value" from being shown to the user.

isReadOnly

public final boolean isReadOnly()

Gets whether the element is read-only.

setReadOnly

public final void setReadOnly(boolean readOnly)

Sets whether the element is read-only.

isDisabled

public final boolean isDisabled()

Gets whether the element is disabled.

setDisabled

public final void setDisabled(boolean disabled)

Sets whether the element is disabled.

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

getLabel

public final java.lang.String getLabel()

Gets the label of the bean.

setLabel

public final void setLabel(java.lang.String label)

Sets the label of the bean.

getTip

public final java.lang.String getTip()

Gets the tip text associated with the control

setTip

public final void setTip(java.lang.String tip)

Sets the tip text associated with the control

isSimple

public final boolean isSimple()

Gets a boolean value that controls whether the component provides label and message support; when set to "true", the component will not display messaging support or the label (these attributes are ignored), and may use simpler layout primitives

setSimple

public final void setSimple(boolean simple)

Sets a boolean value that controls whether the component provides label and message support; when set to "true", the component will not display messaging support or the label (these attributes are ignored), and may use simpler layout primitives

getOnfocus

public final java.lang.String getOnfocus()

Gets the event handler for when the element receives focus.

setOnfocus

public final void setOnfocus(java.lang.String onfocus)

Sets the event handler for when the element receives focus.

getOnblur

public final java.lang.String getOnblur()

Gets the event handler for when the element loses focus.

setOnblur

public final void setOnblur(java.lang.String onblur)

Sets the event handler for when the element loses focus.

getOnchange

public final java.lang.String getOnchange()

Gets event handler for when the value is changed.

setOnchange

public final void setOnchange(java.lang.String onchange)

Sets event handler for when the value is changed.

getOnselect

public final java.lang.String getOnselect()

Gets event handler for when text becomes selected.

setOnselect

public final void setOnselect(java.lang.String onselect)

Sets event handler for when text becomes selected.

getStyleClass

public final java.lang.String getStyleClass()

Gets the CSS style class of the bean.

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets the CSS style class of the bean.

getOnclick

public final java.lang.String getOnclick()

Gets an onclick Javascript handler.

setOnclick

public final void setOnclick(java.lang.String onclick)

Sets an onclick Javascript handler.

getOndblclick

public final java.lang.String getOndblclick()

Gets an ondblclick Javascript handler.

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)

Sets an ondblclick Javascript handler.

getOnmousedown

public final java.lang.String getOnmousedown()

Gets an onmousedown Javascript handler.

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)

Sets an onmousedown Javascript handler.

getOnmouseup

public final java.lang.String getOnmouseup()

Gets an onmouseup Javascript handler.

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)

Sets an onmouseup Javascript handler.

getOnmouseover

public final java.lang.String getOnmouseover()

Gets an onmouseover Javascript handler.

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)

Sets an onmouseover Javascript handler.

getOnmousemove

public final java.lang.String getOnmousemove()

Gets an onmousemove Javascript handler.

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)

Sets an onmousemove Javascript handler.

getOnmouseout

public final java.lang.String getOnmouseout()

Gets an onmouseout Javascript handler.

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)

Sets an onmouseout Javascript handler.

getOnkeypress

public final java.lang.String getOnkeypress()

Gets an onkeypress Javascript handler.

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)

Sets an onkeypress Javascript handler.

getOnkeydown

public final java.lang.String getOnkeydown()

Gets an onkeydown Javascript handler.

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)

Sets an onkeydown Javascript handler.

getOnkeyup

public final java.lang.String getOnkeyup()

Gets an onkeyup Javascript handler.

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)

Sets an onkeyup Javascript handler.

getInlineStyle

public final Style getInlineStyle()

Gets the inline CSS style for this element

setInlineStyle

public final void setInlineStyle(Style inlineStyle)

Sets the inline CSS style for this element

isShowRequired

public final boolean isShowRequired()

Gets whether the associated control displays a visual indication of required user input.

setShowRequired

public final void setShowRequired(boolean showRequired)

Sets whether the associated control displays a visual indication of required user input.

getMessageDescUrl

public final java.lang.String getMessageDescUrl()

Gets an URL to a page with more information about the message.

setMessageDescUrl

public final void setMessageDescUrl(java.lang.String messageDescUrl)

Sets an URL to a page with more information about the message.

getMessageTargetFrame

public final java.lang.String getMessageTargetFrame()

Gets the target frame for the message description URL, if any.

setMessageTargetFrame

public final void setMessageTargetFrame(java.lang.String messageTargetFrame)

Sets the target frame for the message description URL, if any.

getValign

public final java.lang.String getValign()

Gets the vertical alignment of the label and other contents. The acceptable values are "middle", "top", and "bottom".

setValign

public final void setValign(java.lang.String valign)

Sets the vertical alignment of the label and other contents. The acceptable values are "middle", "top", and "bottom".

getAccessKey

public final char getAccessKey()

Gets Character used to gain quick access to the form element specified by the for, if set. If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

setAccessKey

public final void setAccessKey(char accessKey)

Sets Character used to gain quick access to the form element specified by the for, if set. If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

isAutoSubmit

public final boolean isAutoSubmit()

Gets If set to TRUE on a form element, the component will automatically submit the enclosing form when an appropriate action takes place (a click, text change, etc.).

setAutoSubmit

public final void setAutoSubmit(boolean autoSubmit)

Sets If set to TRUE on a form element, the component will automatically submit the enclosing form when an appropriate action takes place (a click, text change, etc.).

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXInput

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXInput