Class UIPopover

java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIOutput
org.apache.myfaces.tobago.internal.component.AbstractUIPopover
org.apache.myfaces.tobago.component.UIPopover
All Implemented Interfaces:
jakarta.faces.component.behavior.ClientBehaviorHolder, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.component.ValueHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, EventListener, Visual

@Generated("component.stg") public class UIPopover extends AbstractUIPopover implements jakarta.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 final String
     
    static final String
     

    Fields inherited from class jakarta.faces.component.UIComponent

    ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Sets a CSS class in its parent, if the parent supports it.
     
    A localized user presentable label for this component.
     
    Should HTML content sanitized?
    Set a CSS class on the component.
    Defines how the popover is triggered.
    boolean
    Flag indicating that characters that are sensitive in HTML and XML markup must be escaped.
    void
    restoreState(jakarta.faces.context.FacesContext context, Object state)
     
    void
     
    void
    setEscape(boolean escape)
     
    void
     
    void
    setMarkup(Markup markup)
     
    void
     
    void
     
    void
     

    Methods inherited from class jakarta.faces.component.UIOutput

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

    Methods inherited from class jakarta.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, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree

    Methods inherited from class jakarta.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 Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder

    addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames

    Methods inherited from interface Visual

    getRendererType, isPlain
  • Field Details

  • Constructor Details

    • UIPopover

      public UIPopover()
  • Method Details

    • getFamily

      public String getFamily()
      Overrides:
      getFamily in class jakarta.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
    • 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
    • getLabel

      public String getLabel()
      A localized user presentable label for this component.
      Specified by:
      getLabel in class AbstractUIPopover
    • setLabel

      public void setLabel(String label)
    • getTrigger

      public PopoverTriggers getTrigger()
      Defines how the popover is triggered. Possible values are any combination of "click", "focus" and "hover". Default value is "focus" (can be changed in tobago-config.xml).
      Default: org.apache.myfaces.tobago.layout.PopoverTriggers.parse(org.apache.myfaces.tobago.context.TobagoContext.getInstance(getFacesContext()).getTheme().getTagAttributeDefault(TAG, "trigger"))
      Specified by:
      getTrigger in class AbstractUIPopover
    • setTrigger

      public void setTrigger(PopoverTriggers trigger)
    • getStyleClass

      public CustomClass getStyleClass()
      Set a CSS class on the component. This attribute is equivalent to
      <tc:style customClass="..."/>
      .
    • setStyleClass

      public void setStyleClass(CustomClass styleClass)
    • 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(jakarta.faces.context.FacesContext context, Object state)
      Specified by:
      restoreState in interface jakarta.faces.component.StateHolder
      Overrides:
      restoreState in class jakarta.faces.component.UIOutput