|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pivot.wtk.Component
org.apache.pivot.wtk.Container
org.apache.pivot.wtk.Window
public class Window
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Window()
public Window(boolean auxilliary)
public Window(Component content)
public Window(Component content, boolean auxilliary)
Method Detail |
---|
protected void setParent(Container parent)
setParent
in class Container
public Sequence<Component> remove(int index, int count)
Sequence
remove
in interface Sequence<Component>
remove
in class Container
index
- The starting index to remove.count
- The number of items to remove, beginning with index.
public void setVisible(boolean visible)
setVisible
in class Container
visible
- If true, the window and its owned descendants are visible;
otherwise, they are not visible.public void setEnabled(boolean enabled)
setEnabled
in class Component
enabled
- If true, the window and its owned descendants are enabled;
otherwise, they are not enabled.public Window getOwner()
public void setOwner(Window owner)
public Window getRootOwner()
public Window getOwnedWindow(int index)
public int getOwnedWindowCount()
public boolean isOwner(Window window)
window
-
public boolean isOpen()
public boolean isOpening()
public void open(Display display)
display
- The display on which the window will be opened.public void open(Window owner)
owner
- The window's owner.public boolean isClosed()
public boolean isClosing()
public void close()
public String getTitle()
public void setTitle(String title)
title
- The new title, or null for no title.public Image getIcon()
public void setIcon(Image icon)
icon
- The window's icon, or null for no icon.public void setIcon(URL icon)
icon
- The location of the icon to set.public void setIcon(String icon)
icon
- The resource name of the icon to set.public Component getContent()
public void setContent(Component content)
public Bounds getClientArea()
public boolean isAuxilliary()
public boolean isActive()
public boolean requestActive()
protected void setActive(boolean active, Window obverseWindow)
active
- obverseWindow
- public static Window getActiveWindow()
public Component getFocusDescendant()
protected void descendantGainedFocus(Component descendant, Component previousFocusedComponent)
descendantGainedFocus
in class Container
protected void descendantRemoved(Component descendant)
descendantRemoved
in class Container
public Window.ActionMappingSequence getActionMappings()
public void moveToFront()
Finally, if it is not an auxilliary window, the window is made active.
public void moveToBack()
public boolean isMaximized()
public void setMaximized(boolean maximized)
public void align(Bounds bounds, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment)
public void align(Bounds bounds, HorizontalAlignment horizontalAlignment, int horizontalOffset, VerticalAlignment verticalAlignment, int verticalOffset)
public boolean keyReleased(int keyCode, Keyboard.KeyLocation keyLocation)
keyReleased
in class Component
public ListenerList<WindowListener> getWindowListeners()
public ListenerList<WindowStateListener> getWindowStateListeners()
public ListenerList<WindowActionMappingListener> getWindowActionMappingListeners()
public static ListenerList<WindowClassListener> getWindowClassListeners()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |