Package org.apache.pivot.wtk.skin.terra

Class TerraTooltipSkin

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

All Implemented Interfaces:

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

public class TerraTooltipSkin
extends WindowSkin

Tooltip skin.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pivot.wtk.skin.ContainerSkin

ContainerSkin.IndexFocusTraversalPolicy

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentKeyListener

ComponentKeyListener.Adapter, ComponentKeyListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentListener

ComponentListener.Adapter, ComponentListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentMouseButtonListener

ComponentMouseButtonListener.Adapter, ComponentMouseButtonListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentMouseListener

ComponentMouseListener.Adapter, ComponentMouseListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentMouseWheelListener

ComponentMouseWheelListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentStateListener

ComponentStateListener.Adapter, ComponentStateListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentTooltipListener

ComponentTooltipListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ContainerListener

ContainerListener.Adapter, ContainerListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ContainerMouseListener

ContainerMouseListener.Adapter, ContainerMouseListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.WindowListener

WindowListener.Adapter, WindowListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.WindowStateListener

WindowStateListener.Adapter, WindowStateListener.Listeners

Constructor Summary

Constructors

Constructor	Description
TerraTooltipSkin()

Method Summary

Modifier and Type	Method	Description
int	getCloseTransitionDuration()
int	getCloseTransitionRate()
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	install(Component component)	Must be implemented in every subclass in order to do component-specific operations at instantiation time, but every subclass must call this superclass method to setup the necessary listeners, etc.
void	layout()	If the component on which the skin is installed is a container, lays out the container's children.
void	paint(java.awt.Graphics2D graphics)	Paints the visual.
Vote	previewWindowClose(Window window)	Called to preview a window close event.
void	setCloseTransitionDuration(int closeTransitionDuration)
void	setCloseTransitionRate(int closeTransitionRate)
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.

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

contentChanged, getClientArea, mouseDown

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

componentInserted, componentMoved, componentsRemoved, focusTraversalPolicyChanged, getBackgroundColor, getBackgroundPaint, isFocusable, isOpaque, mouseMove, mouseUp, mouseWheel, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundPaint, setBackgroundPaint, setBackgroundPaint

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

colorFromObject, colorFromObject, colorFromObject, colorFromObject, currentTheme, cursorChanged, decodeFont, defaultBackgroundColor, defaultForegroundColor, dragSourceChanged, dropTargetChanged, enabledChanged, focusedChanged, fontFromObject, getBaseline, getBaseline, getColor, getComponent, getFocusRectangleStroke, getHeight, getSize, getTextInputMethodListener, getThemeFont, getWidth, heightLimitsChanged, invalidateComponent, keyPressed, keyReleased, keyTyped, locationChanged, menuHandlerChanged, mouseClick, mouseDown, mouseMove, mouseOut, mouseOver, mouseUp, mouseWheel, nameChanged, parentChanged, preferredSizeChanged, repaintComponent, repaintComponent, repaintComponent, repaintComponent, repaintComponent, setDefaultStyles, setSize, sizeChanged, themeHasThickFocusRectangle, themeHasTransitionEnabled, themeIsDark, themeIsFlat, 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.ConstrainedVisual

getBaseline, setSize, setSize

Methods inherited from interface org.apache.pivot.wtk.Skin

getComponent, isFocusable, isOpaque

Methods inherited from interface org.apache.pivot.wtk.Visual

getBaseline, getHeight, getSize, getWidth

Methods inherited from interface org.apache.pivot.wtk.WindowListener

activeChanged, iconAdded, iconInserted, iconsRemoved, maximizedChanged, titleChanged

Methods inherited from interface org.apache.pivot.wtk.WindowStateListener

previewWindowOpen, windowOpenVetoed

Constructor Detail

TerraTooltipSkin

public TerraTooltipSkin()

Method Detail

install

public void install(Component component)

Description copied from class: ComponentSkin

Must be implemented in every subclass in order to do component-specific operations at instantiation time, but every subclass must call this superclass method to setup the necessary listeners, etc.

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.

Returns:

The preferred width given the height 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.

Returns:

The preferred height given the width 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

Returns:

The preferred size (width and height) of this component.

Depending on the component this can be a static value or derived (as for a container) from its subcomponents, etc.

The default implementation simply calls ConstrainedVisual.getPreferredWidth(int) and ConstrainedVisual.getPreferredHeight(int).

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(java.awt.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.

getCloseTransitionDuration

public int getCloseTransitionDuration()

setCloseTransitionDuration

public void setCloseTransitionDuration(int closeTransitionDuration)

getCloseTransitionRate

public int getCloseTransitionRate()

setCloseTransitionRate

public void setCloseTransitionRate(int closeTransitionRate)

windowOpened

public void windowOpened(Window window)

Description copied from interface: WindowStateListener

Called when a window has opened.

Parameters:

window - The newly opened window.

previewWindowClose

public Vote previewWindowClose(Window window)

Description copied from interface: WindowStateListener

Called to preview a window close event.

Parameters:

window - The window that wants to close.

Returns:

The vote from each listener as to whether to allow the close.

windowCloseVetoed

public void windowCloseVetoed(Window window,
                              Vote reason)

Description copied from interface: WindowStateListener

Called when a window close event has been vetoed.

Parameters:

window - The window that was to close, but now will not.

reason - The accumulated vote from all the listeners that vetoed this event.

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

Parameters:

window - The window that is now closed.

display - The display in which the window was shown.

owner - The owner of this window (which could be null).