Class UILabel

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, 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, SupportsAccessKey, Visual

@Generated("component.stg") public class UILabel extends AbstractUILabel implements SupportsAccessKey, javax.faces.component.behavior.ClientBehaviorHolder
Renders a label component. UIComponent class, generated from template component.stg with class LabelTagDeclaration.
  • Field Summary

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

    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.
    Sets a CSS class in its parent, if the parent supports it.
     
    Id of the component, this is related to.
     
    Text value to display as tooltip.
    void
    restoreState(javax.faces.context.FacesContext context, Object state)
     
    void
     
    void
     
    void
    setFor(String forComponent)
     
    void
    setMarkup(Markup markup)
     
    void
     

    Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUILabel

    setValueExpression

    Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUILabelBase

    getLabel

    Methods inherited from class javax.faces.component.UIOutput

    clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, saveState, setConverter, setValue

    Methods inherited from class javax.faces.component.UIComponentBase

    addClientBehavior, addFacesListener, broadcast, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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, 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, getDefaultEventName, getEventNames

    Methods inherited from interface org.apache.myfaces.tobago.component.SupportsAccessKey

    getLabel

    Methods inherited from interface org.apache.myfaces.tobago.component.Visual

    getRendererType, isPlain
  • Field Details

  • Constructor Details

    • UILabel

      public UILabel()
  • Method Details

    • getFamily

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

      public Markup getMarkup()
      Specified by:
      getMarkup in interface Visual
    • setMarkup

      public void setMarkup(Markup markup)
      Specified by:
      setMarkup in interface Visual
    • getAccessKey

      public Character getAccessKey()
      The access key of this control.
      Specified by:
      getAccessKey in interface SupportsAccessKey
    • setAccessKey

      public void setAccessKey(Character accessKey)
    • getFor

      public String getFor()
      Id of the component, this is related to.
    • setFor

      public void setFor(String forComponent)
    • 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.
      Specified by:
      getCustomClass in interface Visual
    • setCustomClass

      public void setCustomClass(CustomClass customClass)
      Specified by:
      setCustomClass in interface Visual
    • getTip

      public String getTip()
      Text value to display as tooltip.
    • setTip

      public void setTip(String tip)
    • 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.UIOutput