@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UIPush extends AbstractPush implements javax.faces.component.behavior.ClientBehaviorHolder
The <a4j:push> component performs real-time updates on the client side from events triggered at the server side. The events are pushed out to the client through the RichFaces messaging queue (which is bound to Java Messaging Service - JMS). When the <a4j:push> component is triggered by a server event, it can in turn cause Ajax updates and changes.
Modifier and Type | Class and Description |
---|---|
protected static class |
UIPush.Properties |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
Constructor and Description |
---|
UIPush() |
Modifier and Type | Method and Description |
---|---|
String |
getAddress()
References the topic on the JMS server that contains the pushed messages
|
String |
getDefaultEventName() |
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getOndataavailable()
The client-side script method to be called when a push notification is received
|
String |
getOnerror()
The client-side script method to be called when an error has occurred with the push notifications
|
String |
getOnsubscribed()
The client-side script method to be called when push is subscribed successfully to the topic.
|
void |
setAddress(String address) |
void |
setOndataavailable(String ondataavailable) |
void |
setOnerror(String onerror) |
void |
setOnsubscribed(String onsubscribed) |
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, 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, subscribeToEvent, unsubscribeFromEvent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class AbstractPush
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public String getAddress()
AbstractPush
getAddress
in class AbstractPush
public void setAddress(String address)
public String getOndataavailable()
AbstractPush
getOndataavailable
in class AbstractPush
public void setOndataavailable(String ondataavailable)
public String getOnerror()
AbstractPush
getOnerror
in class AbstractPush
public void setOnerror(String onerror)
public String getOnsubscribed()
AbstractPush
getOnsubscribed
in class AbstractPush
public void setOnsubscribed(String onsubscribed)
Copyright © 2014 JBoss by Red Hat. All Rights Reserved.