org.apache.pivot.wtk.skin.terra

Class TerraSheetSkin

java.lang.Object

org.apache.pivot.wtk.skin.ComponentSkin

org.apache.pivot.wtk.skin.ContainerSkin

org.apache.pivot.wtk.skin.WindowSkin

org.apache.pivot.wtk.skin.terra.TerraSheetSkin

All Implemented Interfaces:

ComponentKeyListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ComponentTooltipListener, ConstrainedVisual, ContainerListener, ContainerMouseListener, SheetCloseListener, SheetStateListener, Skin, Visual, Window.Skin, WindowListener, WindowStateListener

Direct Known Subclasses:

TerraFileBrowserSheetSkin, TerraPromptSkin

public class TerraSheetSkin
extends WindowSkin
implements SheetStateListener

Sheet skin class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TerraSheetSkin.OpenTransition
protected class	TerraSheetSkin.ResizeImage Resize button image.
static class	TerraSheetSkin.SheetPlacement

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.SheetStateListener

SheetStateListener.Adapter

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

Constructors

Constructor and Description
TerraSheetSkin()

Method Summary

Methods

Modifier and Type	Method and Description
void	alignToOwner()
Color	getBorderColor()
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.
TerraSheetSkin.SheetPlacement	getSlideSource()
int	getStateTransitionDuration()
int	getStateTransitionRate()
void	install(Component component) Associates a skin with a component.
boolean	isResizable()
boolean	keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation) ENTER Close the sheet with a 'result' of true.
void	layout() If the component on which the skin is installed is a container, lays out the container's children.
boolean	mouseDown(Container container, Mouse.Button button, int x, int y) Called when the mouse is pressed over a container.
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.
Vote	previewSheetClose(Sheet sheet, boolean result) Called to preview a sheet close event.
void	setBackgroundColor(Color backgroundColor) Sets the background of the container to a solid color.
void	setBorderColor(Color borderColor)
void	setBorderColor(String borderColor)
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	setSlideSource(TerraSheetSkin.SheetPlacement slideSource)
void	setStateTransitionDuration(int stateTransitionDuration)
void	setStateTransitionRate(int stateTransitionRate)
void	sheetClosed(Sheet sheet) Called when a sheet has closed.
void	sheetCloseVetoed(Sheet sheet, Vote reason) Called when a sheet close event has been vetoed.
void	sizeChanged(Component component, int previousWidth, int previousHeight) Called when a component's size has changed.
void	windowClosed(Window window, Display display, Window owner) Called when a window has closed.
void	windowOpened(Window window) Called when a window has opened.

Methods inherited from class org.apache.pivot.wtk.skin.WindowSkin

activeChanged, contentChanged, getClientArea, iconAdded, iconInserted, iconsRemoved, maximizedChanged, previewWindowClose, previewWindowOpen, titleChanged, windowCloseVetoed, 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, mouseDown, mouseOut, mouseOver, mouseWheel, nameChanged, parentChanged, preferredSizeChanged, repaintComponent, repaintComponent, repaintComponent, repaintComponent, repaintComponent, setSize, 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

TerraSheetSkin

public TerraSheetSkin()

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.

sizeChanged

public void sizeChanged(Component component,
               int previousWidth,
               int previousHeight)

Description copied from interface: ComponentListener

Called when a component's size has changed.

Specified by:

sizeChanged in interface ComponentListener

Overrides:

sizeChanged in class ComponentSkin

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(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 WindowSkin

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)

ENTER Close the sheet with a 'result' of true.
ESCAPE Close the sheet with a 'result' of false.

Specified by:

keyPressed in interface ComponentKeyListener

Overrides:

keyPressed in class ComponentSkin

Returns:

true to consume the event; false to allow it to propagate.

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

getBorderColor

public Color getBorderColor()

setBorderColor

public void setBorderColor(Color borderColor)

setBorderColor

public final void setBorderColor(String borderColor)

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)

getSlideSource

public TerraSheetSkin.SheetPlacement getSlideSource()

setSlideSource

public void setSlideSource(TerraSheetSkin.SheetPlacement slideSource)

getStateTransitionDuration

public int getStateTransitionDuration()

setStateTransitionDuration

public void setStateTransitionDuration(int stateTransitionDuration)

getStateTransitionRate

public int getStateTransitionRate()

setStateTransitionRate

public void setStateTransitionRate(int stateTransitionRate)

windowOpened

public void windowOpened(Window window)

Description copied from interface: WindowStateListener

Called when a window has opened.

Specified by:

windowOpened in interface WindowStateListener

Overrides:

windowOpened in class WindowSkin

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

Overrides:

windowClosed in class WindowSkin

previewSheetClose

public Vote previewSheetClose(Sheet sheet,
                     boolean result)

Description copied from interface: SheetStateListener

Called to preview a sheet close event.

Specified by:

previewSheetClose in interface SheetStateListener

sheetCloseVetoed

public void sheetCloseVetoed(Sheet sheet,
                    Vote reason)

Description copied from interface: SheetStateListener

Called when a sheet close event has been vetoed.

Specified by:

sheetCloseVetoed in interface SheetStateListener

sheetClosed

public void sheetClosed(Sheet sheet)

Description copied from interface: SheetCloseListener

Called when a sheet has closed.

Specified by:

sheetClosed in interface SheetCloseListener

alignToOwner

public void alignToOwner()