|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.2.0) E17488-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.adf.view.rich.context.WindowIdProvider
public abstract class WindowIdProvider
A class responsible for identifying the IDs of windows and providing notification as new windows are opened and closed. An instance of this class may be obtained from AdfFacesContext.
Constructor Summary | |
---|---|
protected |
WindowIdProvider() Create a WindowIdProvider. |
Method Summary | |
---|---|
abstract void |
addWindowCloseListener(WindowCloseListener listener) Adds a WindowCloseListener. |
java.lang.String |
decodeWindowId(javax.faces.context.ExternalContext externalContext) Gets the window Id from the passed-in ExternalContext. |
abstract java.lang.String |
getCurrentWindowId(javax.faces.context.FacesContext context) Gets the ID for the current window, or null if no ID is known. |
java.lang.String |
getRedirectURL(java.lang.String url) This method returns the initial URL that we want to redirect to. |
abstract boolean |
isNewWindow(javax.faces.context.FacesContext context) Returns true if the current request is known to come from a new window. |
boolean |
isWindowIdAvailable(javax.faces.context.FacesContext context) Returns whether a window ID would be available if necessary. |
boolean |
needsWindowUnloadedEvents(javax.faces.context.FacesContext context) Returns whether WindowUnloadedEvents are desired for this specific request. |
abstract void |
removeWindowCloseListener(WindowCloseListener listener) Removes a WindowCloseListener. |
abstract void |
windowClosed(javax.faces.context.FacesContext context, java.lang.String windowId) Called to notify the WindowIdProvider implementation that a window has been closed. |
java.lang.String |
windowOpened(javax.faces.context.ExternalContext externalContext, java.lang.String baseWindowId, boolean isDialog) Called to notify the WindowIdProvider implementation that a new window has been opened. |
abstract java.lang.String |
windowOpened(javax.faces.context.FacesContext context, java.lang.String baseWindowId) Called to notify the WindowIdProvider implementation that a new window has been opened. |
void |
windowUnloaded(WindowUnloadedEvent event) Provides notification that a window has been unloaded. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected WindowIdProvider()
Method Detail |
---|
public abstract java.lang.String getCurrentWindowId(javax.faces.context.FacesContext context)
public abstract boolean isNewWindow(javax.faces.context.FacesContext context)
public abstract java.lang.String windowOpened(javax.faces.context.FacesContext context, java.lang.String baseWindowId)
baseWindowId
- the ID of the window that launched this, or null if no window is known as the sourcepublic java.lang.String windowOpened(javax.faces.context.ExternalContext externalContext, java.lang.String baseWindowId, boolean isDialog)
baseWindowId
- the ID of the window that launched this, or null if no window is known as the sourceisDialog
- boolean indicates whether the newly opened window is a dialog. The implementation of this interface may choose to return a different URL in case of a dialog.public abstract void windowClosed(javax.faces.context.FacesContext context, java.lang.String windowId)
public abstract void addWindowCloseListener(WindowCloseListener listener)
public abstract void removeWindowCloseListener(WindowCloseListener listener)
public boolean isWindowIdAvailable(javax.faces.context.FacesContext context)
public boolean needsWindowUnloadedEvents(javax.faces.context.FacesContext context)
This method will most often be called during the Render Response phase, but may be called at any part of the JSF lifecycle if a redirect is requested.
context
- the FacesContext instancepublic void windowUnloaded(WindowUnloadedEvent event)
The implementer of this method cannot take any action to attempt to redirect, etc. - the only allowable action is updating application state. The lifecycle will terminate after this method is invoked, and any outcomes (setting the view root, etc.) will be ignored.
This method may be called at any point in the JSF lifecycle.
event
- the WindowUnloadedEventpublic java.lang.String decodeWindowId(javax.faces.context.ExternalContext externalContext)
externalContext
-public java.lang.String getRedirectURL(java.lang.String url)
url
- the original URL
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.2.0) E17488-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |