Class UIPopover

  • 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, Visual

    @Generated("component.stg")
    public class UIPopover
    extends AbstractUIPopover
    implements javax.faces.component.behavior.ClientBehaviorHolder
    Renders a popover. UIComponent class, generated from template component.stg with class PopoverTagDeclaration.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  
      • 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
      UIPopover()  
    • Method Summary

      All Methods Instance Methods Concrete 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.
      Markup getMarkup()  
      SanitizeMode getSanitize()
      Should HTML content sanitized?
      boolean isEscape()
      Flag indicating that characters that are sensitive in HTML and XML markup must be escaped.
      void restoreState​(javax.faces.context.FacesContext context, Object state)  
      void setCustomClass​(CustomClass customClass)  
      void setEscape​(boolean escape)  
      void setLabel​(String label)  
      void setMarkup​(Markup markup)  
      void setSanitize​(SanitizeMode sanitize)  
      • 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, setValueExpression, subscribeToEvent, unsubscribeFromEvent
      • Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
    • Constructor Detail

      • UIPopover

        public UIPopover()
    • Method Detail

      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class javax.faces.component.UIOutput
      • 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
      • setLabel

        public void setLabel​(String label)
      • 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 AbstractUIPopover
      • 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:popover 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 AbstractUIPopover
      • 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