Package org.apache.pivot.wtk.skin

Class FillPaneSkin

java.lang.Object

org.apache.pivot.wtk.skin.ComponentSkin

org.apache.pivot.wtk.skin.ContainerSkin

org.apache.pivot.wtk.skin.FillPaneSkin

All Implemented Interfaces:

ComponentKeyListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ComponentTooltipListener, ConstrainedVisual, ContainerListener, ContainerMouseListener, FillPaneListener, Skin, Visual

public class FillPaneSkin
extends ContainerSkin
implements FillPaneListener

Theme-independent skin for the FillPane component.

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

FillPaneListener.Listeners

Constructor Summary

Constructors

Constructor	Description
FillPaneSkin()

Method Summary

Modifier and Type	Method	Description
int	getBaseline(int width, int height)	Should be implemented in every subclass.
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.
int	getSpacing()
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	orientationChanged(FillPane fillPane)	Called when a fill pane's orientation has changed.
void	setPadding(int padding)	Sets the amount of space to leave between the edge of the FillPane and its components, uniformly on all four edges.
void	setPadding(java.lang.Number padding)	Sets the amount of space to leave between the edge of the FillPane and its components, uniformly on all four edges.
void	setPadding(java.lang.String padding)	Sets the amount of space to leave between the edge of the FillPane and its components.
void	setPadding(Dictionary<java.lang.String,?> padding)	Sets the amount of space to leave between the edge of the FillPane and its components.
void	setPadding(Sequence<?> padding)	Sets the amount of space to leave between the edge of the FillPane and its components.
void	setPadding(Insets padding)	Sets the amount of space to leave between the edge of the FillPane and its components.
void	setSpacing(int spacing)
void	setSpacing(java.lang.Number spacing)

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

componentInserted, componentMoved, componentsRemoved, focusTraversalPolicyChanged, getBackgroundColor, getBackgroundPaint, isFocusable, isOpaque, mouseDown, mouseMove, mouseUp, mouseWheel, paint, 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, 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

setSize

Constructor Detail

FillPaneSkin

public FillPaneSkin()

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

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 ContainerSkin

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 ComponentSkin

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

getBaseline

public int getBaseline(int width,
                       int height)

Description copied from class: ComponentSkin

Should be implemented in every subclass.

The default implementation here simply returns -1 (no baseline).

Specified by:

getBaseline in interface ConstrainedVisual

Overrides:

getBaseline in class ComponentSkin

Parameters:

width - Constrained width to compute the baseline for.

height - Constrained height to compute the baseline for.

Returns:

The baseline relative to the origin of this visual, or -1 if this visual does not have a baseline.

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

getPadding

public final Insets getPadding()

Returns:

The amount of space between the edge of the FillPane and its components.

setPadding

public final void setPadding(Insets padding)

Sets the amount of space to leave between the edge of the FillPane and its components.

Parameters:

padding - The new values for padding.

setPadding

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

Sets the amount of space to leave between the edge of the FillPane and its components.

Parameters:

padding - A dictionary with keys in the set {top, left, bottom, right}.

setPadding

public final void setPadding(Sequence<?> padding)

Sets the amount of space to leave between the edge of the FillPane and its components.

Parameters:

padding - A sequence with values in the order [top, left, bottom, right].

setPadding

public final void setPadding(int padding)

Sets the amount of space to leave between the edge of the FillPane and its components, uniformly on all four edges.

Parameters:

padding - The new value for padding on all sides.

setPadding

public final void setPadding(java.lang.Number padding)

Sets the amount of space to leave between the edge of the FillPane and its components, uniformly on all four edges.

Parameters:

padding - The new value for padding on all sides.

setPadding

public final void setPadding(java.lang.String padding)

Sets the amount of space to leave between the edge of the FillPane and its components.

Parameters:

padding - A string containing an integer or a JSON dictionary with keys left, top, bottom, and/or right.

getSpacing

public final int getSpacing()

setSpacing

public final void setSpacing(int spacing)

setSpacing

public final void setSpacing(java.lang.Number spacing)

orientationChanged

public void orientationChanged(FillPane fillPane)

Description copied from interface: FillPaneListener

Called when a fill pane's orientation has changed.

Specified by:

orientationChanged in interface FillPaneListener

Parameters:

fillPane - The fill pane that has changed.