org.apache.pivot.wtk.skin
Class TextAreaSkin

java.lang.Object
  extended by org.apache.pivot.wtk.skin.ComponentSkin
      extended by org.apache.pivot.wtk.skin.TextAreaSkin
All Implemented Interfaces:
ComponentKeyListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ConstrainedVisual, Skin, TextArea.Skin, TextAreaListener, TextAreaSelectionListener, Visual
Direct Known Subclasses:
TerraTextAreaSkin

public class TextAreaSkin
extends ComponentSkin
implements TextArea.Skin, TextAreaListener, TextAreaSelectionListener

Text area skin.


Nested Class Summary
 class TextAreaSkin.DocumentView
          Document view.
 class TextAreaSkin.ElementView
          Abstract base class for element views.
 class TextAreaSkin.ImageNodeView
           
 class TextAreaSkin.NodeView
          Abstract base class for node views.
 class TextAreaSkin.ParagraphView
           
 class TextAreaSkin.TextNodeView
          Text node view.
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.TextAreaListener
TextAreaListener.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
 
Field Summary
 
Fields inherited from class org.apache.pivot.wtk.skin.ComponentSkin
SHOW_TOOLTIP_TIMEOUT
 
Constructor Summary
TextAreaSkin()
           
 
Method Summary
 void documentChanged(TextArea textArea, Document previousDocument)
          Called when a text area's document has changed.
 void editableChanged(TextArea textArea)
          Called when a text area's editable state has changed.
 void enabledChanged(Component component)
          Called when a component's enabled state has changed.
 void focusedChanged(Component component, Component obverseComponent)
          Called when a component's focused state has changed.
 Color getBackgroundColor()
           
 int getBaseline(int width, int height)
          Returns the baseline for a given width and height.
 Bounds getCharacterBounds(int offset)
          Returns the bounds of the character at a given offset within the document.
 Color getColor()
           
 Font getFont()
           
 Color getInactiveColor()
           
 Color getInactiveSelectionBackgroundColor()
           
 Color getInactiveSelectionColor()
           
 int getInsertionPoint(int x, int y)
          Returns the insertion point for a given location.
 Insets getMargin()
           
 int getNextInsertionPoint(int x, int from, FocusTraversalDirection direction)
          Returns the next insertion point given an x coordinate and a character offset.
 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 getRowCount()
          Returns the total number of rows in the document.
 int getRowIndex(int offset)
          Returns the row index of the character at a given offset within the document.
 Color getSelectionBackgroundColor()
           
 Color getSelectionColor()
           
 boolean getWrapText()
           
 void install(Component component)
          Associates a skin with a component.
 boolean isFocusable()
          By default, components are focusable.
 boolean isOpaque()
          By default, skins are assumed to be opaque.
 boolean keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation)
          Called when a key has been pressed.
 boolean keyTyped(Component component, char character)
          Called when a key has been typed.
 void layout()
          If the component on which the skin is installed is a container, lays out the container's children.
 boolean mouseDown(Component component, Mouse.Button button, int x, int y)
          Called when a mouse button is pressed over a component.
 boolean mouseMove(Component component, int x, int y)
          Called when the mouse is moved over a component.
 boolean mouseUp(Component component, Mouse.Button button, int x, int y)
          Called when a mouse button is released over a component.
 void paint(Graphics2D graphics)
          Paints the visual.
 void selectionChanged(TextArea textArea, int previousSelectionStart, int previousSelectionLength)
          Called when a text area's selection state has changed.
 void setBackgroundColor(Color backgroundColor)
           
 void setBackgroundColor(String backgroundColor)
           
 void setColor(Color color)
           
 void setColor(String color)
           
 void setFont(Dictionary<String,?> font)
           
 void setFont(Font font)
           
 void setFont(String font)
           
 void setInactiveColor(Color inactiveColor)
           
 void setInactiveColor(String inactiveColor)
           
 void setInactiveSelectionBackgroundColor(Color inactiveSelectionBackgroundColor)
           
 void setInactiveSelectionBackgroundColor(String inactiveSelectionBackgroundColor)
           
 void setInactiveSelectionColor(Color inactiveSelectionColor)
           
 void setInactiveSelectionColor(String inactiveSelectionColor)
           
 void setMargin(Dictionary<String,?> margin)
           
 void setMargin(Insets margin)
           
 void setMargin(int margin)
           
 void setMargin(Number margin)
           
 void setMargin(String margin)
           
 void setSelectionBackgroundColor(Color selectionBackgroundColor)
           
 void setSelectionBackgroundColor(String selectionBackgroundColor)
           
 void setSelectionColor(Color selectionColor)
           
 void setSelectionColor(String selectionColor)
           
 void setWrapText(boolean wrapText)
           
 
