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, ConstrainedVisual, LabelListener, Skin, Visual
Direct Known Subclasses:
TerraLabelSkin

public class LabelSkin
extends ComponentSkin
implements LabelListener

Label skin.

TODO showEllipsis style

TODO breakOnWhitespaceOnly style


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
 
Field Summary
 
Fields inherited from class org.apache.pivot.wtk.skin.ComponentSkin
SHOW_TOOLTIP_TIMEOUT
 
Constructor Summary
LabelSkin()
           
 
Method Summary
 Color getBackgroundColor()
           
 Color getColor()
           
 Font getFont()
           
 int getFontSize()
           
 HorizontalAlignment getHorizontalAlignment()
           
 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.
 TextDecoration getTextDecoration()
           
 VerticalAlignment getVerticalAlignment()
           
 boolean getWrapText()
           
 void install(Component component)
          Associates a skin with a component.
 boolean isFocusable()
          By default, components are focusable.
 boolean isFontBold()
           
 boolean isFontItalic()
           
 boolean isOpaque()
          Labels are never fully opaque.
 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 setBackgroundColor(Color backgroundColor)
           
 void setBackgroundColor(String backgroundColor)
           
 void setColor(Color color)
           
 void setColor(String color)
           
 void setFont(Font font)
           
 void setFont(String font)
           
 void setFontBold(boolean fontBold)
           
 void setFontItalic(boolean fontItalic)
           
 void setFontSize(int fontSize)
           
 void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)
           
 void setHorizontalAlignment(String horizontalAlignment)
           
 void setPadding(Dictionary<String,?> padding)
           
 void setPadding(Insets padding)
           
 void setPadding(int padding)
           
 void setPadding(Number padding)
           
 void setPadding(String padding)
           
 void setTextDecoration(String textDecoration)
           
 void setTextDecoration(TextDecoration textDecoration)
           
 void setVerticalAlignment(String verticalAlignment)
           
 void setVerticalAlignment(VerticalAlignment verticalAlignment)
           
 void setWrapText(boolean wrapText)
           
 void textChanged(Label label, String previousText)
          Called when a label's text has changed.
 void textKeyChanged(Label label, String previousTextKey)
          Called when a label's text key has changed.
 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, 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
 

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.

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.

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

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

isOpaque

public boolean isOpaque()
Labels are never fully opaque.

Specified by:
isOpaque in interface Skin
Overrides:
isOpaque in class ComponentSkin
Returns:
false.

getFont

public Font getFont()

setFont

public void setFont(Font font)

setFont

public final void setFont(String font)

getFontSize

public int getFontSize()

setFontSize

public void setFontSize(int fontSize)

isFontBold

public boolean isFontBold()

setFontBold

public void setFontBold(boolean fontBold)

isFontItalic

public boolean isFontItalic()

setFontItalic

public void setFontItalic(boolean fontItalic)

getColor

public Color getColor()

setColor

public void setColor(Color color)

setColor

public final void setColor(String color)

getBackgroundColor

public Color getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

setBackgroundColor

public final void setBackgroundColor(String backgroundColor)

getTextDecoration

public TextDecoration getTextDecoration()

setTextDecoration

public void setTextDecoration(TextDecoration textDecoration)

setTextDecoration

public final void setTextDecoration(String textDecoration)

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment()

setHorizontalAlignment

public void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)

setHorizontalAlignment

public final void setHorizontalAlignment(String horizontalAlignment)

getVerticalAlignment

public VerticalAlignment getVerticalAlignment()

setVerticalAlignment

public void setVerticalAlignment(VerticalAlignment verticalAlignment)

setVerticalAlignment

public final void setVerticalAlignment(String verticalAlignment)

getPadding

public Insets getPadding()

setPadding

public void setPadding(Insets padding)

setPadding

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

setPadding

public final void setPadding(int padding)

setPadding

public final void setPadding(Number padding)

setPadding

public final void setPadding(String padding)

getWrapText

public boolean getWrapText()

setWrapText

public void setWrapText(boolean wrapText)

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

textKeyChanged

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

Specified by:
textKeyChanged in interface LabelListener