Package org.apache.myfaces.push

Class AbstractWebsocketComponent

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

org.apache.myfaces.push.AbstractWebsocketComponent

All Implemented Interfaces:

ClientBehaviorHolder, PartialStateHolder, StateHolder, TransientStateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener

Direct Known Subclasses:

WebsocketComponent

@JSFComponent(clazz="org.apache.myfaces.push.WebsocketComponent",
              family="jakarta.faces.Output",
              type="org.apache.myfaces.WebsocketComponent",
              defaultRendererType="org.apache.myfaces.WebsocketComponent")
public abstract class AbstractWebsocketComponent
extends UIOutput
implements ClientBehaviorHolder

This component hold f:websocket client behavior and other properties.

Field Summary

Fields inherited from class jakarta.faces.component.UIOutput

COMPONENT_FAMILY, 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
AbstractWebsocketComponent()

Method Summary

Modifier and Type	Method	Description
abstract String	getChannel()
Collection<String>	getEventNames()
abstract String	getOnclose()
abstract String	getOnmessage()
abstract String	getOnopen()
abstract String	getScope()
abstract String	getUser()
abstract boolean	isConnected()

Methods inherited from class jakarta.faces.component.UIOutput

clearInitialState, getConverter, getFamily, 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

Constructor Detail

AbstractWebsocketComponent

public AbstractWebsocketComponent()

Method Detail

getChannel

@JSFProperty
public abstract String getChannel()

getScope

@JSFProperty
public abstract String getScope()

getUser

@JSFProperty
public abstract String getUser()

getOnopen

@JSFProperty
public abstract String getOnopen()

getOnmessage

@JSFProperty
public abstract String getOnmessage()

getOnclose

@JSFProperty
public abstract String getOnclose()

isConnected

@JSFProperty(defaultValue="true")
public abstract boolean isConnected()

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface ClientBehaviorHolder

Overrides:

getEventNames in class UIComponentBase