org.apache.pivot.wtk.skin.terra
Class TerraFrameSkin

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
              extended by org.apache.pivot.wtk.skin.terra.TerraFrameSkin
All Implemented Interfaces:
ComponentKeyListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ComponentTooltipListener, ConstrainedVisual, ContainerListener, ContainerMouseListener, FrameListener, Skin, Visual, Window.Skin, WindowListener, WindowStateListener
Direct Known Subclasses:
TerraDialogSkin

public class TerraFrameSkin
extends WindowSkin
implements FrameListener

Frame skin.


Nested Class Summary
protected  class TerraFrameSkin.ButtonImage
          Abstract base class for frame button images.
protected  class TerraFrameSkin.CloseImage
          Close button image.
static class TerraFrameSkin.FrameButton
          Frame button.
static class TerraFrameSkin.FrameButtonSkin
          Frame button skin.
protected  class TerraFrameSkin.MaximizeImage
          Maximize button image.
protected  class TerraFrameSkin.MinimizeImage
          Minimize button image.
protected  class TerraFrameSkin.ResizeImage
          Resize button image.
protected  class TerraFrameSkin.RestoreImage
          Restore button image.
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.skin.WindowSkin
WindowSkin.WindowFocusTraversalPolicy
 
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
TerraFrameSkin()
           
 
Method Summary
 void activeChanged(Window window, Window obverseWindow)
          Called when a window's active state has changed.
 Bounds getClientArea()
           
 Insets getPadding()
           
 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.
 boolean getShowCloseButton()
           
 boolean getShowContentBevel()
           
 boolean getShowMaximizeButton()
           
 boolean getShowMinimizeButton()
           
 boolean getShowWindowControls()
           
 void iconAdded(Window window, Image addedIcon)
          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.
 boolean isResizable()
           
 boolean keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation)
          TAB Transfers focus forwards
TAB + SHIFT Transfers focus backwards
 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.
 void menuBarChanged(Frame frame, MenuBar previousMenuBar)
          Called when a frame's menu bar has changed.
 boolean mouseDown(Component component, Mouse.Button button, int x, int y)
          Called when a mouse button is pressed over a component.
 boolean mouseMove(Component component, int x, int y)
          Called when the mouse is moved over a component.
 boolean mouseUp(Component component, Mouse.Button button, int x, int y)
          Called when a mouse button is released over a component.
 void paint(Graphics2D graphics)
          Paints the visual.
 void setBackgroundColor(Color backgroundColor)
          Sets the background of the container to a solid color.
 void setBackgroundColor(int color)
           
 void setPadding(Dictionary<String,?> padding)
           
 void setPadding(Insets padding)
           
 void setPadding(int padding)
           
 void setPadding(Number padding)
           
 void setPadding(String padding)
           
 void setResizable(boolean resizable)
           
 void setShowCloseButton(boolean showCloseButton)
           
 void setShowContentBevel(boolean showContentBevel)
           
 void setShowMaximizeButton(boolean showMaximizeButton)
           
 void setShowMinimizeButton(boolean showMinimizeButton)
           
 void setShowWindowControls(boolean showWindowControls)
           
 void titleChanged(Window window, String previousTitle)
          Called when a window's title has changed.
 
Methods inherited from class org.apache.pivot.wtk.skin.WindowSkin
contentChanged, iconInserted, mouseDown, previewWindowClose, previewWindowOpen, windowClosed, windowCloseVetoed, windowOpened, windowOpenVetoed
 
Methods inherited from class org.apache.pivot.wtk.skin.ContainerSkin
componentInserted, componentMoved, componentsRemoved, focusTraversalPolicyChanged, getBackgroundColor, getBackgroundPaint, isFocusable, isOpaque, mouseMove, mouseUp, mouseWheel, 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, keyReleased, keyTyped, locationChanged, menuHandlerChanged, mouseClick, mouseOut, mouseOver, 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
 

Constructor Detail

TerraFrameSkin

public TerraFrameSkin()
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 WindowSkin
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 WindowSkin
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 WindowSkin
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 WindowSkin

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
Overrides:
layout in class WindowSkin

paint

public void paint(Graphics2D graphics)
Description copied from interface: Visual
Paints the visual.

Specified by:
paint in interface Visual
Overrides:
paint in class ContainerSkin
Parameters:
graphics - The graphics context in which to paint the visual.

getClientArea

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

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)
Description copied from class: ContainerSkin
Sets the background of the container to a solid color.

Overrides:
setBackgroundColor in class ContainerSkin

setBackgroundColor

public final void setBackgroundColor(int color)

getShowMinimizeButton

public boolean getShowMinimizeButton()

setShowMinimizeButton

public void setShowMinimizeButton(boolean showMinimizeButton)

getShowMaximizeButton

public boolean getShowMaximizeButton()

setShowMaximizeButton

public void setShowMaximizeButton(boolean showMaximizeButton)

getShowCloseButton

public boolean getShowCloseButton()

setShowCloseButton

public void setShowCloseButton(boolean showCloseButton)

getShowWindowControls

public boolean getShowWindowControls()

setShowWindowControls

public void setShowWindowControls(boolean showWindowControls)

getPadding

public Insets getPadding()

setPadding

public void setPadding(Insets padding)

setPadding

public final void setPadding(Dictionary<String,?> padding)

setPadding

public final void setPadding(int padding)

setPadding

public final void setPadding(Number padding)

setPadding

public final void setPadding(String padding)

isResizable

public boolean isResizable()

setResizable

public void setResizable(boolean resizable)

getShowContentBevel

public boolean getShowContentBevel()

setShowContentBevel

public void setShowContentBevel(boolean showContentBevel)

mouseMove

public boolean mouseMove(Component component,
                         int x,
                         int y)
Description copied from interface: ComponentMouseListener
Called when the mouse is moved over a component.

Specified by:
mouseMove in interface ComponentMouseListener
Overrides:
mouseMove in class ComponentSkin
Returns:
true to consume the event; false to allow it to propagate.

mouseDown

public boolean mouseDown(Component component,
                         Mouse.Button button,
                         int x,
                         int y)
Description copied from interface: ComponentMouseButtonListener
Called when a mouse button is pressed over a component.

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

mouseUp

public boolean mouseUp(Component component,
                       Mouse.Button button,
                       int x,
                       int y)
Description copied from interface: ComponentMouseButtonListener
Called when a mouse button is released over a component.

Specified by:
mouseUp in interface ComponentMouseButtonListener
Overrides:
mouseUp in class ComponentSkin
Returns:
true to consume the event; false to allow it to propagate.

keyPressed

public boolean keyPressed(Component component,
                          int keyCode,
                          Keyboard.KeyLocation keyLocation)
Description copied from class: ComponentSkin
TAB Transfers focus forwards
TAB + SHIFT Transfers focus backwards

Specified by:
keyPressed in interface ComponentKeyListener
Overrides:
keyPressed in class ComponentSkin
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
Overrides:
titleChanged in class WindowSkin

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
Overrides:
iconAdded in class WindowSkin

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
Overrides:
iconsRemoved in class WindowSkin

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
Overrides:
activeChanged in class WindowSkin

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
Overrides:
maximizedChanged in class WindowSkin

menuBarChanged

public void menuBarChanged(Frame frame,
                           MenuBar previousMenuBar)
Description copied from interface: FrameListener
Called when a frame's menu bar has changed.

Specified by:
menuBarChanged in interface FrameListener