org.apache.pivot.wtk.skin
Class LabelSkin

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

public class LabelSkin
extends ComponentSkin
implements LabelListener

Label skin.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.LabelListener
LabelListener.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
LabelSkin()
           
 
Method Summary
 Color getBackgroundColor()
          Returns the background color of the label.
 int getBaseline(int width, int height)
          Returns the baseline for a given width and height.
 Color getColor()
          Returns the foreground color of the text of the label.
 Color getDisabledColor()
          Returns the foreground color of the text of the label when disabled.
 Font getFont()
          Returns the font used in rendering the Label's text
 HorizontalAlignment getHorizontalAlignment()
           
 Insets getPadding()
          Returns the amount of space to leave between the edge of the Label and its text.
 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.
 TextDecoration getTextDecoration()
           
 VerticalAlignment getVerticalAlignment()
           
 boolean getWrapText()
          Returns true if the text of the label will be wrapped to fit the Label's width.
 void install(Component component)
          Associates a skin with a component.
 boolean isFocusable()
          By default, skins are focusable.
 boolean isOpaque()
          By default, skins are assumed to be opaque.
 void layout()
          If the component on which the skin is installed is a container, lays out the container's children.
 void maximumLengthChanged(Label label, int previousMaximumLength)
          Called when a label text maximum length has changed.
 void paint(Graphics2D graphics)
          Paints the visual.
 void setBackgroundColor(Color backgroundColor)
          Sets the background color of the label.
 void setBackgroundColor(String backgroundColor)
          Sets the background color of the label.
 void setColor(Color color)
          Sets the foreground color of the text of the label.
 void setColor(String color)
          Sets the foreground color of the text of the label.
 void setDisabledColor(Color color)
          Sets the foreground color of the text of the label when disabled.
 void setDisabledColor(String color)
          Sets the foreground color of the text of the label when disabled.
 void setFont(Dictionary<String,?> font)
          Sets the font used in rendering the Label's text
 void setFont(Font font)
          Sets the font used in rendering the Label's text
 void setFont(String font)
          Sets the font used in rendering the Label's text
 void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)
           
 void setPadding(Dictionary<String,?> padding)
          Sets the amount of space to leave between the edge of the Label and its text.
 void setPadding(Insets padding)
          Sets the amount of space to leave between the edge of the Label and its text.
 void setPadding(int padding)
          Sets the amount of space to leave between the edge of the Label and its text, uniformly on all four edges.
 void setPadding(Number padding)
          Sets the amount of space to leave between the edge of the Label and its text, uniformly on all four edges.
 void setPadding(String padding)
          Sets the amount of space to leave between the edge of the Label and its text.
 void setTextDecoration(TextDecoration textDecoration)
           
 void setVerticalAlignment(VerticalAlignment verticalAlignment)
           
 void setWrapText(boolean wrapText)
          Sets whether the text of the label will be wrapped to fit the Label's width.
 void textChanged(Label label, String previousText)
          Called when a label's text has changed.
 
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

LabelSkin

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

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

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; labels are not focusable.

isOpaque

public boolean isOpaque()
Description copied from class: ComponentSkin
By default, skins are assumed to be opaque.

Specified by:
isOpaque in interface Skin
Overrides:
isOpaque in class ComponentSkin
Returns:
true if this skin is opaque; false if any part of it is transparent or translucent.

getFont

public Font getFont()
Returns the font used in rendering the Label's text


setFont

public void setFont(Font font)
Sets the font used in rendering the Label's text


setFont

public final void setFont(String font)
Sets the font used in rendering the Label's text

Parameters:
font - A font specification

setFont

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

Parameters:
font - A dictionary describing a font

getColor

public Color getColor()
Returns the foreground color of the text of the label.


setColor

public void setColor(Color color)
Sets the foreground color of the text of the label.


setColor

public final void setColor(String color)
Sets the foreground color of the text of the label.

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

getDisabledColor

public Color getDisabledColor()
Returns the foreground color of the text of the label when disabled.


setDisabledColor

public void setDisabledColor(Color color)
Sets the foreground color of the text of the label when disabled.


setDisabledColor

public final void setDisabledColor(String color)
Sets the foreground color of the text of the label when disabled.

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

getBackgroundColor

public Color getBackgroundColor()
Returns the background color of the label.


setBackgroundColor

public void setBackgroundColor(Color backgroundColor)
Sets the background color of the label.


setBackgroundColor

public final void setBackgroundColor(String backgroundColor)
Sets the background color of the label.

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

getTextDecoration

public TextDecoration getTextDecoration()

setTextDecoration

public void setTextDecoration(TextDecoration textDecoration)

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment()

setHorizontalAlignment

public void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)

getVerticalAlignment

public VerticalAlignment getVerticalAlignment()

setVerticalAlignment

public void setVerticalAlignment(VerticalAlignment verticalAlignment)

getPadding

public Insets getPadding()
Returns the amount of space to leave between the edge of the Label and its text.


setPadding

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


setPadding

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

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 Label and its text, uniformly on all four edges.


setPadding

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


setPadding

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

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

getWrapText

public boolean getWrapText()
Returns true if the text of the label will be wrapped to fit the Label's width.


setWrapText

public void setWrapText(boolean wrapText)
Sets whether the text of the label will be wrapped to fit the Label's width. Note that for wrapping to occur, the Label must specify a preferred width or be placed in a container that constrains its width. Also note that newline characters (if wrapping is set true) will cause a hard line break.


textChanged

public void textChanged(Label label,
                        String previousText)
Description copied from interface: LabelListener
Called when a label's text has changed.

Specified by:
textChanged in interface LabelListener

maximumLengthChanged

public void maximumLengthChanged(Label label,
                                 int previousMaximumLength)
Description copied from interface: LabelListener
Called when a label text maximum length has changed.

Specified by:
maximumLengthChanged in interface LabelListener