org.apache.pivot.wtk.skin
Class BoxPaneSkin

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.BoxPaneSkin
All Implemented Interfaces:
BoxPaneListener, ComponentKeyListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ComponentTooltipListener, ConstrainedVisual, ContainerListener, ContainerMouseListener, Skin, Visual
Direct Known Subclasses:
TerraBoxPaneSkin

public class BoxPaneSkin
extends ContainerSkin
implements BoxPaneListener

Box pane 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.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
BoxPaneSkin()
           
 
Method Summary
 int getBaseline(int width, int height)
          Returns the baseline for a given width and height.
 boolean getFill()
          Returns a value indicating whether the BoxPane's components fill the available space in the pane in the dimension orthogonal to its orientation.
 HorizontalAlignment getHorizontalAlignment()
          Returns the horizontal alignment of the BoxPane's components within the pane.
 Insets getPadding()
          Returns the amount of space between the edge of the BoxPane and its components.
 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()
          Returns the amount of space between the BoxPane's components.
 VerticalAlignment getVerticalAlignment()
          Returns the vertical alignment of the BoxPane's components within the pane.
 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 orientationChanged(BoxPane boxPane)
          Called when a box pane's orientation has changed.
 void setFill(boolean fill)
          Sets whether the BoxPane's components fill to the edges of the pane.
 void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)
          Sets the horizontal alignment of the BoxPane's components within the pane.
 void setPadding(Dictionary<String,?> padding)
          Sets the amount of space to leave between the edge of the BoxPane and its components.
 void setPadding(Insets padding)
          Sets the amount of space to leave between the edge of the BoxPane and its components.
 void setPadding(int padding)
          Sets the amount of space to leave between the edge of the BoxPane and its components, uniformly on all four edges.
 void setPadding(Number padding)
          Sets the amount of space to leave between the edge of the BoxPane and its components, uniformly on all four edges.
 void setPadding(String padding)
          Sets the amount of space to leave between the edge of the BoxPane and its components.
 void setSpacing(int spacing)
          Sets the amount of space to leave between the BoxPane's components.
 void setSpacing(Number spacing)
          Sets the amount of space to leave between the BoxPane's components.
 void setVerticalAlignment(VerticalAlignment verticalAlignment)
          Sets the vertical alignment of the BoxPane's components within the pane.
 
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, setBackgroundPaint, setBackgroundPaint, setBackgroundPaint
 
Methods inherited from class org.apache.pivot.wtk.skin.ComponentSkin
cursorChanged, decodeFont, dragSourceChanged, dropTargetChanged, enabledChanged, focusedChanged, 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
 

Constructor Detail

BoxPaneSkin

public BoxPaneSkin()
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

getBaseline

public int getBaseline(int width,
                       int height)
Description copied from interface: ConstrainedVisual
Returns the baseline for a given width and height.

Specified by:
getBaseline in interface ConstrainedVisual
Overrides:
getBaseline in class ComponentSkin
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

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment()
Returns the horizontal alignment of the BoxPane's components within the pane.


setHorizontalAlignment

public void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)
Sets the horizontal alignment of the BoxPane's components within the pane.

If the orientation of the pane is HORIZONTAL, this means the collective alignment all the components as group, which are still laid out close together according to the value of the spacing style.

If the orientation of the pane is VERTICAL, this means the alignment of each individual component within the pane. It has no effect if the fill style is true.


getVerticalAlignment

public VerticalAlignment getVerticalAlignment()
Returns the vertical alignment of the BoxPane's components within the pane.


setVerticalAlignment

public void setVerticalAlignment(VerticalAlignment verticalAlignment)
Sets the vertical alignment of the BoxPane's components within the pane.

If the orientation of the pane is VERTICAL, this means the collective alignment all the components as group, which are still laid out close together according to the value of the spacing style.

If the orientation of the pane is HORIZONTAL, this means the alignment of each individual component within the pane. It has no effect if the fill style is true.


getPadding

public Insets getPadding()
Returns the amount of space between the edge of the BoxPane and its components.


setPadding

public void setPadding(Insets padding)
Sets the amount of space to leave between the edge of the BoxPane and its components.


setPadding

public final void setPadding(Dictionary<String,?> padding)
Sets the amount of space to leave between the edge of the BoxPane and its components.

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

setPadding

public final void setPadding(int padding)
Sets the amount of space to leave between the edge of the BoxPane and its components, uniformly on all four edges.


setPadding

public final void setPadding(Number padding)
Sets the amount of space to leave between the edge of the BoxPane and its components, uniformly on all four edges.


setPadding

public final void setPadding(String padding)
Sets the amount of space to leave between the edge of the BoxPane and its components.

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

getSpacing

public int getSpacing()
Returns the amount of space between the BoxPane's components.


setSpacing

public void setSpacing(int spacing)
Sets the amount of space to leave between the BoxPane's components.


setSpacing

public final void setSpacing(Number spacing)
Sets the amount of space to leave between the BoxPane's components.


getFill

public boolean getFill()
Returns a value indicating whether the BoxPane's components fill the available space in the pane in the dimension orthogonal to its orientation.


setFill

public void setFill(boolean fill)
Sets whether the BoxPane's components fill to the edges of the pane.

Parameters:
fill - If true, the components are given all the available space in the dimension orthogonal to the pane's orientation (e.g., vertically in a BoxPane with orientation=horizontal). It has no effect on the layout of components in the direction of the pane's orientation, which are always given exactly their preferred size. If false, the pane's components are laid out to their preferred size, regardless of the size of the BoxPane. Their alignment along the axis orthogonal to the pane's orientation is controlled by the corresponding alignment style (e.g., verticalAlignment in a BoxPane with orientation=horizontal).

Note that to Scale Up Images, other that fill=true it will be needed to set even the preferredWidth/preferredHeight as with container preferredHeight/preferredWidth just set, depending on the pane's orientation.


orientationChanged

public void orientationChanged(BoxPane boxPane)
Description copied from interface: BoxPaneListener
Called when a box pane's orientation has changed.

Specified by:
orientationChanged in interface BoxPaneListener