org.apache.pivot.wtk.skin
Class WindowSkin

java.lang.Object
  extended by org.apache.pivot.wtk.skin.ComponentSkin
      extended by org.apache.pivot.wtk.skin.ContainerSkin
          extended by org.apache.pivot.wtk.skin.WindowSkin
All Implemented Interfaces:
ComponentKeyListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ComponentTooltipListener, ConstrainedVisual, ContainerListener, ContainerMouseListener, Skin, Visual, Window.Skin, WindowListener, WindowStateListener
Direct Known Subclasses:
ColorChooserButtonSkin.ColorChooserPopupSkin, TerraFrameSkin, TerraMenuPopupSkin, TerraPaletteSkin, TerraSheetSkin, TerraSuggestionPopupSkin, TerraTooltipSkin

public class WindowSkin
extends ContainerSkin
implements Window.Skin, WindowListener, WindowStateListener

Window skin.


Nested Class Summary
static class WindowSkin.WindowFocusTraversalPolicy
          Focus traversal policy that always returns the window's content.
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.skin.ContainerSkin
ContainerSkin.IndexFocusTraversalPolicy
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.WindowListener
WindowListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.WindowStateListener
WindowStateListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ContainerListener
ContainerListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ContainerMouseListener
ContainerMouseListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentListener
ComponentListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentStateListener
ComponentStateListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentMouseListener
ComponentMouseListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentMouseButtonListener
ComponentMouseButtonListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentKeyListener
ComponentKeyListener.Adapter
 
Constructor Summary
WindowSkin()
           
 
Method Summary
 void activeChanged(Window window, Window obverseWindow)
          Called when a window's active state has changed.
 void contentChanged(Window window, Component previousContent)
          Called when a window's content component has changed.
 Bounds getClientArea()
           
 int getPreferredHeight(int width)
          Returns the visual's preferred height given the provided width constraint.
 Dimensions getPreferredSize()
          Returns the visual's unconstrained preferred size.
 int getPreferredWidth(int height)
          Returns the visual's preferred width given the provided height constraint.
 void iconAdded(Window window, Image addedIcon)
          Called when a window's icon has changed.
 void iconInserted(Window window, Image addedIcon, int index)
          Called when a window's icon has changed.
 void iconsRemoved(Window window, int index, Sequence<Image> removed)
          Called when a window's icon has changed.
 void install(Component component)
          Associates a skin with a component.
 void layout()
          If the component on which the skin is installed is a container, lays out the container's children.
 void maximizedChanged(Window window)
          Called when a window's maximized state has changed.
 boolean mouseDown(Container container, Mouse.Button button, int x, int y)
          Called when the mouse is pressed over a container.
 Vote previewWindowClose(Window window)
          Called to preview a window close event.
 Vote previewWindowOpen(Window window)
          Called to preview a window open event.
 void titleChanged(Window window, String previousTitle)
          Called when a window's title has changed.
 void windowClosed(Window window, Display display, Window owner)
          Called when a window has closed.
 void windowCloseVetoed(Window window, Vote reason)
          Called when a window close event has been vetoed.
 void windowOpened(Window window)
          Called when a window has opened.
 void windowOpenVetoed(Window window, Vote reason)
          Called when a window open event has been vetoed.
 
Methods inherited from class org.apache.pivot.wtk.skin.ContainerSkin
componentInserted, componentMoved, componentsRemoved, focusTraversalPolicyChanged, getBackgroundColor, getBackgroundPaint, isFocusable, isOpaque, mouseMove, mouseUp, mouseWheel, paint, setBackgroundColor, setBackgroundColor, setBackgroundPaint, setBackgroundPaint, setBackgroundPaint
 
Methods inherited from class org.apache.pivot.wtk.skin.ComponentSkin
cursorChanged, decodeFont, dragSourceChanged, dropTargetChanged, enabledChanged, focusedChanged, getBaseline, getBaseline, getComponent, getHeight, getWidth, heightLimitsChanged, invalidateComponent, keyPressed, keyReleased, keyTyped, locationChanged, menuHandlerChanged, mouseClick, mouseDown, mouseMove, mouseOut, mouseOver, mouseUp, mouseWheel, nameChanged, parentChanged, preferredSizeChanged, repaintComponent, repaintComponent, repaintComponent, repaintComponent, repaintComponent, setSize, sizeChanged, tooltipDelayChanged, tooltipTextChanged, tooltipTriggered, visibleChanged, widthLimitsChanged
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.pivot.wtk.Skin
getComponent, isFocusable, isOpaque
 
Methods inherited from interface org.apache.pivot.wtk.ConstrainedVisual
getBaseline, setSize
 
