public final class NullDataUpdateManager extends DataUpdateManager
Modifier and Type | Method and Description |
---|---|
Iterator<ActiveDataEvent> |
getEventCache(String clientId)
Returns all ActiveDataEvents cached for the given UIComponent (registered using
registerComponentForPPRAndCacheEvents ) |
static DataUpdateManager |
getInstance() |
Iterator<String> |
getPartialTargets(javax.faces.context.FacesContext context)
Check if the given component is partial target
|
Set<String> |
getRegisteredPPRComponentIds()
Returns the set of registered automatic PPR components' id.
|
Set<ActiveDataModel.ActiveDataPolicy> |
getSupportedPolicies()
Returns the Set of ActiveDataPolicies supported by this DataUpdateManager.
|
void |
registerComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ActiveDataModel model, ActiveDataEncoder encoder)
Register active or PPR coomponent's model and encoder.
|
void |
registerComponentForPPR(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ActiveDataModel model, AutoPPRFilter filter)
Registers a component as interested in being automatically re-rendered in the next render phase in response to changes on an ActiveDataModel.
|
void |
registerComponentForPPRAndCacheEvents(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ActiveDataModel model)
Registers a component as interested in being automatically re-rendered in the next render phase in response to changes on an ActiveDataModel.
|
void |
registerSubtrees(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Collection<Object> rowKeys)
Register component with the collections identified by the rowKeys.
|
void |
reregisterComponentForPPR(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
Re-registers a previously registered component for being automatically re-rendered in the next render phase in response to changes on an ActiveDataModel.
|
void |
startActiveData(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, int startChangeCount)
Called when a previously registered component is ready to being receiving active data starting from a specified
startChangeCount . |
void |
unregisterComponent(javax.faces.context.FacesContext context, String clientId)
Unregister the component from the DataUpdateManager
|
void |
unregisterSubtrees(javax.faces.context.FacesContext context, String clientId, Collection<Object> rowKeys)
Unregister component from the collections of the containers identified by the rowKeys
|
getModelList, getRegisteredEncoder
public static DataUpdateManager getInstance()
public Set<ActiveDataModel.ActiveDataPolicy> getSupportedPolicies()
getSupportedPolicies
in class DataUpdateManager
public void registerComponentForPPR(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ActiveDataModel model, AutoPPRFilter filter)
registerComponentForPPR
in class DataUpdateManager
context
- current FacesContextcomponent
- Component interested in being automatically PPR'ed in response to model changes.model
- ActiveDataModel to listen for ActiveDataEvents onfilter
- AutoPPRFilter used to determine if ActiveDataEvents generated by the ActiveDataModel should cause the component to be rerendered in the next rendering phase.public void registerComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ActiveDataModel model, ActiveDataEncoder encoder)
registerComponent
in class DataUpdateManager
context
- current FacesContextcomponent
- the UI component to be registeredencoder
- the ActiveDataEncoder used for encoding the active data generated for the UI component. If this value is null
, the component will be registered as PPR component. Otherwise, the component will be registered as active component.model
- Active Data model which will generate active eventsActiveDataEncoder
public void registerSubtrees(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Collection<Object> rowKeys)
registerSubtrees
in class DataUpdateManager
context
- current FacesContextcomponent
- the UI component to be registeredrowKeys
- the container row keys of collections from which the component is to receive active data eventsIllegalArgumentException
- if rowKeys
is null
IllegalStateException
- if the component is not registered for its _model and encoderpublic void startActiveData(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, int startChangeCount)
startChangeCount
. In order to handle error cases, the startChangeCount
may be earlier than the changeCount
of the most recent events delivered by the ActiveDataModel, however the startChangeCount
should never be later than the most recent received changeCount
.startActiveData
in class DataUpdateManager
context
- current FacesContextcomponent
- the UI component to beging receiving active datastartChangeCount
- Event change count to start sending active data from.IllegalStateException
- if the component is already started or the eventId is later than the most recently delivered eventIdpublic void unregisterComponent(javax.faces.context.FacesContext context, String clientId)
unregisterComponent
in class DataUpdateManager
context
- current FacesContextclientId
- UI Component to unregisterIllegalArgumentException
- if rowKeys
is null
public void unregisterSubtrees(javax.faces.context.FacesContext context, String clientId, Collection<Object> rowKeys)
unregisterSubtrees
in class DataUpdateManager
context
- current FacesContextclientId
- UI Component to unregisterrowKeys
- the container row keys of collections from which the component has regsitered to receive active data eventsIllegalArgumentException
- if rowKeys
is null
public Iterator<String> getPartialTargets(javax.faces.context.FacesContext context)
getPartialTargets
in class DataUpdateManager
context
- current FacesContextpublic Iterator<ActiveDataEvent> getEventCache(String clientId)
registerComponentForPPRAndCacheEvents
)getEventCache
in class DataUpdateManager
clientId
- of the UIComponent to cache events forpublic void registerComponentForPPRAndCacheEvents(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ActiveDataModel model)
registerComponentForPPRAndCacheEvents
in class DataUpdateManager
context
- current FacesContextcomponent
- Component interested in being automatically PPR'ed in response to model changes.model
- ActiveDataModel to listen for ActiveDataEvents on ActiveDataModel should cause the component to be rerendered in the next rendering phase.public void reregisterComponentForPPR(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
reregisterComponentForPPR
in class DataUpdateManager
context
- current FacesContextcomponent
- Component previously registered for being automatically PPR'ed in response to model changes.IllegalStateException
- if the component has not been previously registered for being automatically re-rendered.public Set<String> getRegisteredPPRComponentIds()
getRegisteredPPRComponentIds
in class DataUpdateManager