|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
com.sun.webui.jsf.component.WebuiInput
com.sun.webui.jsf.component.HiddenField
com.sun.webui.jsf.component.Field
com.sun.webui.jsf.component.TextField
com.sun.webui.jsf.component.TextArea
public class TextArea
The TextArea component is used to create a multiple-line input field for
text.
As part of the dynamic behavior, TextArea supports autoSave: when enabled,
the content of the TextArea will be saved / submitted via ajax call to the server
every number of autoSave milliseconds. Note that only the text value of the
TextArea component will be saved, and other properties that could have been
changed on the client side only (i.e. client modified columns, rows, label) will
not be submitted to the server for autosave. Thus client side properties will
only affect the client state ( unless explicitly commited by the developer).
As all ajaxified client-side rendered components, autoSave would trigger
an event on the client side that can be intercepted by the developer in order to
implement her own save/commit procedure.
| Field Summary |
|---|
| Fields inherited from class com.sun.webui.jsf.component.Field |
|---|
INPUT_ID, LABEL_FACET, LABEL_ID, READONLY_FACET, READONLY_ID |
| Fields inherited from class javax.faces.component.UIInput |
|---|
COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID |
| Fields inherited from interface javax.faces.component.NamingContainer |
|---|
SEPARATOR_CHAR |
| Constructor Summary | |
|---|---|
TextArea()
Default constructor. |
|
| Method Summary | |
|---|---|
long |
getAutoSave()
Test if default Ajax functionality should be turned off. |
java.lang.String |
getFamily()
Return the family for this component. |
int |
getMaxLength()
The maximum number of characters that can be entered for this field. |
java.lang.String |
getRendererType()
Returns the renderer type for the component. |
int |
getRows()
Number of rows used to render the textarea. |
boolean |
isSubmitForm()
Flag indicating whether pressing enter in this text field would allow browser to submit the enclosing form. |
void |
restoreState(javax.faces.context.FacesContext _context,
java.lang.Object _state)
Restore the state of this component. |
java.lang.Object |
saveState(javax.faces.context.FacesContext _context)
Save the state of this component. |
void |
setAutoSave(long autoSave)
Set auto-save period. |
void |
setRows(int rows)
Number of rows used to render the textarea. |
void |
setSubmitForm(boolean submitForm)
SubmitForm is disabled for TextArea |
| Methods inherited from class com.sun.webui.jsf.component.TextField |
|---|
getAutoCompleteExpression, getNotify, getValueAsString, isAutoComplete, isAutoValidate, isSubmitFormSet, processUpdates, setAutoComplete, setAutoCompleteExpression, setAutoValidate, setNotify |
| Methods inherited from class com.sun.webui.jsf.component.HiddenField |
|---|
getHtmlTemplate, getReadOnlyValueString, setHtmlTemplate |
| Methods inherited from class com.sun.webui.jsf.component.WebuiInput |
|---|
broadcast, getValidator, getValidatorExpression, getValueChangeListener, getValueChangeListenerExpression, processDecodes, processValidators, setConverter, setId, setImmediate, setRendered, setRequired, setValidatorExpression, setValueChangeListenerExpression |
| Methods inherited from class javax.faces.component.UIInput |
|---|
addValidator, addValueChangeListener, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidatorMessage, getValidators, getValueChangeListeners, isImmediate, isLocalValueSet, isValid, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setLocalValueSet, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate |
| Methods inherited from class javax.faces.component.UIOutput |
|---|
getConverter, getLocalValue |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
encodeAll, getContainerClientId |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface javax.faces.component.ValueHolder |
|---|
getConverter, getLocalValue |
| Constructor Detail |
|---|
public TextArea()
| Method Detail |
|---|
public java.lang.String getFamily()
Return the family for this component.
getFamily in class TextFieldpublic java.lang.String getRendererType()
getRendererType in class TextFieldpublic int getMaxLength()
getMaxLength in class Fieldpublic int getRows()
Number of rows used to render the textarea. You should set a value for this attribute to ensure that it is rendered correctly in all browsers. Browsers vary in the default number of rows used for textarea fields.
public void setRows(int rows)
Number of rows used to render the textarea. You should set a value for this attribute to ensure that it is rendered correctly in all browsers. Browsers vary in the default number of rows used for textarea fields.
getRows()public long getAutoSave()
public void setAutoSave(long autoSave)
autoSave - - time period in millisec, or 0 if no autosave requiredpublic boolean isSubmitForm()
Flag indicating whether pressing enter in this text field would allow browser to submit the enclosing form.
isSubmitForm in class TextFieldpublic void setSubmitForm(boolean submitForm)
SubmitForm is disabled for TextArea
setSubmitForm in class TextFieldTextField.isSubmitForm()
public void restoreState(javax.faces.context.FacesContext _context,
java.lang.Object _state)
Restore the state of this component.
restoreState in interface javax.faces.component.StateHolderrestoreState in class TextFieldpublic java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.
saveState in interface javax.faces.component.StateHoldersaveState in class TextField
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||