org.apache.pivot.wtk
Class Window

java.lang.Object
  extended by org.apache.pivot.wtk.Component
      extended by org.apache.pivot.wtk.Container
          extended by org.apache.pivot.wtk.Window
All Implemented Interfaces:
Iterable<Component>, Sequence<Component>, ConstrainedVisual, Visual
Direct Known Subclasses:
Frame, MenuPopup, Palette, Sheet, Tooltip

public class Window
extends Container

Top-level container representing the entry point into a user interface. Windows are direct descendants of the display.


Nested Class Summary
static class Window.ActionMapping
          Class representing a mapping from keystrokes to actions.
 class Window.ActionMappingSequence
           
static interface Window.Skin
          Window skin interface.
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Component
Component.ComponentDictionary, Component.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary
 
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence
Sequence.Tree
 
Constructor Summary
Window()
           
Window(boolean auxilliary)
           
Window(Component content)
           
Window(Component content, boolean auxilliary)
           
 
Method Summary
 void align(Bounds bounds, HorizontalAlignment horizontalAlignment, int horizontalOffset, VerticalAlignment verticalAlignment, int verticalOffset)
           
 void align(Bounds bounds, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment)
           
 void close()
          Closes the window and all of its owned windows.
protected  void descendantGainedFocus(Component descendant, Component previousFocusedComponent)
           
protected  void descendantRemoved(Component descendant)
           
 Window.ActionMappingSequence getActionMappings()
          Returns the action mappings for this window.
static Window getActiveWindow()
          Returns the currently active window.
 Bounds getClientArea()
          Returns the bounds of the window's client area.
 Component getContent()
           
 Component getFocusDescendant()
          Returns the window descendant to which focus will be restored when this window is moved to the front.
 Image getIcon()
          Returns the window's icon.
 Window getOwnedWindow(int index)
           
 int getOwnedWindowCount()
           
 Window getOwner()
           
 Window getRootOwner()
           
 String getTitle()
          Returns the window's title.
 ListenerList<WindowActionMappingListener> getWindowActionMappingListeners()
           
static ListenerList<WindowClassListener> getWindowClassListeners()
           
 ListenerList<WindowListener> getWindowListeners()
           
 ListenerList<WindowStateListener> getWindowStateListeners()
           
 boolean isActive()
          Returns the window's active state.
 boolean isAuxilliary()
          Returns the window's auxilliary flag.
 boolean isClosed()
          Returns this window's closed state.
 boolean isClosing()
          Returns this window's closing state.
 boolean isMaximized()
           
 boolean isOpen()
          Returns this window's open state.
 boolean isOpening()
          Returns this window's opening state.
 boolean isOwner(Window window)
          Tests whether this window is an owning ancestor of a given window.
 boolean keyReleased(int keyCode, Keyboard.KeyLocation keyLocation)
           
 void moveToBack()
          Moves the window to the bottom of the window stack.
 void moveToFront()
          Moves the window to the top of the window stack and restores focus to the window.
 void open(Display display)
          Opens the window.
 void open(Window owner)
          Opens the window.
 Sequence<Component> remove(int index, int count)
          Removes one or more items from the sequence.
 boolean requestActive()
          Requests that this window become the active window.
protected  void setActive(boolean active, Window obverseWindow)
          Called to notify a window that its active state has changed.
 void setContent(Component content)
           
 void setEnabled(boolean enabled)
          Sets the enabled state of this window and all of its owned descendant windows.
 void setIcon(Image icon)
          Sets the window's icon.
 void setIcon(String icon)
          Sets the window's icon by resource name.
 void setIcon(URL icon)
          Sets the window's icon by URL.
 void setMaximized(boolean maximized)
           
 void setOwner(Window owner)
           
protected  void setParent(Container parent)
           
 void setTitle(String title)
          Sets the window's title.
 void setVisible(boolean visible)
          Sets the visible state of this window and all of its owned descendant windows.
 
Methods inherited from class org.apache.pivot.wtk.Container
add, containsFocus, descendantLostFocus, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getContextKey, getDescendantAt, getFocusTraversalPolicy, getLength, indexOf, insert, isAncestor, iterator, load, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, requestFocus, setContextKey, setFocusTraversalPolicy, setTooltip, store, transferFocus, update, validate
 
Methods inherited from class org.apache.pivot.wtk.Component
clearFocus, getAttributes, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponents, getComponentStateListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getGraphics, getHandle, getHeight, getLocation, getMaximumPreferredHeight, getMaximumPreferredWidth, getMenuHandler, getMinimumPreferredHeight, getMinimumPreferredWidth, getParent, getPreferredHeight, getPreferredHeight, getPreferredHeightLimits, getPreferredSize, getPreferredWidth, getPreferredWidth, getPreferredWidthLimits, getSize, getSkin, getStyles, getTooltipText, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWindow, getX, getY, installSkin, invalidate, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyPressed, keyTyped, load, mapPointFromAncestor, mapPointToAncestor, mouseOver, repaint, repaint, repaint, repaint, repaint, repaint, scrollAreaToVisible, scrollAreaToVisible, setAttributes, setCursor, setCursor, setDragSource, setDropTarget, setHeight, setLocation, setLocation, setMaximumPreferredHeight, setMaximumPreferredWidth, setMenuHandler, setMinimumPreferredHeight, setMinimumPreferredWidth, setPreferredHeight, setPreferredHeightLimits, setPreferredHeightLimits, setPreferredSize, setPreferredSize, setPreferredWidth, setPreferredWidthLimits, setPreferredWidthLimits, setSize, setSize, setSkin, setStyles, setStyles, setStyles, setTooltipText, setWidth, setX, setY, store, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Window

public Window()

Window

public Window(boolean auxilliary)

