|
RichFaces UI Components UI 4.2.0.Final | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.richfaces.component.AbstractPush
org.richfaces.component.UIPush
@Generated(value={"RichFaces CDK","4.2.0.Final"})
public class UIPush
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.
| Nested Class Summary | |
|---|---|
protected static class |
UIPush.Properties
|
| Field Summary | |
|---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
| Fields inherited from class javax.faces.component.UIComponent |
|---|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY |
| Constructor Summary | |
|---|---|
UIPush()
|
|
| Method Summary | |
|---|---|
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 |
void |
setAddress(String address)
|
void |
setOndataavailable(String ondataavailable)
|
void |
setOnerror(String onerror)
|
| 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, getListenersForEventClass, 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, subscribeToEvent, unsubscribeFromEvent |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, 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 |
|---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
| Constructor Detail |
|---|
public UIPush()
| Method Detail |
|---|
public String getFamily()
getFamily in class AbstractPushpublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic String getAddress()
AbstractPush
getAddress in class AbstractPushpublic void setAddress(String address)
public String getOndataavailable()
AbstractPush
getOndataavailable in class AbstractPushpublic void setOndataavailable(String ondataavailable)
public String getOnerror()
AbstractPush
getOnerror in class AbstractPushpublic void setOnerror(String onerror)
|
RichFaces UI Components UI 4.2.0.Final | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||