Methods inherited from class org.apache.pivot.wtk.skin.ComponentSkin
cursorChanged, decodeFont, dragSourceChanged, dropTargetChanged, getBaseline, getComponent, getHeight, getWidth, invalidateComponent, keyReleased, locationChanged, menuHandlerChanged, mouseClick, mouseOut, mouseOver, 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

TextAreaSkin

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

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:
true if this skin is focusable; false, otherwise.

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.

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.

getInsertionPoint

public int getInsertionPoint(int x,
                             int y)
Description copied from interface: TextArea.Skin
Returns the insertion point for a given location.

Specified by:
getInsertionPoint in interface TextArea.Skin
Returns:
The insertion point for the given location.

getNextInsertionPoint

public int getNextInsertionPoint(int x,
                                 int from,
                                 FocusTraversalDirection direction)
Description copied from interface: TextArea.Skin
Returns the next insertion point given an x coordinate and a character offset.

Specified by:
getNextInsertionPoint in interface TextArea.Skin
Returns:
The next insertion point.

getRowIndex

public int getRowIndex(int offset)
Description copied from interface: TextArea.Skin
Returns the row index of the character at a given offset within the document.

Specified by:
getRowIndex in interface TextArea.Skin
Returns:
The row index of the character at the given offset.

getRowCount

public int getRowCount()
Description copied from interface: TextArea.Skin
Returns the total number of rows in the document.

Specified by:
getRowCount in interface TextArea.Skin
Returns:
The number of rows in the document.

getCharacterBounds

public Bounds getCharacterBounds(int offset)
Description copied from interface: TextArea.Skin
Returns the bounds of the character at a given offset within the document.

Specified by:
getCharacterBounds in interface TextArea.Skin
Returns:
The bounds of the character at the given offset.

getColor

public Color getColor()

setColor

public void setColor(Color color)

setColor

public final void setColor(String color)

getInactiveColor

public Color getInactiveColor()

setInactiveColor

public void setInactiveColor(Color inactiveColor)

setInactiveColor

public final void setInactiveColor(String inactiveColor)

getBackgroundColor

public Color getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

setBackgroundColor

public final void setBackgroundColor(String backgroundColor)

getFont

public Font getFont()

setFont

public void setFont(Font font)

setFont

public final void setFont(String font)

setFont

public final void setFont(Dictionary<String,?> font)

getSelectionColor

public Color getSelectionColor()

setSelectionColor

public void setSelectionColor(Color selectionColor)

setSelectionColor

public final void setSelectionColor(String selectionColor)

getSelectionBackgroundColor

public Color getSelectionBackgroundColor()

setSelectionBackgroundColor

public void setSelectionBackgroundColor(Color selectionBackgroundColor)

setSelectionBackgroundColor

public final void setSelectionBackgroundColor(String selectionBackgroundColor)

getInactiveSelectionColor

public Color getInactiveSelectionColor()

setInactiveSelectionColor

public void setInactiveSelectionColor(Color inactiveSelectionColor)

