Package org.apache.pivot.wtk.skin

Class TablePaneSkin

    • Constructor Detail

      • TablePaneSkin

        public TablePaneSkin()

    • Method Detail

      • install

        public void install​(Component component)
        Description copied from class: ComponentSkin
        Must be implemented in every subclass in order to do component-specific operations at instantiation time, but every subclass must call this superclass method to setup the necessary listeners, etc.
        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.
        Returns:
        The preferred width given the height 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.
        Returns:
        The preferred height given the width constraint.

      • getBaseline

        public int getBaseline​(int width,
                       int height)
        Description copied from class: ComponentSkin
        Should be implemented in every subclass.

        The default implementation here simply returns -1 (no baseline).

        Specified by:
        getBaseline in interface ConstrainedVisual
        Overrides:
        getBaseline in class ComponentSkin
        Parameters:
        width - Constrained width to compute the baseline for.
        height - Constrained height to compute the baseline for.
        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​(java.awt.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.
        Parameters:
        padding - The individual padding amounts for each edge.

      • setPadding

        public final void setPadding​(int padding)
        Sets the amount of space that will be reserved around the inside edges of the table pane.
        Parameters:
        padding - The single padding value to use for all the edges.

      • setPadding

        public final void setPadding​(Dictionary<java.lang.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 {top, left, bottom, right}.

      • setPadding

        public final void setPadding​(Sequence<?> padding)
        Sets the amount of space that will be reserved around the inside edges of the table pane.
        Parameters:
        padding - A sequence with values in the order [top, left, bottom, right].

      • setPadding

        public final void setPadding​(java.lang.Number padding)
        Sets the amount of space that will be reserved around the inside edges of the table pane.
        Parameters:
        padding - The single padding value to use for all the edges.

      • setPadding

        public final void setPadding​(java.lang.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()
        Returns:
        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.
        Parameters:
        horizontalSpacing - The new spacing value.

      • getVerticalSpacing

        public int getVerticalSpacing()
        Returns:
        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.
        Parameters:
        verticalSpacing - The new spacing value.

      • getShowHorizontalGridLines

        public boolean getShowHorizontalGridLines()
        Returns:
        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.
        Parameters:
        showHorizontalGridLines - Whether to show the horizontal lines.

      • getShowVerticalGridLines

        public boolean getShowVerticalGridLines()
        Returns:
        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.
        Parameters:
        showVerticalGridLines - Whether to show the vertical lines.

      • getHorizontalGridColor

        public java.awt.Color getHorizontalGridColor()
        Returns:
        The color used to paint the table pane's horizontal grid lines.

      • setHorizontalGridColor

        public void setHorizontalGridColor​(java.awt.Color horizontalGridColor)
        Sets the color used to paint the table pane's horizontal grid lines.
        Parameters:
        horizontalGridColor - The new grid line color.

      • setHorizontalGridColor

        public final void setHorizontalGridColor​(java.lang.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 java.awt.Color getVerticalGridColor()
        Returns:
        The color used to paint the table pane's vertical grid lines.

      • setVerticalGridColor

        public void setVerticalGridColor​(java.awt.Color verticalGridColor)
        Sets the color used to paint the table pane's vertical grid lines.
        Parameters:
        verticalGridColor - The new grid line color.

      • setVerticalGridColor

        public final void setVerticalGridColor​(java.lang.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 java.awt.Color getHighlightBackgroundColor()
        Returns:
        The background color used to paint the highlighted rows and columns.

      • setHighlightBackgroundColor

        public void setHighlightBackgroundColor​(java.awt.Color highlightBackgroundColor)
        Sets the background color used to paint the highlighted rows and columns.
        Parameters:
        highlightBackgroundColor - The new highlight color.

      • setHighlightBackgroundColor

        public final void setHighlightBackgroundColor​(java.lang.String highlightBackgroundColor)
        Sets the background color used to paint the highlighted rows and columns.
        Parameters:
        highlightBackgroundColor - Any of the color values recognized by Pivot.

      • 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
        Parameters:
        tablePane - The source of this event.
        index - The index of the inserted row.

      • 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
        Parameters:
        tablePane - The source of this event.
        index - The starting index of the rows that were removed.
        rows - The actual sequence of rows that were removed.

      • 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
        Parameters:
        row - The particular row whose height has changed.
        previousHeight - The previous numeric height value.
        previousRelative - Whether the previous row height was relative or not.

      • 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
        Parameters:
        tablePane - The table pane that changed.
        index - The location where the column was inserted.

      • columnsRemoved

        public void columnsRemoved​(TablePane tablePane,
                           int index,
                           Sequence<TablePane.Column> columns)
        Description copied from interface: TablePaneListener
        Called when columns have been removed from a table pane.
        Specified by:
        columnsRemoved in interface TablePaneListener
        Parameters:
        tablePane - The table pane that changed.
        index - The starting index of the removed columns.
        columns - The actual sequence of the columns that were removed.

      • 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
        Parameters:
        column - The column that changed.
        previousWidth - The previous numeric value of the width.
        previousRelative - Whether the previous width was relative or not.

      • 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
        Parameters:
        row - The table pane row that has changed.
        column - The index of the new column.

      • cellsRemoved

        public void cellsRemoved​(TablePane.Row row,
                         int column,
                         Sequence<Component> removed)
        Description copied from interface: TablePaneListener
        Called when cells have been removed from a table pane.
        Specified by:
        cellsRemoved in interface TablePaneListener
        Parameters:
        row - The table pane row that has changed.
        column - The starting index of the column(s) that were removed.
        removed - The actual sequence of removed columns.

      • 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
        Parameters:
        row - The table pane row that was changed.
        column - Index of the column that was updated.
        previousComponent - The previous cell contents.

      • 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
        Parameters:
        tablePane - The source of this event.
        component - The component that changed.
        previousRowSpan - What the row span value used to be.

      • 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
        Parameters:
        tablePane - The source of this event.
        component - THe component that changed.
        previousColumnSpan - What the column span for this component used to be.