org.apache.pivot.wtk.skin
Class ContainerSkin

java.lang.Object
  extended by org.apache.pivot.wtk.skin.ComponentSkin
      extended by org.apache.pivot.wtk.skin.ContainerSkin
All Implemented Interfaces:
ComponentKeyListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ConstrainedVisual, ContainerListener, Skin, Visual
Direct Known Subclasses:
BorderSkin, BoxPaneSkin, CalendarSkin, CardPaneSkin, DisplaySkin, ExpanderSkin, FileBrowserSkin, FlowPaneSkin, PanelSkin, RollupSkin, ScrollPaneSkin, SliderSkin, StackPaneSkin, TablePaneSkin, TerraAccordionSkin, TerraFormSkin, TerraMenuBarSkin, TerraMenuSkin, TerraPanoramaSkin, TerraScrollBarSkin, TerraSpinnerSkin, TerraSplitPaneSkin, TerraTabPaneSkin, WindowSkin

public abstract class ContainerSkin
extends ComponentSkin
implements ContainerListener

Abstract base class for container skins.


Nested Class Summary
static class ContainerSkin.IndexFocusTraversalPolicy
          Focus traversal policy that determines traversal order based on the order of components in the container's component sequence.
 
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
 
Field Summary
 
Fields inherited from class org.apache.pivot.wtk.skin.ComponentSkin
SHOW_TOOLTIP_TIMEOUT
 
Constructor Summary
ContainerSkin()
           
 
Method Summary
 void componentInserted(Container container, int index)
          Called when a component has been inserted into a container's component sequence.
 void componentsRemoved(Container container, int index, Sequence<Component> removed)
          Called when components have been removed from a container's component sequence.
 void contextKeyChanged(Container container, String previousContextKey)
          Called when a container's context key has changed.
 void focusTraversalPolicyChanged(Container container, FocusTraversalPolicy previousFocusTraversalPolicy)
          Called when a container's focus traversal policy has changed.
 Color getBackgroundColor()
           
 Paint getBackgroundPaint()
           
 int getPreferredHeight(int width)
          Returns the visual's preferred height given the provided width constraint.
 int getPreferredWidth(int height)
          Returns the visual's preferred width given the provided height constraint.
 void install(Component component)
          Associates a skin with a component.
 boolean isFocusable()
          By default, components are focusable.
 boolean isOpaque()
          By default, a container's opacity depends on its backgroundPaint style.
 void paint(Graphics2D graphics)
          Paints the visual.
 void setBackgroundColor(Color backgroundColor)
           
 void setBackgroundColor(String backgroundColor)
           
 void setBackgroundPaint(Dictionary<String,?> backgroundPaint)
           
 void setBackgroundPaint(Paint backgroundPaint)
           
 void uninstall()
          Dissociates a skin from a component.
 
Methods inherited from class org.apache.pivot.wtk.skin.ComponentSkin
cursorChanged, dragSourceChanged, dropTargetChanged, enabledChanged, focusedChanged, getComponent, getHeight, getPreferredSize, getWidth, invalidateComponent, keyPressed, keyReleased, keyTyped, locationChanged, menuHandlerChanged, mouseClick, mouseDown, mouseMove, mouseOut, mouseOver, mouseUp, mouseWheel, parentChanged, preferredHeightLimitsChanged, preferredSizeChanged, preferredWidthLimitsChanged, repaintComponent, repaintComponent, repaintComponent, repaintComponent, repaintComponent, setSize, sizeChanged, styleUpdated, tooltipTextChanged, visibleChanged
 
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
layout
 

Constructor Detail

ContainerSkin

public ContainerSkin()
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 ComponentSkin
Parameters:
component - The component to which the skin is being attached.

uninstall

public void uninstall()
Description copied from interface: Skin
Dissociates a skin from a component.

Specified by:
uninstall in interface Skin
Overrides:
uninstall in class ComponentSkin

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
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
Parameters:
width - The width by which to constrain the preferred height, or -1 for no constraint.

paint

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

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

isFocusable

public boolean isFocusable()
Description copied from class: ComponentSkin
By default, components are focusable.

Specified by:
isFocusable in interface Skin
Overrides:
isFocusable in class ComponentSkin
Returns:
false; by default, containers are not focusable.

isOpaque

public boolean isOpaque()
By default, a container's opacity depends on its backgroundPaint style.

Specified by:
isOpaque in interface Skin
Overrides:
isOpaque in class ComponentSkin
Returns:
true if backgroundPaint is non-null. False otherwise.

getBackgroundPaint

public Paint getBackgroundPaint()

setBackgroundPaint

public void setBackgroundPaint(Paint backgroundPaint)

setBackgroundPaint

public final void setBackgroundPaint(Dictionary<String,?> backgroundPaint)

getBackgroundColor

public Color getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

setBackgroundColor

public final void setBackgroundColor(String backgroundColor)

componentInserted

public void componentInserted(Container container,
                              int index)
Description copied from interface: ContainerListener
Called when a component has been inserted into a container's component sequence.

Specified by:
componentInserted in interface ContainerListener

componentsRemoved

public void componentsRemoved(Container container,
                              int index,
                              Sequence<Component> removed)
Description copied from interface: ContainerListener
Called when components have been removed from a container's component sequence.

Specified by:
componentsRemoved in interface ContainerListener

contextKeyChanged

public void contextKeyChanged(Container container,
                              String previousContextKey)
Description copied from interface: ContainerListener
Called when a container's context key has changed.

Specified by:
contextKeyChanged in interface ContainerListener

focusTraversalPolicyChanged

public void focusTraversalPolicyChanged(Container container,
                                        FocusTraversalPolicy previousFocusTraversalPolicy)
Description copied from interface: ContainerListener
Called when a container's focus traversal policy has changed.

Specified by:
focusTraversalPolicyChanged in interface ContainerListener