org.apache.pivot.wtk.skin
Class TablePaneSkin

java.lang.Object
  extended by org.apache.pivot.wtk.skin.ComponentSkin
      extended by org.apache.pivot.wtk.skin.ContainerSkin
          extended by org.apache.pivot.wtk.skin.TablePaneSkin
All Implemented Interfaces:
ComponentKeyListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ComponentTooltipListener, ConstrainedVisual, ContainerListener, ContainerMouseListener, Skin, TablePane.Skin, TablePaneAttributeListener, TablePaneListener, Visual
Direct Known Subclasses:
TerraTablePaneSkin

public class TablePaneSkin
extends ContainerSkin
implements TablePane.Skin, TablePaneListener, TablePaneAttributeListener

Table pane skin.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.skin.ContainerSkin
ContainerSkin.IndexFocusTraversalPolicy
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.TablePaneListener
TablePaneListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.TablePaneAttributeListener
TablePaneAttributeListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ContainerListener
ContainerListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ContainerMouseListener
ContainerMouseListener.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
TablePaneSkin()
           
 
Method Summary
 void cellInserted(TablePane.Row row, int column)
          Called when a cell has been inserted into a table pane.
 void cellsRemoved(TablePane.Row row, int column, Sequence<Component> removed)
          Called when cell's have been removed from a table pane.
 void cellUpdated(TablePane.Row row, int column, Component previousComponent)
          Called when a cell has been updated in a table pane.
 void columnHighlightedChanged(TablePane.Column column)
          Called when a column's highlighted state has changed.
 void columnInserted(TablePane tablePane, int index)
          Called when a column has been inserted into a table pane.
 void columnSpanChanged(TablePane tablePane, Component component, int previousColumnSpan)
          Called when a component's column span attribute has changed.
 void columnsRemoved(TablePane tablePane, int index, Sequence<TablePane.Column> columns)
          Called when column's have been removed from a table pane.
 void columnWidthChanged(TablePane.Column column, int previousWidth, boolean previousRelative)
          Called when a column's width has changed.
 int getBaseline(int width, int height)
          Returns the baseline for a given width and height.
 int getColumnAt(int x)
           
 Bounds getColumnBounds(int column)
           
 Color getHighlightBackgroundColor()
          Gets the background color used to paint the highlighted rows and columns.
 Color getHorizontalGridColor()
          Gets the color used to paint the table pane's horizontal grid lines.
 int getHorizontalSpacing()
          Gets the spacing that will be applied between the table pane's columns during layout.
 Insets getPadding()
          Returns the amount of space that will be reserved around the inside edges of the table pane.
 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 getRowAt(int y)
           
 Bounds getRowBounds(int row)
           
 boolean getShowHorizontalGridLines()
          Tells whether or not horizontal grid lines will be painted in between the table pane's rows.
 boolean getShowVerticalGridLines()
          Tells whether or not vertical grid lines will be painted in between the table pane's columns.
 Color getVerticalGridColor()
          Gets the color used to paint the table pane's vertical grid lines.
 int getVerticalSpacing()
          Gets the spacing that will be applied in between the table pane's rows during layout.
 void install(Component component)
          Associates a skin with a component.
 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 rowHeightChanged(TablePane.Row row, int previousHeight, boolean previousRelative)
          Called when a row's height has changed.
 void rowHighlightedChanged(TablePane.Row row)
          Called when a row's highlighted state has changed.
 void rowInserted(TablePane tablePane, int index)
          Called when a row has been inserted into a table pane.
 void rowSpanChanged(TablePane tablePane, Component component, int previousRowSpan)
          Called when a component's row span attribute has changed.
 void rowsRemoved(TablePane tablePane, int index, Sequence<TablePane.Row> rows)
          Called when rows have been removed from a table pane.
 void setHighlightBackgroundColor(Color highlightBackgroundColor)
          Sets the background color used to paint the highlighted rows and columns.
 void setHighlightBackgroundColor(String highlightBackgroundColor)
          Sets the background color used to paint the highlighted rows and columns.
 void setHorizontalGridColor(Color horizontalGridColor)
          Sets the color used to paint the table pane's horizontal grid lines.
 void setHorizontalGridColor(String horizontalGridColor)
          Sets the color used to paint the table pane's horizontal grid lines.
 void setHorizontalSpacing(int horizontalSpacing)
          Sets the spacing that will be applied between the table pane's columns during layout.
 void setPadding(Dictionary<String,?> padding)
          Sets the amount of space that will be reserved around the inside edges of the table pane.
 void setPadding(Insets padding)
          Sets the amount of space that will be reserved around the inside edges of the table pane.
 void setPadding(int padding)
          Sets the amount of space that will be reserved around the inside edges of the table pane.
 void setPadding(Number padding)
          Sets the amount of space that will be reserved around the inside edges of the table pane.
 void setPadding(String padding)
          Sets the amount of space that will be reserved around the inside edges of the table pane.
 void setShowHorizontalGridLines(boolean showHorizontalGridLines)
          Sets whether or not horizontal grid lines will be painted in between the table pane's rows.
 void setShowVerticalGridLines(boolean showVerticalGridLines)
          Sets whether or not vertical grid lines will be painted in between the table pane's columns.
 void setVerticalGridColor(Color verticalGridColor)
          Sets the color used to paint the table pane's vertical grid lines.
 void setVerticalGridColor(String verticalGridColor)
          Sets the color used to paint the table pane's vertical grid lines.
 void setVerticalSpacing(int verticalSpacing)
          Sets the spacing that will be applied in between the table pane's rows during layout.
 