Methods inherited from interface org.apache.pivot.wtk.Visual
getBaseline, getHeight, getWidth, paint
 

Constructor Detail

WindowSkin

public WindowSkin()
Method Detail

install

public void install(Component component)
Description copied from interface: Skin
Associates a skin with a component.

Specified by:
install in interface Skin
Overrides:
install in class ContainerSkin
Parameters:
component - The component to which the skin is being attached.

getPreferredWidth

public int getPreferredWidth(int height)
Description copied from interface: ConstrainedVisual
Returns the visual's preferred width given the provided height constraint.

Specified by:
getPreferredWidth in interface ConstrainedVisual
Overrides:
getPreferredWidth in class ContainerSkin
Parameters:
height - The height by which to constrain the preferred width, or -1 for no constraint.

getPreferredHeight

public int getPreferredHeight(int width)
Description copied from interface: ConstrainedVisual
Returns the visual's preferred height given the provided width constraint.

Specified by:
getPreferredHeight in interface ConstrainedVisual
Overrides:
getPreferredHeight in class ContainerSkin
Parameters:
width - The width by which to constrain the preferred height, or -1 for no constraint.

getPreferredSize

public Dimensions getPreferredSize()
Description copied from interface: ConstrainedVisual
Returns the visual's unconstrained preferred size.

Specified by:
getPreferredSize in interface ConstrainedVisual
Overrides:
getPreferredSize in class ComponentSkin

layout

public void layout()
Description copied from interface: Skin
If the component on which the skin is installed is a container, lays out the container's children.

Specified by:
layout in interface Skin

getClientArea

public Bounds getClientArea()
Specified by:
getClientArea in interface Window.Skin

mouseDown

public boolean mouseDown(Container container,
                         Mouse.Button button,
                         int x,
                         int y)
Description copied from interface: ContainerMouseListener
Called when the mouse is pressed over a container.

Specified by:
mouseDown in interface ContainerMouseListener
Overrides:
mouseDown in class ContainerSkin
Returns:
true to consume the event; false to allow it to propagate.

titleChanged

public void titleChanged(Window window,
                         String previousTitle)
Description copied from interface: WindowListener
Called when a window's title has changed.

Specified by:
titleChanged in interface WindowListener

iconAdded

public void iconAdded(Window window,
                      Image addedIcon)
Description copied from interface: WindowListener
Called when a window's icon has changed.

Specified by:
iconAdded in interface WindowListener

iconInserted

public void iconInserted(Window window,
                         Image addedIcon,
                         int index)
Description copied from interface: WindowListener
Called when a window's icon has changed.

Specified by:
iconInserted in interface WindowListener

iconsRemoved

public void iconsRemoved(Window window,
                         int index,
                         Sequence<Image> removed)
Description copied from interface: WindowListener
Called when a window's icon has changed.

Specified by:
iconsRemoved in interface WindowListener

contentChanged

public void contentChanged(Window window,
                           Component previousContent)
Description copied from interface: WindowListener
Called when a window's content component has changed.

Specified by:
contentChanged in interface WindowListener

activeChanged

public void activeChanged(Window window,
                          Window obverseWindow)
Description copied from interface: WindowListener
Called when a window's active state has changed.

Specified by:
activeChanged in interface WindowListener

maximizedChanged

public void maximizedChanged(Window window)
Description copied from interface: WindowListener
Called when a window's maximized state has changed.

Specified by:
maximizedChanged in interface WindowListener

windowOpened

public void windowOpened(Window window)
Description copied from interface: WindowStateListener
Called when a window has opened.

Specified by:
windowOpened in interface WindowStateListener

previewWindowClose

public Vote previewWindowClose(Window window)
Description copied from interface: WindowStateListener
Called to preview a window close event.

Specified by:
previewWindowClose in interface WindowStateListener

windowCloseVetoed

public void windowCloseVetoed(Window window,
                              Vote reason)
Description copied from interface: WindowStateListener
Called when a window close event has been vetoed.

Specified by:
windowCloseVetoed in interface WindowStateListener

windowClosed

public void windowClosed(Window window,
                         Display display,
                         Window owner)
Description copied from interface: WindowStateListener
Called when a window has closed.

Specified by:
windowClosed in interface WindowStateListener

previewWindowOpen

public Vote previewWindowOpen(Window window)
Description copied from interface: WindowStateListener
Called to preview a window open event.

Specified by:
previewWindowOpen in interface WindowStateListener

windowOpenVetoed

public void windowOpenVetoed(Window window,
                             Vote reason)
Description copied from interface: WindowStateListener
Called when a window open event has been vetoed.

Specified by:
windowOpenVetoed in interface WindowStateListener