public abstract class WindowManager extends Object
Manages the set of Windows currently in the Session and allows listeners on the Windows' lifecycles to be registered.
RequestContext.getWindowManager()
Constructor and Description |
---|
WindowManager() |
Modifier and Type | Method and Description |
---|---|
abstract void |
addWindowLifecycleListener(javax.faces.context.ExternalContext extContext,
WindowLifecycleListener windowListener)
Registers a listener that will be informed of changes to the Lifecylce state of any of
the known Windows.
|
abstract Window |
getCurrentWindow(javax.faces.context.ExternalContext extContext) |
abstract Map<String,? extends Window> |
getWindows(javax.faces.context.ExternalContext extContext) |
abstract void |
removeWindowLifecycleListener(javax.faces.context.ExternalContext extContext,
WindowLifecycleListener windowListener)
Removes a listener that will be informed of changes to the Lifecylce state of any of
the known Windows
|
abstract void |
writeState(javax.faces.context.FacesContext context)
Performs any necessary action to embed the current window identifier into the output
|
public abstract Window getCurrentWindow(javax.faces.context.ExternalContext extContext)
extContext
- ExternalContext so that the WindowManager may be called before the
FacesContext is availablepublic abstract Map<String,? extends Window> getWindows(javax.faces.context.ExternalContext extContext)
extContext
- ExternalContext so that the WindowManager may be called before the
FacesContext is availablepublic abstract void addWindowLifecycleListener(javax.faces.context.ExternalContext extContext, WindowLifecycleListener windowListener)
Registers a listener that will be informed of changes to the Lifecylce state of any of the known Windows.
WindowLifecycleListener may be registered automatically by adding a file
containing the names of the classes implementing the WindowListener in a file named
org.apache.myfaces.trinidad.event.WindowListener
inside of
the META_INF/services
directory.
extContext
- ExternalContext so that the WindowManager may be called before the
FacesContext is availablewindowListener
- public abstract void removeWindowLifecycleListener(javax.faces.context.ExternalContext extContext, WindowLifecycleListener windowListener)
extContext
- ExternalContext so that the WindowManager may be called before the
FacesContext is availablewindowListener
- public abstract void writeState(javax.faces.context.FacesContext context) throws IOException
context
- FacesContext to use to write the outputIOException
- if an output exception occursCopyright © 2001-2016 The Apache Software Foundation. All Rights Reserved.