Package org.apache.myfaces.push
Class WebsocketComponent
- java.lang.Object
- 
- jakarta.faces.component.UIComponent
- 
- jakarta.faces.component.UIComponentBase
- 
- jakarta.faces.component.UIOutput
- 
- org.apache.myfaces.push.AbstractWebsocketComponent
- 
- org.apache.myfaces.push.WebsocketComponent
 
 
 
 
 
- 
- All Implemented Interfaces:
- ClientBehaviorHolder,- PartialStateHolder,- StateHolder,- TransientStateHolder,- ValueHolder,- ComponentSystemEventListener,- FacesListener,- SystemEventListenerHolder,- EventListener
 
 public class WebsocketComponent extends AbstractWebsocketComponent 
- 
- 
Field SummaryFields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE- 
Fields 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_KEY
 
- 
 - 
Constructor SummaryConstructors Constructor Description WebsocketComponent()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetChannel()StringgetFamily()StringgetOnclose()StringgetOnmessage()StringgetOnopen()StringgetScope()StringgetUser()booleanisConnected()voidsetChannel(String channel)voidsetConnected(boolean connected)voidsetOnclose(String onclose)voidsetOnmessage(String onmessage)voidsetOnopen(String onopen)voidsetScope(String scope)voidsetUser(String user)- 
Methods inherited from class org.apache.myfaces.push.AbstractWebsocketComponentgetEventNames
 - 
Methods inherited from class jakarta.faces.component.UIOutputclearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValue
 - 
Methods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, addFacesListener, broadcast, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, 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.UIComponentgetClientId, 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 java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolderaddClientBehavior, getClientBehaviors, getDefaultEventName
 
- 
 
- 
- 
- 
Field Detail- 
COMPONENT_FAMILYpublic static final String COMPONENT_FAMILY - See Also:
- Constant Field Values
 
 - 
COMPONENT_TYPEpublic static final String COMPONENT_TYPE - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getChannelpublic String getChannel() - Specified by:
- getChannelin class- AbstractWebsocketComponent
 
 - 
setChannelpublic void setChannel(String channel) 
 - 
getScopepublic String getScope() - Specified by:
- getScopein class- AbstractWebsocketComponent
 
 - 
setScopepublic void setScope(String scope) 
 - 
getUserpublic String getUser() - Specified by:
- getUserin class- AbstractWebsocketComponent
 
 - 
setUserpublic void setUser(String user) 
 - 
getOnopenpublic String getOnopen() - Specified by:
- getOnopenin class- AbstractWebsocketComponent
 
 - 
setOnopenpublic void setOnopen(String onopen) 
 - 
getOnmessagepublic String getOnmessage() - Specified by:
- getOnmessagein class- AbstractWebsocketComponent
 
 - 
setOnmessagepublic void setOnmessage(String onmessage) 
 - 
getOnclosepublic String getOnclose() - Specified by:
- getOnclosein class- AbstractWebsocketComponent
 
 - 
setOnclosepublic void setOnclose(String onclose) 
 - 
isConnectedpublic boolean isConnected() - Specified by:
- isConnectedin class- AbstractWebsocketComponent
 
 - 
setConnectedpublic void setConnected(boolean connected) 
 
- 
 
-