org.apache.pivot.wtk.skin
Class SeparatorSkin

java.lang.Object
  extended by org.apache.pivot.wtk.skin.ComponentSkin
      extended by org.apache.pivot.wtk.skin.SeparatorSkin
All Implemented Interfaces:
ComponentKeyListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ComponentTooltipListener, ConstrainedVisual, SeparatorListener, Skin, Visual
Direct Known Subclasses:
TerraSeparatorSkin

public class SeparatorSkin
extends ComponentSkin
implements SeparatorListener

Separator skin.


Nested Class Summary
 
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
SeparatorSkin()
           
 
Method Summary
 Color getColor()
          Returns the color of the Separator's horizontal rule
 Font getFont()
          Returns the font used in rendering the Separator's heading
 Color getHeadingColor()
          Returns the color of the text in the heading
 Insets getPadding()
          Returns the amount of space surrounding (left/right) the Separator's heading, and above and below the entire component.
 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 getThickness()
          Returns the thickness of the Separator's horizontal rule
 void headingChanged(Separator separator, String previousHeading)
          Called when a separator's heading has changed.
 void install(Component component)
          Associates a skin with a component.
 boolean isFocusable()
          By default, skins are focusable.
 void layout()
          If the component on which the skin is installed is a container, lays out the container's children.
 void paint(Graphics2D graphics)
          Paints the visual.
 void setColor(Color color)
          Sets the color of the Separator's horizontal rule
 void setColor(String color)
          Sets the color of the Separator's horizontal rule
 void setFont(Dictionary<String,?> font)
          Sets the font used in rendering the Separator's heading
 void setFont(Font font)
          Sets the font used in rendering the Separator's heading
 void setFont(String font)
          Sets the font used in rendering the Separator's heading
 void setHeadingColor(Color headingColor)
          Sets the color of the text in the heading
 void setHeadingColor(String headingColor)
          Sets the color of the text in the heading
 void setPadding(Dictionary<String,?> padding)
          Sets the amount of space to leave around the Separator's heading, and above and below the entire component.
 void setPadding(Insets padding)
          Sets the amount of space to leave around the Separator's heading, and above and below the entire component.
 void setPadding(int padding)
          Sets the amount of space to leave around the Separator's heading, and above and below the entire component.
 void setPadding(Number padding)
          Sets the amount of space to leave around the Separator's heading, and above and below the entire component.
 void setPadding(String padding)
          Sets the amount of space to leave around the Separator's heading, and above and below the entire component.
 void setThickness(int thickness)
          Sets the thickness of the Separator's horizontal rule
 void setThickness(Number thickness)
          Sets the thickness of the Separator's horizontal rule
 
Methods inherited from class org.apache.pivot.wtk.skin.ComponentSkin
cursorChanged, decodeFont, dragSourceChanged, dropTargetChanged, enabledChanged, focusedChanged, getBaseline, getBaseline, getComponent, getHeight, getWidth, heightLimitsChanged, invalidateComponent, isOpaque, 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

SeparatorSkin

public SeparatorSkin()
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.

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.

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

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

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, skins are focusable.

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

getFont

public Font getFont()
Returns the font used in rendering the Separator's heading


setFont

public void setFont(Font font)
Sets the font used in rendering the Separator's heading


setFont

public final void setFont(String font)
Sets the font used in rendering the Separator's heading

Parameters:
font - A font specification

setFont

public final void setFont(Dictionary<String,?> font)
Sets the font used in rendering the Separator's heading

Parameters:
font - A dictionary describing a font

getColor

public Color getColor()
Returns the color of the Separator's horizontal rule


setColor

public void setColor(Color color)
Sets the color of the Separator's horizontal rule


setColor

public final void setColor(String color)
Sets the color of the Separator's horizontal rule

Parameters:
color - Any of the color values recognized by Pivot.

getHeadingColor

public Color getHeadingColor()
Returns the color of the text in the heading


setHeadingColor

public void setHeadingColor(Color headingColor)
Sets the color of the text in the heading


setHeadingColor

public final void setHeadingColor(String headingColor)
Sets the color of the text in the heading

Parameters:
headingColor - Any of the color values recognized by Pivot.

getThickness

public int getThickness()
Returns the thickness of the Separator's horizontal rule


setThickness

public void setThickness(int thickness)
Sets the thickness of the Separator's horizontal rule


setThickness

public final void setThickness(Number thickness)
Sets the thickness of the Separator's horizontal rule


getPadding

public Insets getPadding()
Returns the amount of space surrounding (left/right) the Separator's heading, and above and below the entire component.


setPadding

public void setPadding(Insets padding)
Sets the amount of space to leave around the Separator's heading, and above and below the entire component.


setPadding

public final void setPadding(Dictionary<String,?> padding)
Sets the amount of space to leave around the Separator's heading, and above and below the entire component.

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 around the Separator's heading, and above and below the entire component.


setPadding

public final void setPadding(Number padding)
Sets the amount of space to leave around the Separator's heading, and above and below the entire component.


setPadding

public final void setPadding(String padding)
Sets the amount of space to leave around the Separator's heading, and above and below the entire component.

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

headingChanged

public void headingChanged(Separator separator,
                           String previousHeading)
Description copied from interface: SeparatorListener
Called when a separator's heading has changed.

Specified by:
headingChanged in interface SeparatorListener