setInactiveSelectionColor

public final void setInactiveSelectionColor(String inactiveSelectionColor)

getInactiveSelectionBackgroundColor

public Color getInactiveSelectionBackgroundColor()

setInactiveSelectionBackgroundColor

public void setInactiveSelectionBackgroundColor(Color inactiveSelectionBackgroundColor)

setInactiveSelectionBackgroundColor

public final void setInactiveSelectionBackgroundColor(String inactiveSelectionBackgroundColor)

getMargin

public Insets getMargin()

setMargin

public void setMargin(Insets margin)

setMargin

public final void setMargin(Dictionary<String,?> margin)

setMargin

public final void setMargin(int margin)

setMargin

public final void setMargin(Number margin)

setMargin

public final void setMargin(String margin)

getWrapText

public boolean getWrapText()

setWrapText

public void setWrapText(boolean wrapText)

mouseMove

public boolean mouseMove(Component component,
                         int x,
                         int y)
Description copied from interface: ComponentMouseListener
Called when the mouse is moved over a component.

Specified by:
mouseMove in interface ComponentMouseListener
Overrides:
mouseMove in class ComponentSkin
Returns:
true to consume the event; false to allow it to propagate.

mouseDown

public boolean mouseDown(Component component,
                         Mouse.Button button,
                         int x,
                         int y)
Description copied from interface: ComponentMouseButtonListener
Called when a mouse button is pressed over a component.

Specified by:
mouseDown in interface ComponentMouseButtonListener
Overrides:
mouseDown in class ComponentSkin
Returns:
true to consume the event; false to allow it to propagate.

mouseUp

public boolean mouseUp(Component component,
                       Mouse.Button button,
                       int x,
                       int y)
Description copied from interface: ComponentMouseButtonListener
Called when a mouse button is released over a component.

Specified by:
mouseUp in interface ComponentMouseButtonListener
Overrides:
mouseUp in class ComponentSkin
Returns:
true to consume the event; false to allow it to propagate.

keyTyped

public boolean keyTyped(Component component,
                        char character)
Description copied from interface: ComponentKeyListener
Called when a key has been typed.

Specified by:
keyTyped in interface ComponentKeyListener
Overrides:
keyTyped in class ComponentSkin
Returns:
true to consume the event; false to allow it to propagate.

keyPressed

public boolean keyPressed(Component component,
                          int keyCode,
                          Keyboard.KeyLocation keyLocation)
Description copied from interface: ComponentKeyListener
Called when a key has been pressed.

Specified by:
keyPressed in interface ComponentKeyListener
Overrides:
keyPressed in class ComponentSkin
Returns:
true to consume the event; false to allow it to propagate.

enabledChanged

public void enabledChanged(Component component)
Description copied from interface: ComponentStateListener
Called when a component's enabled state has changed.

Specified by:
enabledChanged in interface ComponentStateListener
Overrides:
enabledChanged in class ComponentSkin

focusedChanged

public void focusedChanged(Component component,
                           Component obverseComponent)
Description copied from interface: ComponentStateListener
Called when a component's focused state has changed.

Specified by:
focusedChanged in interface ComponentStateListener
Overrides:
focusedChanged in class ComponentSkin

documentChanged

public void documentChanged(TextArea textArea,
                            Document previousDocument)
Description copied from interface: TextAreaListener
Called when a text area's document has changed.

Specified by:
documentChanged in interface TextAreaListener

editableChanged

public void editableChanged(TextArea textArea)
Description copied from interface: TextAreaListener
Called when a text area's editable state has changed.

Specified by:
editableChanged in interface TextAreaListener

selectionChanged

public void selectionChanged(TextArea textArea,
                             int previousSelectionStart,
                             int previousSelectionLength)
Description copied from interface: TextAreaSelectionListener
Called when a text area's selection state has changed.

Specified by:
selectionChanged in interface TextAreaSelectionListener