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

Constructor Summary

Constructors

Constructor	Description
WebsocketComponent()

Method Summary

Modifier and Type	Method	Description
String	getChannel()
String	getFamily()
String	getOnclose()
String	getOnmessage()
String	getOnopen()
String	getScope()
String	getUser()
boolean	isConnected()
void	setChannel(String channel)
void	setConnected(boolean connected)
void	setOnclose(String onclose)
void	setOnmessage(String onmessage)
void	setOnopen(String onopen)
void	setScope(String scope)
void	setUser(String user)

Methods inherited from class org.apache.myfaces.push.AbstractWebsocketComponent

getEventNames

Methods inherited from class jakarta.faces.component.UIOutput

clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, restoreState, 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, 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 java.lang.Object

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

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

addClientBehavior, getClientBehaviors, getDefaultEventName

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

WebsocketComponent

public WebsocketComponent()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UIOutput

getChannel

public String getChannel()

Specified by:

getChannel in class AbstractWebsocketComponent

setChannel

public void setChannel(String channel)

getScope

public String getScope()

Specified by:

getScope in class AbstractWebsocketComponent

setScope

public void setScope(String scope)

getUser

public String getUser()

Specified by:

getUser in class AbstractWebsocketComponent

setUser

public void setUser(String user)

getOnopen

public String getOnopen()

Specified by:

getOnopen in class AbstractWebsocketComponent

setOnopen

public void setOnopen(String onopen)

getOnmessage

public String getOnmessage()

Specified by:

getOnmessage in class AbstractWebsocketComponent

setOnmessage

public void setOnmessage(String onmessage)

getOnclose

public String getOnclose()

Specified by:

getOnclose in class AbstractWebsocketComponent

setOnclose

public void setOnclose(String onclose)

isConnected

public boolean isConnected()

Specified by:

isConnected in class AbstractWebsocketComponent

setConnected

public void setConnected(boolean connected)