org.primefaces.component.socket

Class Socket

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.primefaces.component.socket.Socket

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, PrimeClientBehaviorHolder, Widget

public class Socket
extends javax.faces.component.UIComponentBase
implements Widget, javax.faces.component.behavior.ClientBehaviorHolder, PrimeClientBehaviorHolder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Socket.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	DEFAULT_RENDERER

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
Socket()

Method Summary

Modifier and Type	Method and Description
Map<String,Class<? extends javax.faces.event.BehaviorEvent>>	getBehaviorEventMapping()
String	getChannel()
String	getDefaultEventName()
Collection<String>	getEventNames()
String	getFallbackTransport()
String	getFamily()
String	getOnClose()
String	getOnError()
String	getOnLocalMessage()
String	getOnMessage()
String	getOnMessagePublished()
String	getOnOpen()
String	getOnReconnect()
String	getOnTransportFailure()
String	getTransport()
String	getWidgetVar()
boolean	isAutoConnect()
String	resolveWidgetVar()
void	setAutoConnect(boolean _autoConnect)
void	setChannel(String _channel)
void	setFallbackTransport(String _fallbackTransport)
void	setOnClose(String _onClose)
void	setOnError(String _onError)
void	setOnLocalMessage(String _onLocalMessage)
void	setOnMessage(String _onMessage)
void	setOnMessagePublished(String _onMessagePublished)
void	setOnOpen(String _onOpen)
void	setOnReconnect(String _onReconnect)
void	setOnTransportFailure(String _onTransportFailure)
void	setTransport(String _transport)
void	setWidgetVar(String _widgetVar)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods inherited from class java.lang.Object

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

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

addClientBehavior, getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

DEFAULT_RENDERER

public static final String DEFAULT_RENDERER

See Also:

Constant Field Values

Constructor Detail

Socket

public Socket()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getWidgetVar

public String getWidgetVar()

setWidgetVar

public void setWidgetVar(String _widgetVar)

getChannel

public String getChannel()

setChannel

public void setChannel(String _channel)

getTransport

public String getTransport()

setTransport

public void setTransport(String _transport)

getFallbackTransport

public String getFallbackTransport()

setFallbackTransport

public void setFallbackTransport(String _fallbackTransport)

getOnMessage

public String getOnMessage()

setOnMessage

public void setOnMessage(String _onMessage)

getOnError

public String getOnError()

setOnError

public void setOnError(String _onError)

getOnClose

public String getOnClose()

setOnClose

public void setOnClose(String _onClose)

getOnOpen

public String getOnOpen()

setOnOpen

public void setOnOpen(String _onOpen)

getOnReconnect

public String getOnReconnect()

setOnReconnect

public void setOnReconnect(String _onReconnect)

getOnMessagePublished

public String getOnMessagePublished()

setOnMessagePublished

public void setOnMessagePublished(String _onMessagePublished)

getOnTransportFailure

public String getOnTransportFailure()

setOnTransportFailure

public void setOnTransportFailure(String _onTransportFailure)

getOnLocalMessage

public String getOnLocalMessage()

setOnLocalMessage

public void setOnLocalMessage(String _onLocalMessage)

isAutoConnect

public boolean isAutoConnect()

setAutoConnect

public void setAutoConnect(boolean _autoConnect)

getBehaviorEventMapping

public Map<String,Class<? extends javax.faces.event.BehaviorEvent>> getBehaviorEventMapping()

Specified by:

getBehaviorEventMapping in interface PrimeClientBehaviorHolder

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

resolveWidgetVar

public String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface Widget