Skip navigation links
oracle.adf.view.rich.event
Class RegionRemoteRefreshEvent
java.lang.Object
java.util.EventObject
javax.faces.event.FacesEvent
oracle.adf.view.rich.event.RegionRemoteRefreshEvent
- All Implemented Interfaces:
- java.io.Serializable
-
public class RegionRemoteRefreshEvent
- extends javax.faces.event.FacesEvent
Instructions a region to refresh its content.
- See Also:
- Serialized Form
Fields inherited from class java.util.EventObject |
source |
Method Summary |
UIXRegion |
getRegionComponent()
Convenience method to cast the component to a UIXRegion. |
RemoteRegionModel |
getRemoteRegionModel()
Convenience method to get the RemoteRegionModel. |
boolean |
isAppropriateListener(javax.faces.event.FacesListener facesListener)
Returns true if and only if the FacesListener is an instance of the RegionRefreshListener. |
void |
processListener(javax.faces.event.FacesListener facesListener)
Processes the FacesListener if and only if the FacesListener is an instance of RegionRefreshlistener and if the supplied UIComponent is a UIXRegion bound to a RemoteRegionModel. |
Methods inherited from class javax.faces.event.FacesEvent |
getComponent, getPhaseId, queue, setPhaseId |
Methods inherited from class java.util.EventObject |
getSource, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
RegionRemoteRefreshEvent
public RegionRemoteRefreshEvent(javax.faces.component.UIComponent uiComponent)
getRegionComponent
public UIXRegion getRegionComponent()
- Convenience method to cast the component to a UIXRegion. This event will only get delivered when we have a UIXRegion bound to a RemoteRegionModel, so this should always return a result if it is delivered to an event.
-
- Returns:
- the
UIXRegionComponent
associated with this event or null
in the case that this event was queued on the wrong component.
getRemoteRegionModel
public RemoteRegionModel getRemoteRegionModel()
- Convenience method to get the RemoteRegionModel. This event will only get delivered if we have a UIXRemoteRegion bound to a RemoteRegionModel, so this should always return a result if it is delivered to an event.
-
- Returns:
- the RemoteRegionModel or
null
if there is none.
isAppropriateListener
public boolean isAppropriateListener(javax.faces.event.FacesListener facesListener)
- Returns true if and only if the FacesListener is an instance of the RegionRefreshListener.
-
- Specified by:
isAppropriateListener
in class javax.faces.event.FacesEvent
-
- Parameters:
facesListener
-
- Returns:
processListener
public void processListener(javax.faces.event.FacesListener facesListener)
- Processes the FacesListener if and only if the FacesListener is an instance of RegionRefreshlistener and if the supplied UIComponent is a UIXRegion bound to a RemoteRegionModel. If any of these are not valid, the event will not be delivered.
-
- Specified by:
processListener
in class javax.faces.event.FacesEvent
-
- Parameters:
facesListener
-
Skip navigation links
Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.