Class UIToasts
java.lang.Object
org.apache.myfaces.tobago.internal.component.AbstractUIToasts
org.apache.myfaces.tobago.component.UIToasts
- All Implemented Interfaces:
EventListener, Visual
Render toasts elements.
UIComponent class, generated from template
component.stg with class
ToastsTagDeclaration.-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1) voidaddClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1) protected voidaddFacesListener(jakarta.faces.event.FacesListener arg0) voidbroadcast(jakarta.faces.event.FacesEvent arg0) voidcreateUniqueId(jakarta.faces.context.FacesContext arg0, String arg1) voiddecode(jakarta.faces.context.FacesContext arg0) voidencodeAll(jakarta.faces.context.FacesContext arg0) voidencodeBegin(jakarta.faces.context.FacesContext arg0) voidencodeChildren(jakarta.faces.context.FacesContext arg0) voidencodeEnd(jakarta.faces.context.FacesContext arg0) jakarta.faces.component.UIComponentfindComponent(String arg0) intList<jakarta.faces.component.UIComponent> getClientId(jakarta.faces.context.FacesContext arg0) static jakarta.faces.component.UIComponentgetCompositeComponentParent(jakarta.faces.component.UIComponent arg0) getContainerClientId(jakarta.faces.context.FacesContext arg0) static jakarta.faces.component.UIComponentgetCurrentComponent(jakarta.faces.context.FacesContext arg0) static jakarta.faces.component.UIComponentgetCurrentCompositeComponent(jakarta.faces.context.FacesContext arg0) Sets a CSS class in its parent, if the parent supports it.protected jakarta.faces.model.DataModelDelay in milliseconds before hiding the toast.protected jakarta.faces.context.FacesContextprotected jakarta.faces.event.FacesListener[]getFacesListeners(Class arg0) jakarta.faces.component.UIComponentintIterator<jakarta.faces.component.UIComponent> intgetFirst()jakarta.faces.component.UIComponentjakarta.faces.component.UIComponentgetId()List<jakarta.faces.event.SystemEventListener> getListenersForEventClass(Class<? extends jakarta.faces.event.SystemEvent> arg0) jakarta.faces.component.UIComponentjakarta.faces.component.UIComponentgetPassThroughAttributes(boolean arg0) Defines the placement of the toasts.protected jakarta.faces.render.RenderergetRenderer(jakarta.faces.context.FacesContext arg0) booleanintintintgetRows()protected jakarta.faces.component.StateHelperprotected jakarta.faces.component.StateHelpergetStateHelper(boolean arg0) jakarta.faces.component.TransientStateHelperjakarta.faces.component.TransientStateHelpergetTransientStateHelper(boolean arg0) jakarta.el.ValueExpressiongetValueExpression(String arg0) getVar()booleanbooleaninvokeOnComponent(jakarta.faces.context.FacesContext arg0, String arg1, jakarta.faces.component.ContextCallback arg2) static booleanisCompositeComponent(jakarta.faces.component.UIComponent arg0) booleanisInView()booleanbooleanbooleanbooleanprotected booleanisVisitable(jakarta.faces.component.visit.VisitContext arg0) voidvoidpopComponentFromEL(jakarta.faces.context.FacesContext arg0) voidprocessDecodes(jakarta.faces.context.FacesContext arg0) voidprocessEvent(jakarta.faces.event.ComponentSystemEvent arg0) voidprocessRestoreState(jakarta.faces.context.FacesContext arg0, Object arg1) processSaveState(jakarta.faces.context.FacesContext arg0) voidprocessUpdates(jakarta.faces.context.FacesContext arg0) voidprocessValidators(jakarta.faces.context.FacesContext arg0) voidpushComponentToEL(jakarta.faces.context.FacesContext arg0, jakarta.faces.component.UIComponent arg1) voidqueueEvent(jakarta.faces.event.FacesEvent arg0) protected voidremoveFacesListener(jakarta.faces.event.FacesListener arg0) static ObjectrestoreAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1) voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidrestoreTransientState(jakarta.faces.context.FacesContext arg0, Object arg1) static ObjectsaveAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1) saveState(jakarta.faces.context.FacesContext arg0) saveTransientState(jakarta.faces.context.FacesContext arg0) voidsetCustomClass(CustomClass customClass) protected voidsetDataModel(jakarta.faces.model.DataModel arg0) voidsetDisposeDelay(Integer disposeDelay) voidsetFirst(int arg0) voidsetFooter(jakarta.faces.component.UIComponent arg0) voidsetHeader(jakarta.faces.component.UIComponent arg0) voidvoidsetInView(boolean arg0) voidvoidsetParent(jakarta.faces.component.UIComponent arg0) voidsetPlacement(Placement placement) voidsetRendered(boolean arg0) voidsetRendererType(String arg0) voidsetRowIndex(int arg0) voidsetRows(int arg0) voidsetRowStatePreserved(boolean arg0) voidsetTransient(boolean arg0) voidvoidsetValueExpression(String arg0, jakarta.el.ValueExpression arg1) voidvoidsubscribeToEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1) voidunsubscribeFromEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1) booleanvisitTree(jakarta.faces.component.visit.VisitContext arg0, jakarta.faces.component.visit.VisitCallback arg1) Methods inherited from class AbstractUIToasts
getStates, getValue, setStatesMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
SEPARATOR_CHAR
static final char SEPARATOR_CHAR- See Also:
-
BEANINFO_KEY
- See Also:
-
COMPOSITE_COMPONENT_TYPE_KEY
- See Also:
-
COMPOSITE_FACET_NAME
- See Also:
-
FACETS_KEY
- See Also:
-
VIEW_LOCATION_KEY
- See Also:
-
ATTRS_WITH_DECLARED_DEFAULT_VALUES
- See Also:
-
bindings
Deprecated.
-
-
Constructor Details
-
UIToasts
public UIToasts()
-
-
Method Details
-
getEventNames
-
getDefaultEventName
-
getFamily
-
getDisposeDelay
Delay in milliseconds before hiding the toast. Default is "5000". Set to "-1" to never automatically hide the toast.
Default:5000- Specified by:
getDisposeDelayin classAbstractUIToasts
-
setDisposeDelay
-
getMarkup
-
setMarkup
-
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
-
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:
getPlacementin classAbstractUIToasts
-
setPlacement
-
restoreState
-
addClientBehavior
-
getClientBehaviors
-
invokeOnComponent
public boolean invokeOnComponent(jakarta.faces.context.FacesContext arg0, String arg1, jakarta.faces.component.ContextCallback arg2) throws jakarta.faces.FacesException - Throws:
jakarta.faces.FacesException
-
setHeader
public void setHeader(jakarta.faces.component.UIComponent arg0) -
getHeader
public jakarta.faces.component.UIComponent getHeader() -
isRowAvailable
public boolean isRowAvailable() -
getRowCount
public int getRowCount() -
getRowData
-
getRowIndex
public int getRowIndex() -
setRowIndex
public void setRowIndex(int arg0) -
markInitialState
public void markInitialState() -
saveState
-
setValueExpression
-
getContainerClientId
-
queueEvent
public void queueEvent(jakarta.faces.event.FacesEvent arg0) -
broadcast
public void broadcast(jakarta.faces.event.FacesEvent arg0) throws jakarta.faces.event.AbortProcessingException - Throws:
jakarta.faces.event.AbortProcessingException
-
createUniqueId
-
encodeBegin
- Throws:
IOException
-
encodeEnd
- Throws:
IOException
-
processDecodes
public void processDecodes(jakarta.faces.context.FacesContext arg0) -
processValidators
public void processValidators(jakarta.faces.context.FacesContext arg0) -
processUpdates
public void processUpdates(jakarta.faces.context.FacesContext arg0) -
getDataModel
protected jakarta.faces.model.DataModel getDataModel() -
setDataModel
protected void setDataModel(jakarta.faces.model.DataModel arg0) -
setValue
-
getFirst
public int getFirst() -
setFirst
public void setFirst(int arg0) -
getRows
public int getRows() -
setRows
public void setRows(int arg0) -
getVar
-
visitTree
public boolean visitTree(jakarta.faces.component.visit.VisitContext arg0, jakarta.faces.component.visit.VisitCallback arg1) -
setVar
-
isRowStatePreserved
public boolean isRowStatePreserved() -
setRowStatePreserved
public void setRowStatePreserved(boolean arg0) -
setId
-
setParent
public void setParent(jakarta.faces.component.UIComponent arg0) -
addClientBehavior
-
clearInitialState
public void clearInitialState() -
decode
public void decode(jakarta.faces.context.FacesContext arg0) -
encodeAll
- Throws:
IOException
-
encodeChildren
- Throws:
IOException
-
findComponent
-
getAttributes
-
getPassThroughAttributes
-
getChildCount
public int getChildCount() -
getChildren
-
getClientBehaviors
-
getClientId
-
getFacet
-
getFacetCount
public int getFacetCount() -
getFacets
-
getFacetsAndChildren
-
getId
-
getParent
public jakarta.faces.component.UIComponent getParent() -
getRendererType
-
getRendersChildren
public boolean getRendersChildren() -
isRendered
public boolean isRendered() -
isTransient
public boolean isTransient() -
addFacesListener
protected void addFacesListener(jakarta.faces.event.FacesListener arg0) -
getFacesContext
protected jakarta.faces.context.FacesContext getFacesContext() -
getFacesListeners
-
getRenderer
protected jakarta.faces.render.Renderer getRenderer(jakarta.faces.context.FacesContext arg0) -
removeFacesListener
protected void removeFacesListener(jakarta.faces.event.FacesListener arg0) -
processSaveState
-
processRestoreState
-
setTransient
public void setTransient(boolean arg0) -
saveAttachedState
-
restoreAttachedState
public static Object restoreAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1) throws IllegalStateException - Throws:
IllegalStateException
-
setRendered
public void setRendered(boolean arg0) -
setRendererType
-
getPassThroughAttributes
-
initialStateMarked
public boolean initialStateMarked() -
isCompositeComponent
public static boolean isCompositeComponent(jakarta.faces.component.UIComponent arg0) -
isInView
public boolean isInView() -
isVisitable
protected boolean isVisitable(jakarta.faces.component.visit.VisitContext arg0) -
getClientId
-
getCompositeComponentParent
public static jakarta.faces.component.UIComponent getCompositeComponentParent(jakarta.faces.component.UIComponent arg0) -
getCurrentComponent
public static jakarta.faces.component.UIComponent getCurrentComponent(jakarta.faces.context.FacesContext arg0) -
getCurrentCompositeComponent
public static jakarta.faces.component.UIComponent getCurrentCompositeComponent(jakarta.faces.context.FacesContext arg0) -
getListenersForEventClass
-
getNamingContainer
public jakarta.faces.component.UIComponent getNamingContainer() -
setInView
public void setInView(boolean arg0) -
getResourceBundleMap
-
getValueExpression
-
processEvent
public void processEvent(jakarta.faces.event.ComponentSystemEvent arg0) throws jakarta.faces.event.AbortProcessingException - Throws:
jakarta.faces.event.AbortProcessingException
-
subscribeToEvent
public void subscribeToEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1) -
unsubscribeFromEvent
public void unsubscribeFromEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1) -
getStateHelper
protected jakarta.faces.component.StateHelper getStateHelper() -
getStateHelper
protected jakarta.faces.component.StateHelper getStateHelper(boolean arg0) -
getTransientStateHelper
public jakarta.faces.component.TransientStateHelper getTransientStateHelper() -
getTransientStateHelper
public jakarta.faces.component.TransientStateHelper getTransientStateHelper(boolean arg0) -
restoreTransientState
-
saveTransientState
-
popComponentFromEL
public void popComponentFromEL(jakarta.faces.context.FacesContext arg0) -
pushComponentToEL
public void pushComponentToEL(jakarta.faces.context.FacesContext arg0, jakarta.faces.component.UIComponent arg1)
-