| aWindowType |
the returned enumerator will enumerate only
windows of this type. ("type" is the
|windowtype| attribute of the XML element.)
If null, all windows will be enumerated.
#### Returns ####
| an enumerator of nsIDOMWindows. Note that windows close
asynchronously in many cases, so windows returned from this
enumerator can have .closed set to true. Caveat enumerator!
|
### getXULWindowEnumerator(aWindowType) ###
Identical to getEnumerator except:
#### Returns ####
| an enumerator of nsIXULWindows
|
### getZOrderDOMWindowEnumerator(aWindowType, aFrontToBack) ###
Return an enumerator which iterates over all windows of type aWindowType
in their z (front-to-back) order. Note this interface makes
no requirement that a window couldn't be revisited if windows
are re-ordered while z-order enumerators are active.
#### Parameters ####
| aWindowType |
the returned enumerator will enumerate only
windows of this type. ("type" is the
|windowtype| attribute of the XML element.)
If null, all windows will be enumerated.
| aFrontToBack |
if true, the enumerator enumerates windows in order
from front to back. back to front if false.
|
#### Returns ####
| an enumerator of nsIDOMWindows
|
### getZOrderXULWindowEnumerator(aWindowType, aFrontToBack) ###
Identical to getZOrderDOMWindowEnumerator except:
#### Returns ####
| an enumerator of nsIXULWindows
|
### getMostRecentWindow(aWindowType) ###
This is a shortcut for simply fetching the first window in
front to back order.
#### Parameters ####
| aWindowType |
return the topmost window of this type.
("type" is the |windowtype| attribute of
the XML element.)
If null, return the topmost window of any type.
#### Returns ####
### getOuterWindowWithId(aOuterWindowID) ###
Return the outer window with the given ID, if any. Can return null.
### getCurrentInnerWindowWithId(aInnerWindowID) ###
Return the outer window with the given current window ID, if any.
Can return null if no inner window with the ID exists or if it's not
a current inner anymore.
### registerWindow(aWindow) ###
Add the window to the list of known windows. Listeners (see
addListener) will be notified through their onOpenWindow method.
#### Parameters ####
| aWindow |
the window to add
|
### unregisterWindow(aWindow) ###
Remove the window from the list of known windows. Listeners (see
addListener) will be be notified through their onCloseWindow method.
#### Parameters ####
| aWindow |
the window to remove
|
### updateWindowTimeStamp(aWindow) ###
Call this method when a window gains focus. It's a primitive means of
determining the most recent window. It's no longer necessary and it
really should be removed.
#### Parameters ####
| aWindow |
the window which has gained focus
|
### updateWindowTitle(aWindow, inTitle) ###
Call this method when a window's title changes. Listeners (see
addListener) will be notified through their onWindowTitleChange method.
#### Parameters ####
| aWindow |
the window whose title has changed
|
| inTitle |
the window's new title
|
### calculateZPosition(inWindow, inPosition, inBelow, outPosition, outBelow) ###
A window wants to be moved in z-order. Calculate whether and how
it should be constrained. Note this method is advisory only:
it changes nothing either in WindowMediator's internal state
or with the window.
Note it compares the nsIXULWindow to nsIWidgets. A pure interface
would use all nsIXULWindows. But we expect this to be called from
callbacks originating in native window code. They are expected to
hand us comparison values which are pulled from general storage
in the native widget, and may not correspond to an nsIWidget at all.
For that reason this interface requires only objects one step
removed from the native window (nsIWidgets), and its implementation
must be very understanding of what may be completely invalid
pointers in those parameters.
#### Parameters ####
| inWindow |
the window in question
|
| inPosition |
requested position
values: zLevelTop: topmost window. zLevelBottom: bottom.
zLevelBelow: below ioBelow. (the value of ioBelow will
be ignored for zLevelTop and Bottom.)
|
| inBelow |
if inPosition==zLevelBelow, the window
below which inWindow wants to be placed. Otherwise this
variable is ignored.
|
| outPosition |
constrained position, values like inPosition.
|
| outBelow |
if outPosition==zLevelBelow, the window
below which inWindow should be placed. Otherwise this
this value will be null.
|
#### Returns ####
| PR_TRUE if the position returned is different from
the position given.
|
### setZPosition(inWindow, inPosition, inBelow) ###
A window has been positioned behind another. Inform WindowMediator
#### Parameters ####
| inWindow |
the window in question
|
| inPosition |
new position. values:
zLevelTop: topmost window.
zLevelBottom: bottom.
zLevelBelow: below inBelow. (inBelow is ignored
for other values of inPosition.)
|
| inBelow |
the window inWindow is behind, if zLevelBelow
|
### getZLevel(aWindow) ###
Return the window's Z level (as defined in nsIXULWindow).
#### Parameters ####
| aWindow |
the window in question
|
#### Returns ####
### setZLevel(aWindow, aZLevel) ###
Set the window's Z level (as defined in nsIXULWindow). The implementation
will reposition the window as necessary to match its new Z level.
The implementation will assume a window's Z level to be
nsIXULWindow::normalZ until it has been informed of a different level.
#### Parameters ####
| aWindow |
the window in question
|
| aZLevel |
the window's new Z level
|
### addListener(aListener) ###
Register a listener for window status changes.
keeps strong ref? (to be decided)
#### Parameters ####
| aListener |
the listener to register
|
### removeListener(aListener) ###
Unregister a listener of window status changes.
#### Parameters ####
| aListener |
the listener to unregister
|
## Constants ##
### zLevelTop ###
### zLevelBottom ###
### zLevelBelow ###
| | |