Window

public Window(Component content)

Window

public Window(Component content,
              boolean auxilliary)
Method Detail

setParent

protected void setParent(Container parent)
Overrides:
setParent in class Container

remove

public Sequence<Component> remove(int index,
                                  int count)
Description copied from interface: Sequence
Removes one or more items from the sequence.

Specified by:
remove in interface Sequence<Component>
Overrides:
remove in class Container
Parameters:
index - The starting index to remove.
count - The number of items to remove, beginning with index.
Returns:
A sequence containing the items that were removed.

setVisible

public void setVisible(boolean visible)
Sets the visible state of this window and all of its owned descendant windows.

Overrides:
setVisible in class Container
Parameters:
visible - If true, the window and its owned descendants are visible; otherwise, they are not visible.

setEnabled

public void setEnabled(boolean enabled)
Sets the enabled state of this window and all of its owned descendant windows.

Overrides:
setEnabled in class Component
Parameters:
enabled - If true, the window and its owned descendants are enabled; otherwise, they are not enabled.

getOwner

public Window getOwner()

setOwner

public void setOwner(Window owner)

getRootOwner

public Window getRootOwner()

getOwnedWindow

public Window getOwnedWindow(int index)

getOwnedWindowCount

public int getOwnedWindowCount()

isOwner

public boolean isOwner(Window window)
Tests whether this window is an owning ancestor of a given window. A window is not considered an owner of itself.

Parameters:
window -
Returns:
true if this window is an owning ancestor of the given window; false, otherwise.

isOpen

public boolean isOpen()
Returns this window's open state.

Returns:
true if the window is open; false, otherwise.

isOpening

public boolean isOpening()
Returns this window's opening state.

Returns:
true if the window is open; false, otherwise.

open

public void open(Display display)
Opens the window.

Parameters:
display - The display on which the window will be opened.

open

public void open(Window owner)
Opens the window.

Parameters:
owner - The window's owner.

isClosed

public boolean isClosed()
Returns this window's closed state.

Returns:
true if the window is closed; false, otherwise.

isClosing

public boolean isClosing()
Returns this window's closing state.

Returns:
true if the window is closing; false, otherwise.

close

public void close()
Closes the window and all of its owned windows. If any owned window fails to close, this window will also fail to close.


getTitle

public String getTitle()
Returns the window's title.

Returns:
The pane's title, or null if no title is set.

setTitle

public void setTitle(String title)
Sets the window's title.

Parameters:
title - The new title, or null for no title.

getIcon

public Image getIcon()
Returns the window's icon.

Returns:
The window's icon, or null if the window has no icon.

setIcon

public void setIcon(Image icon)
Sets the window's icon.

Parameters:
icon - The window's icon, or null for no icon.

setIcon

public void setIcon(URL icon)
Sets the window's icon by URL.

Parameters:
icon - The location of the icon to set.

setIcon

public void setIcon(String icon)
Sets the window's icon by resource name.

Parameters:
icon - The resource name of the icon to set.

getContent

public Component getContent()

setContent

public void setContent(Component content)

getClientArea

public Bounds getClientArea()
Returns the bounds of the window's client area.


isAuxilliary

public boolean isAuxilliary()
Returns the window's auxilliary flag. Auxilliary windows can't become active and can only own other auxilliary windows.

Returns:
true if this is an auxilliary window; false, otherwise.

isActive

public boolean isActive()
Returns the window's active state.

Returns:
true if the window is active; false; otherwise.

requestActive

public boolean requestActive()
Requests that this window become the active window.

Returns:
true if the window became active; false, otherwise.

setActive

protected void setActive(boolean active,
                         Window obverseWindow)
Called to notify a window that its active state has changed.

Parameters:
active -
obverseWindow -

getActiveWindow

public static Window getActiveWindow()
Returns the currently active window.

Returns:
The window that is currently active, or null if no window is active.

getFocusDescendant

public Component getFocusDescendant()
Returns the window descendant to which focus will be restored when this window is moved to the front.


descendantGainedFocus

protected void descendantGainedFocus(Component descendant,
                                     Component previousFocusedComponent)
Overrides:
descendantGainedFocus in class Container

descendantRemoved

protected void descendantRemoved(Component descendant)
Overrides:
descendantRemoved in class Container

getActionMappings

public Window.ActionMappingSequence getActionMappings()
Returns the action mappings for this window.


moveToFront

public void moveToFront()
Moves the window to the top of the window stack and restores focus to the window. All windows owned by this window are subsequently moved to front, ensuring that this window's owned windows remain on top of it.

Finally, if it is not an auxilliary window, the window is made active.


moveToBack

public void moveToBack()
Moves the window to the bottom of the window stack. If the window is active, the active window will be cleared. If the window is the focus host, the focus will be cleared.


isMaximized

public boolean isMaximized()

setMaximized

public void setMaximized(boolean maximized)

align

public void align(Bounds bounds,
                  HorizontalAlignment horizontalAlignment,
                  VerticalAlignment verticalAlignment)

align

public void align(Bounds bounds,
                  HorizontalAlignment horizontalAlignment,
                  int horizontalOffset,
                  VerticalAlignment verticalAlignment,
                  int verticalOffset)

keyReleased

public boolean keyReleased(int keyCode,
                           Keyboard.KeyLocation keyLocation)
Overrides:
keyReleased in class Component

getWindowListeners

public ListenerList<WindowListener> getWindowListeners()

getWindowStateListeners

public ListenerList<WindowStateListener> getWindowStateListeners()

getWindowActionMappingListeners

public ListenerList<WindowActionMappingListener> getWindowActionMappingListeners()

getWindowClassListeners

public static ListenerList<WindowClassListener> getWindowClassListeners()