Package org.apache.myfaces.tobago.component

Class UIToasts

  • All Implemented Interfaces:
    jakarta.faces.component.behavior.ClientBehaviorHolder, jakarta.faces.component.NamingContainer, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.component.UniqueIdVendor, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, EventListener, Visual
    @Generated("component.stg")
public class UIToasts
extends AbstractUIToasts
    Render toasts elements. UIComponent class, generated from template component.stg with class ToastsTagDeclaration.

    • Field Summary

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

      • 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

      • Fields inherited from interface jakarta.faces.component.NamingContainer

        SEPARATOR_CHAR

    • Constructor Summary

      Constructors 
      Constructor Description
      UIToasts()  

    • 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 getDefaultEventName()  
      Integer getDisposeDelay()
      Delay in milliseconds before hiding the toast.
      Collection<String> getEventNames()  
      String getFamily()  
      Markup getMarkup()  
      Placement getPlacement()
      Defines the placement of the toasts.
      void restoreState​(jakarta.faces.context.FacesContext context, Object state)  
      void setCustomClass​(CustomClass customClass)  
      void setDisposeDelay​(Integer disposeDelay)  
      void setMarkup​(Markup markup)  
      void setPlacement​(Placement placement)  

      • Methods inherited from class jakarta.faces.component.UIData

        broadcast, createUniqueId, encodeBegin, encodeEnd, getContainerClientId, getDataModel, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getVar, invokeOnComponent, isRowAvailable, isRowStatePreserved, markInitialState, processDecodes, processUpdates, processValidators, queueEvent, saveState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueExpression, setVar, visitTree

      • Methods inherited from class jakarta.faces.component.UIComponentBase

        addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

      • Methods inherited from class jakarta.faces.component.UIComponent

        getClientId, getCompositeComponentParent, 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 interface jakarta.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors

    • Constructor Detail

      • UIToasts

        public UIToasts()

    • Method Detail

      • getEventNames

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

      • getDefaultEventName

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

      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class jakarta.faces.component.UIData

      • getDisposeDelay

        public Integer getDisposeDelay()
        Delay in milliseconds before hiding the toast. Default is "5000". Set to "-1" to never automatically hide the toast.
        Default: 5000
        Specified by:
        getDisposeDelay in class AbstractUIToasts

      • setDisposeDelay

        public void setDisposeDelay​(Integer disposeDelay)

      • getMarkup

        public Markup getMarkup()

      • setMarkup

        public void setMarkup​(Markup markup)

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

      • getPlacement

        public Placement getPlacement()
        Defines the placement of the toasts. Default is "bottomRight".
        Default: bottomRight
        Allowed Values: topLeft,topCenter,topRight,middleLeft,middleCenter,middleRight,bottomLeft,bottomCenter,bottomRight
        Specified by:
        getPlacement in class AbstractUIToasts

      • setPlacement

        public void setPlacement​(Placement placement)

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