Methods inherited from class org.apache.pivot.wtk.skin.ContainerSkin
componentInserted, componentMoved, componentsRemoved, focusTraversalPolicyChanged, getBackgroundColor, getBackgroundPaint, isFocusable, isOpaque, mouseDown, mouseMove, mouseUp, mouseWheel, setBackgroundColor, setBackgroundColor, setBackgroundPaint, setBackgroundPaint, setBackgroundPaint
 
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

TablePaneSkin

public TablePaneSkin()
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 ContainerSkin
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
Overrides:
getPreferredWidth in class ContainerSkin
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
Overrides:
getPreferredHeight in class ContainerSkin
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
Overrides:
paint in class ContainerSkin
Parameters:
graphics - The graphics context in which to paint the visual.

getPadding

public Insets getPadding()
Returns the amount of space that will be reserved around the inside edges of the table pane.


setPadding

public void setPadding(Insets padding)
Sets the amount of space that will be reserved around the inside edges of the table pane.


setPadding

public final void setPadding(int padding)
Sets the amount of space that will be reserved around the inside edges of the table pane.


setPadding

public final void setPadding(Dictionary<String,?> padding)
Sets the amount of space that will be reserved around the inside edges of the table pane.

Parameters:
padding - A dictionary with keys in the set {left, top, bottom, right}.

setPadding

public final void setPadding(Number padding)
Sets the amount of space that will be reserved around the inside edges of the table pane.


setPadding

public final void setPadding(String padding)
Sets the amount of space that will be reserved around the inside edges of the table pane.

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

getHorizontalSpacing

public int getHorizontalSpacing()
Gets the spacing that will be applied between the table pane's columns during layout.


setHorizontalSpacing

public void setHorizontalSpacing(int horizontalSpacing)
Sets the spacing that will be applied between the table pane's columns during layout.


getVerticalSpacing

public int getVerticalSpacing()
Gets the spacing that will be applied in between the table pane's rows during layout.


setVerticalSpacing

public void setVerticalSpacing(int verticalSpacing)
Sets the spacing that will be applied in between the table pane's rows during layout.


getShowHorizontalGridLines

public boolean getShowHorizontalGridLines()
Tells whether or not horizontal grid lines will be painted in between the table pane's rows.


setShowHorizontalGridLines

public void setShowHorizontalGridLines(boolean showHorizontalGridLines)
Sets whether or not horizontal grid lines will be painted in between the table pane's rows.


getShowVerticalGridLines

public boolean getShowVerticalGridLines()
Tells whether or not vertical grid lines will be painted in between the table pane's columns.


setShowVerticalGridLines

public void setShowVerticalGridLines(boolean showVerticalGridLines)
Sets whether or not vertical grid lines will be painted in between the table pane's columns.


getHorizontalGridColor

public Color getHorizontalGridColor()
Gets the color used to paint the table pane's horizontal grid lines.


setHorizontalGridColor

public void setHorizontalGridColor(Color horizontalGridColor)
Sets the color used to paint the table pane's horizontal grid lines.


setHorizontalGridColor

public final void setHorizontalGridColor(String horizontalGridColor)
Sets the color used to paint the table pane's horizontal grid lines.

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

getVerticalGridColor

public Color getVerticalGridColor()
Gets the color used to paint the table pane's vertical grid lines.


setVerticalGridColor

