Package org.apache.myfaces.tobago.component

Class UIOut

  • All Implemented Interfaces:
    EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, SupportsLabelLayout, Visual
    @Generated("component.stg")
public class UIOut
extends AbstractUIOut
implements javax.faces.component.behavior.ClientBehaviorHolder
    Renders a text UIComponent class, generated from template component.stg with class OutTagDeclaration.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  

      • Fields inherited from class javax.faces.component.UIComponent

        BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

    • Constructor Summary

      Constructors 
      Constructor Description
      UIOut()  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      CustomClass getCustomClass()
      Sets a CSS class in its parent, if the parent supports it.
      String getFamily()  
      String getLabel()
      A localized user presentable label for this component.
      LabelLayout getLabelLayout()
      Defines the position of the label relative to the field.
      Markup getMarkup()  
      SanitizeMode getSanitize()
      Should HTML content sanitized?
      String getTip()
      Text value to display as tooltip.
      boolean isCompact()
      Deprecated. 
      boolean isCreateSpan()
      Deprecated. 
      boolean isEscape()
      Flag indicating that characters that are sensitive in HTML and XML markup must be escaped.
      boolean isKeepLineBreaks()
      Flag indicating that new-line characters will be converted to HTML <br>.
      boolean isPlain()
      Use with caution: Only for special cases!
      void restoreState​(javax.faces.context.FacesContext context, Object state)  
      void setCompact​(boolean compact)
      Deprecated.
      void setCreateSpan​(boolean createSpan)
      Deprecated.
      void setCustomClass​(CustomClass customClass)  
      void setEscape​(boolean escape)  
      void setKeepLineBreaks​(boolean keepLineBreaks)  
      void setLabel​(String label)  
      void setLabelLayout​(LabelLayout labelLayout)  
      void setMarkup​(Markup markup)  
      void setPlain​(boolean plain)  
      void setSanitize​(SanitizeMode sanitize)  
      void setTip​(String tip)  

      • Methods inherited from class javax.faces.component.UIOutput

        clearInitialState, getConverter, getLocalValue, getValue, markInitialState, 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, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, 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, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

      • Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames

    • Constructor Detail

      • UIOut

        public UIOut()

    • Method Detail

      • getFamily

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

      • isCompact

        @Deprecated
public boolean isCompact()
        Deprecated.
        This attribute is useful if labelLayout=skip is set. Use true, if you want to only render the text (no surrounding tag). Use false, if you enable the possibility to apply styles to the output.
        Default: false
        Specified by:
        isCompact in class AbstractUIOut

      • setCompact

        @Deprecated
public void setCompact​(boolean compact)
        Deprecated.

      • 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).
        Specified by:
        getLabelLayout in interface SupportsLabelLayout

      • getLabel

        public String getLabel()
        A localized user presentable label for this component.

      • setLabel

        public void setLabel​(String label)

      • isPlain

        public boolean isPlain()

        Use with caution: Only for special cases!

        This attribute is useful for tc:out if labelLayout=skip is set. Use true, if you want to only render the text (no surrounding tag). Use false, if you enable the possibility to apply styles to the output.

        For tc:form there will no div tag be rendered. So, the content can be used freely from layout managers.

        But, no AJAX is possible for components with "plain" set, because there is no client element with an "id" in the DOM.


        Default: false
        Specified by:
        isPlain in interface Visual

      • setPlain

        public void setPlain​(boolean plain)

      • 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

      • isKeepLineBreaks

        public boolean isKeepLineBreaks()
        Flag indicating that new-line characters will be converted to HTML <br>. This is useful for pre-formatted plain text. This has only an effect, with escape="true".
        Default: true
        Specified by:
        isKeepLineBreaks in class AbstractUIOut

      • setKeepLineBreaks

        public void setKeepLineBreaks​(boolean keepLineBreaks)

      • getTip

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

      • setTip

        public void setTip​(String tip)

      • isCreateSpan

        @Deprecated
public boolean isCreateSpan()
        Deprecated.
        Indicates that the renderer should create an element in the output language (e. g. an span or div tag around the output text). Use true, if you enable the possibility to apply styles to the output. Use false, if you want to keep the code small (especially inside of sheets).
        Default: true
        Specified by:
        isCreateSpan in class AbstractUIOut

      • setCreateSpan

        @Deprecated
public void setCreateSpan​(boolean createSpan)
        Deprecated.

      • isEscape

        public boolean isEscape()
        Flag indicating that characters that are sensitive in HTML and XML markup must be escaped.
        Default: true
        Specified by:
        isEscape in class AbstractUIOut

      • setEscape

        public void setEscape​(boolean escape)

      • 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 AbstractUIOut

      • 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.UIOutput