Class UITextarea
- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- javax.faces.component.UIOutput
-
- javax.faces.component.UIInput
-
- org.apache.myfaces.tobago.internal.component.AbstractUIInput
-
- org.apache.myfaces.tobago.internal.component.AbstractUITextarea
-
- org.apache.myfaces.tobago.component.UITextarea
-
- All Implemented Interfaces:
EventListener,javax.faces.component.behavior.ClientBehaviorHolder,javax.faces.component.EditableValueHolder,javax.faces.component.PartialStateHolder,javax.faces.component.StateHolder,javax.faces.component.TransientStateHolder,javax.faces.component.ValueHolder,javax.faces.event.ComponentSystemEventListener,javax.faces.event.FacesListener,javax.faces.event.SystemEventListenerHolder,SupportFieldId,SupportsAccessKey,SupportsAutocomplete,SupportsAutoSpacing,SupportsDecorationPosition,SupportsHelp,SupportsLabelLayout,Visual
@Generated("component.stg") public class UITextarea extends AbstractUITextarea
Renders a multi line text input control. UIComponent class, generated from templatecomponent.stgwith classTextareaTagDeclaration.
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UITextarea()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CharactergetAccessKey()The access key of this control.ObjectgetAutocomplete()BooleangetAutoSpacing()Automatically add spacing (margins/paddings) to the component for better positioning.CustomClassgetCustomClass()Sets a CSS class in its parent, if the parent supports it.StringgetDefaultEventName()Collection<String>getEventNames()StringgetFamily()StringgetHelp()Text value to display as a help.DecorationPositiongetHelpPosition()Defines the position and the appearance of a help message on a component.StringgetLabel()A localized user presentable label for this component.LabelLayoutgetLabelLayout()Defines the position of the label relative to the field.MarkupgetMarkup()DecorationPositiongetMessagePosition()Defines the position and the appearance of additional faces messages (like error message or help message) on a component.StringgetPlaceholder()Displays a short text in the input field, that describes the meaning of this field.IntegergetRows()The row count for this component.SanitizeModegetSanitize()Should HTML content sanitized?IntegergetTabIndex()Controls the navigation of the focus through the input controls on a page with the Tab-Key.StringgetTip()Text value to display as tooltip.booleanisDisabled()Flag indicating that this element is disabled.booleanisFocus()Flag indicating this component should receive the focus.booleanisReadonly()Flag indicating that this component will prohibit changes by the user.voidrestoreState(javax.faces.context.FacesContext context, Object state)voidsetAccessKey(Character accessKey)voidsetAutocomplete(Object autocomplete)voidsetAutoSpacing(Boolean autoSpacing)voidsetCustomClass(CustomClass customClass)voidsetDisabled(boolean disabled)voidsetFocus(boolean focus)voidsetHelp(String help)voidsetHelpPosition(DecorationPosition helpPosition)voidsetLabel(String label)voidsetLabelLayout(LabelLayout labelLayout)voidsetMarkup(Markup markup)voidsetMessagePosition(DecorationPosition messagePosition)voidsetPlaceholder(String placeholder)voidsetReadonly(boolean readonly)voidsetRows(Integer rows)voidsetSanitize(SanitizeMode sanitize)voidsetTabIndex(Integer tabIndex)voidsetTip(String tip)-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIInput
getFieldId, isError, isNextToRenderIsLabel, setNextToRenderIsLabel
-
Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue
-
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverter
-
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
-
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
-
Methods inherited from interface org.apache.myfaces.tobago.component.SupportsAutocomplete
getAutocompleteString
-
Methods inherited from interface org.apache.myfaces.tobago.component.SupportsAutoSpacing
getAutoSpacing
-
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverter
-
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getEventNames
public Collection<String> getEventNames()
- Specified by:
getEventNamesin interfacejavax.faces.component.behavior.ClientBehaviorHolder- Overrides:
getEventNamesin classjavax.faces.component.UIComponentBase
-
getDefaultEventName
public String getDefaultEventName()
- Specified by:
getDefaultEventNamein interfacejavax.faces.component.behavior.ClientBehaviorHolder- Overrides:
getDefaultEventNamein classjavax.faces.component.UIComponentBase
-
getFamily
public String getFamily()
- Overrides:
getFamilyin classjavax.faces.component.UIInput
-
getLabelLayout
public LabelLayout getLabelLayout()
Defines the position of the label relative to the field. The default is flexLeft, if the label is set, or none, if the label isn't set. Set to 'skip' to avoid surrounding label container. Hint for tc:out: set also compact=true to render only text (without html tags).
-
setLabelLayout
public void setLabelLayout(LabelLayout labelLayout)
-
isFocus
public boolean isFocus()
Flag indicating this component should receive the focus.
Default:false- Specified by:
isFocusin classAbstractUIInput
-
setFocus
public void setFocus(boolean focus)
-
getTabIndex
public Integer getTabIndex()
Controls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.- Specified by:
getTabIndexin classAbstractUIInput
-
setTabIndex
public void setTabIndex(Integer tabIndex)
-
isReadonly
public boolean isReadonly()
Flag indicating that this component will prohibit changes by the user.
Default:false- Specified by:
isReadonlyin classAbstractUIInput
-
setReadonly
public void setReadonly(boolean readonly)
-
isDisabled
public boolean isDisabled()
Flag indicating that this element is disabled.
Default:false- Specified by:
isDisabledin classAbstractUIInput
-
setDisabled
public void setDisabled(boolean disabled)
-
getTip
public String getTip()
Text value to display as tooltip.
-
setTip
public void setTip(String tip)
-
getPlaceholder
public String getPlaceholder()
Displays a short text in the input field, that describes the meaning of this field.
- Specified by:
getPlaceholderin classAbstractUITextarea
-
setPlaceholder
public void setPlaceholder(String placeholder)
-
getMarkup
public Markup getMarkup()
-
setMarkup
public void setMarkup(Markup markup)
-
getAutocomplete
public Object getAutocomplete()
-
setAutocomplete
public void setAutocomplete(Object autocomplete)
-
getMessagePosition
public DecorationPosition getMessagePosition()
Defines the position and the appearance of additional faces messages (like error message or help message) on a component. The default is popoverRight.
-
setMessagePosition
public void setMessagePosition(DecorationPosition messagePosition)
-
getLabel
public String getLabel()
A localized user presentable label for this component.
-
setLabel
public void setLabel(String label)
-
getRows
public Integer getRows()
The row count for this component.- Specified by:
getRowsin classAbstractUITextarea
-
setRows
public void setRows(Integer rows)
-
getHelp
public String getHelp()
Text value to display as a help.
-
setHelp
public void setHelp(String help)
-
getAutoSpacing
public Boolean getAutoSpacing()
Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet
-
setAutoSpacing
public void setAutoSpacing(Boolean autoSpacing)
-
getHelpPosition
public DecorationPosition getHelpPosition()
Defines the position and the appearance of a help message on a component. The default is popoverRight.
-
setHelpPosition
public void setHelpPosition(DecorationPosition helpPosition)
-
getAccessKey
public Character getAccessKey()
The access key of this control.
-
setAccessKey
public void setAccessKey(Character accessKey)
-
getCustomClass
public CustomClass getCustomClass()
Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.
-
setCustomClass
public void setCustomClass(CustomClass customClass)
-
getSanitize
public SanitizeMode getSanitize()
Should HTML content sanitized? The effect of sanitizing depends on the configuration. The value "auto" means, that sanitizing take place for- tc:out when escape="false" or
- tc:popover when escape="false" or
- tc:textarea when attribute data-html-editor is set,
Default:auto
Allowed Values:auto,never- Specified by:
getSanitizein classAbstractUITextarea
-
setSanitize
public void setSanitize(SanitizeMode sanitize)
-
restoreState
public void restoreState(javax.faces.context.FacesContext context, Object state)- Specified by:
restoreStatein interfacejavax.faces.component.StateHolder- Overrides:
restoreStatein classjavax.faces.component.UIInput
-
-