public void setVerticalGridColor(Color verticalGridColor)
Sets the color used to paint the table pane's vertical grid lines.


setVerticalGridColor

public final void setVerticalGridColor(String verticalGridColor)
Sets the color used to paint the table pane's vertical grid lines.

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

getHighlightBackgroundColor

public Color getHighlightBackgroundColor()
Gets the background color used to paint the highlighted rows and columns.


setHighlightBackgroundColor

public void setHighlightBackgroundColor(Color highlightBackgroundColor)
Sets the background color used to paint the highlighted rows and columns.


setHighlightBackgroundColor

public final void setHighlightBackgroundColor(String highlightBackgroundColor)
Sets the background color used to paint the highlighted rows and columns.

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

getRowAt

public int getRowAt(int y)
Specified by:
getRowAt in interface TablePane.Skin

getRowBounds

public Bounds getRowBounds(int row)
Specified by:
getRowBounds in interface TablePane.Skin

getColumnAt

public int getColumnAt(int x)
Specified by:
getColumnAt in interface TablePane.Skin

getColumnBounds

public Bounds getColumnBounds(int column)
Specified by:
getColumnBounds in interface TablePane.Skin

rowInserted

public void rowInserted(TablePane tablePane,
                        int index)
Description copied from interface: TablePaneListener
Called when a row has been inserted into a table pane.

Specified by:
rowInserted in interface TablePaneListener

rowsRemoved

public void rowsRemoved(TablePane tablePane,
                        int index,
                        Sequence<TablePane.Row> rows)
Description copied from interface: TablePaneListener
Called when rows have been removed from a table pane.

Specified by:
rowsRemoved in interface TablePaneListener

rowHeightChanged

public void rowHeightChanged(TablePane.Row row,
                             int previousHeight,
                             boolean previousRelative)
Description copied from interface: TablePaneListener
Called when a row's height has changed.

Specified by:
rowHeightChanged in interface TablePaneListener

rowHighlightedChanged

public void rowHighlightedChanged(TablePane.Row row)
Description copied from interface: TablePaneListener
Called when a row's highlighted state has changed.

Specified by:
rowHighlightedChanged in interface TablePaneListener

columnInserted

public void columnInserted(TablePane tablePane,
                           int index)
Description copied from interface: TablePaneListener
Called when a column has been inserted into a table pane.

Specified by:
columnInserted in interface TablePaneListener

columnsRemoved

public void columnsRemoved(TablePane tablePane,
                           int index,
                           Sequence<TablePane.Column> columns)
Description copied from interface: TablePaneListener
Called when column's have been removed from a table pane.

Specified by:
columnsRemoved in interface TablePaneListener

columnWidthChanged

public void columnWidthChanged(TablePane.Column column,
                               int previousWidth,
                               boolean previousRelative)
Description copied from interface: TablePaneListener
Called when a column's width has changed.

Specified by:
columnWidthChanged in interface TablePaneListener

columnHighlightedChanged

public void columnHighlightedChanged(TablePane.Column column)
Description copied from interface: TablePaneListener
Called when a column's highlighted state has changed.

Specified by:
columnHighlightedChanged in interface TablePaneListener

cellInserted

public void cellInserted(TablePane.Row row,
                         int column)
Description copied from interface: TablePaneListener
Called when a cell has been inserted into a table pane.

Specified by:
cellInserted in interface TablePaneListener

cellsRemoved

public void cellsRemoved(TablePane.Row row,
                         int column,
                         Sequence<Component> removed)
Description copied from interface: TablePaneListener
Called when cell's have been removed from a table pane.

Specified by:
cellsRemoved in interface TablePaneListener

cellUpdated

public void cellUpdated(TablePane.Row row,
                        int column,
                        Component previousComponent)
Description copied from interface: TablePaneListener
Called when a cell has been updated in a table pane.

Specified by:
cellUpdated in interface TablePaneListener

rowSpanChanged

public void rowSpanChanged(TablePane tablePane,
                           Component component,
                           int previousRowSpan)
Description copied from interface: TablePaneAttributeListener
Called when a component's row span attribute has changed.

Specified by:
rowSpanChanged in interface TablePaneAttributeListener

columnSpanChanged

public void columnSpanChanged(TablePane tablePane,
                              Component component,
                              int previousColumnSpan)
Description copied from interface: TablePaneAttributeListener
Called when a component's column span attribute has changed.

Specified by:
columnSpanChanged in interface TablePaneAttributeListener