Class UIToasts
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIData
org.apache.myfaces.tobago.internal.component.AbstractUIToasts
org.apache.myfaces.tobago.component.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
Render toasts elements.
 UIComponent class, generated from template 
component.stg with class
 ToastsTagDeclaration.- 
Field SummaryFieldsFields inherited from class jakarta.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEYFields inherited from interface jakarta.faces.component.NamingContainerSEPARATOR_CHAR
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionSets a CSS class in its parent, if the parent supports it.Delay in milliseconds before hiding the toast.Defines the placement of the toasts.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetCustomClass(CustomClass customClass) voidsetDisposeDelay(Integer disposeDelay) voidvoidsetPlacement(Placement placement) Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIToastsgetStates, getValue, setStatesMethods inherited from class jakarta.faces.component.UIDatabroadcast, 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, visitTreeMethods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, 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, setTransientMethods inherited from class jakarta.faces.component.UIComponentgetClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolderaddClientBehavior, getClientBehaviorsMethods inherited from interface org.apache.myfaces.tobago.component.VisualgetRendererType, isPlain
- 
Field Details- 
COMPONENT_TYPE
- 
COMPONENT_FAMILY- See Also:
 
 
- 
- 
Constructor Details- 
UIToastspublic UIToasts()
 
- 
- 
Method Details- 
getEventNames- Specified by:
- getEventNamesin interface- jakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getEventNamesin class- jakarta.faces.component.UIComponentBase
 
- 
getDefaultEventName- Specified by:
- getDefaultEventNamein interface- jakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getDefaultEventNamein class- jakarta.faces.component.UIComponentBase
 
- 
getFamily- Overrides:
- getFamilyin class- jakarta.faces.component.UIData
 
- 
getDisposeDelayDelay in milliseconds before hiding the toast. Default is "5000". Set to "-1" to never automatically hide the toast.
 Default:5000- Specified by:
- getDisposeDelayin class- AbstractUIToasts
 
- 
setDisposeDelay
- 
getMarkup
- 
setMarkup
- 
getCustomClassSets 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
- 
getPlacementDefines the placement of the toasts. Default is "bottomRight".
 Default:bottomRight
 Allowed Values:topLeft,topCenter,topRight,middleLeft,middleCenter,middleRight,bottomLeft,bottomCenter,bottomRight- Specified by:
- getPlacementin class- AbstractUIToasts
 
- 
setPlacement
- 
restoreState- Specified by:
- restoreStatein interface- jakarta.faces.component.StateHolder
- Overrides:
- restoreStatein class- jakarta.faces.component.UIData
 
 
-