Class UITextarea

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
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, SupportsAutoSpacing, SupportsHelp, SupportsLabelLayout, Visual

@Generated("component.stg") public class UITextarea extends AbstractUITextarea
Renders a multi line text input control. UIComponent class, generated from template component.stg with class TextareaTagDeclaration.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
    static final String
     

    Fields inherited from class javax.faces.component.UIInput

    ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

    Fields inherited from class javax.faces.component.UIComponent

    ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    The access key of this control.
    Automatically add spacing (margins/paddings) to the component for better positioning.
    Sets a CSS class in its parent, if the parent supports it.
     
     
     
    Text value to display as a help.
    A localized user presentable label for this component.
    Defines the position of the label relative to the field.
     
    Displays a short text in the input field, that describes the meaning of this field.
    The row count for this component.
    Should HTML content sanitized?
    Controls the navigation of the focus through the input controls on a page with the Tab-Key.
    Text value to display as tooltip.
    boolean
    Flag indicating that this element is disabled.
    boolean
    Flag indicating this component should receive the focus.
    boolean
    Flag indicating that this component will prohibit changes by the user.
    void
    restoreState(javax.faces.context.FacesContext context, Object state)
     
    void
     
    void
    setAutoSpacing(Boolean autoSpacing)
     
    void
     
    void
    setDisabled(boolean disabled)
     
    void
    setFocus(boolean focus)
     
    void
     
    void
     
    void
     
    void
    setMarkup(Markup markup)
     
    void
    setPlaceholder(String placeholder)
     
    void
    setReadonly(boolean readonly)
     
    void
     
    void
     
    void
    setTabIndex(Integer tabIndex)
     
    void
     

    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.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 Details

  • Constructor Details

    • UITextarea

      public UITextarea()
  • Method Details

    • getEventNames

      public Collection<String> getEventNames()
      Specified by:
      getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
      Overrides:
      getEventNames in class javax.faces.component.UIComponentBase
    • getDefaultEventName

      public String getDefaultEventName()
      Specified by:
      getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
      Overrides:
      getDefaultEventName in class javax.faces.component.UIComponentBase
    • getFamily

      public String getFamily()
      Overrides:
      getFamily in class javax.faces.component.UIInput
    • getMarkup

      public Markup getMarkup()
    • setMarkup

      public void setMarkup(Markup markup)
    • 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:
      isFocus in class AbstractUIInput
    • 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:
      getTabIndex in class AbstractUIInput
    • setTabIndex

      public void setTabIndex(Integer tabIndex)
    • 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:
      getRows in class AbstractUITextarea
    • 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)
    • isReadonly

      public boolean isReadonly()
      Flag indicating that this component will prohibit changes by the user.
      Default: false
      Specified by:
      isReadonly in class AbstractUIInput
    • setReadonly

      public void setReadonly(boolean readonly)
    • 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)
    • isDisabled

      public boolean isDisabled()
      Flag indicating that this element is disabled.
      Default: false
      Specified by:
      isDisabled in class AbstractUIInput
    • 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:
      getPlaceholder in class AbstractUITextarea
    • setPlaceholder

      public void setPlaceholder(String placeholder)
    • 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:textarea when attribute data-html-editor is set,
      because that are the critical parts.
      Default: auto
      Allowed Values: auto,never
      Specified by:
      getSanitize in class AbstractUITextarea
    • setSanitize

      public void setSanitize(SanitizeMode sanitize)
    • restoreState

      public void restoreState(javax.faces.context.FacesContext context, Object state)
      Specified by:
      restoreState in interface javax.faces.component.StateHolder
      Overrides:
      restoreState in class javax.faces.component.UIInput