xdev.ui.table

Interface ExtendedTable<C extends JComponent>

All Superinterfaces:

FormularComponent<C>, MasterDetailComponent<C>, VirtualTableOwner

All Known Implementing Classes:

XdevTable

public interface ExtendedTable<C extends JComponent>
extends MasterDetailComponent<C>

A ExtendedTable interface provides a useful extension to the subclasses of JTable.

Since:

3.0

Author:

XDEV Software

Nested Class Summary

Nested classes/interfaces inherited from interface xdev.ui.MasterDetailComponent

MasterDetailComponent.DetailHandler

Nested classes/interfaces inherited from interface xdev.ui.FormularComponent

FormularComponent.ValueChangeListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	EDITABLE_PROPERTY Property constant for "editable".

Fields inherited from interface xdev.ui.FormularComponent

DATA_FIELD_SEPARATOR

Method Summary

Modifier and Type	Method and Description
void	clear() Clears any existing data before creating the new DefaultTableModel.
void	ensureCellIsVisible(int rowIndex, int columnIndex) Scrolls to the desired cell.
void	ensureColumnIsVisible(int columnIndex) Scrolls to the desired column.
void	ensureRowIsVisible(int rowIndex) Scrolls to the desired row.
void	exportCSV(Writer writer) Exports data of this XdevTable as CSV information to a specified Writer.
void	exportCSV(Writer writer, char delimiter) Exports data of this XdevTable as CSV information to a specified Writer.
void	exportCSV(Writer writer, char delimiter, boolean withColumnNames) Exports data of this XdevTable as CSV information to a specified Writer.
int	getColumnAtPoint(int x, int y) Returns the index of the column that x- and y-coordinate lies in or -1 if the result is not in the range [0, JTable.getColumnCount() -1].
int	getColumnAtPoint(Point location) This method is a alias for JTable.columnAtPoint(Point).
Color	getEvenBackground() Returns the background Color of even rows.
Color	getOddBackground() Returns the background Color of odd rows.
int	getRowAtPoint(int x, int y) Returns the view-index of the row that x- and y-coordinate lies in.
int	getRowAtPoint(Point location) Returns the view-index of the row that Point lies in, or -1 if the result is not in the range [0, JTable.getRowCount()-1].
int	getSelectedModelRow() Returns the index of the TableModel for the first selected row or -1 if no row is selected.
int[]	getSelectedModelRows() Returns the indices of all selected rows in the TableModel.
VirtualTable.VirtualTableRow	getSelectedVirtualTableRow() Returns the selected VirtualTable.VirtualTableRow of this component, or null if nothing is selected.
VirtualTable.VirtualTableRow[]	getSelectedVirtualTableRows() Returns the selected VirtualTable.VirtualTableRows of this component, or an empty array if nothing is selected.
int	getVisibleRowCount() Returns the value of the visibleRows property.
boolean	isEditable() Determines if the ExtendedTable is editable.
boolean	isSomethingSelected() Return true if something is selected, otherwise false.
void	setColumnTitle(int index, String title) Sets the title of the desired column with the index.
void	setColumnWidth(int index, int width) Sets the columns preferredWidth and the columns width.
void	setDefaultEditor(TableCellEditor editor) Clears all previous set editors and registers editor as default editor for Object.class, which makes it the default editor as long as no other editor is set for a specific column class.
void	setDefaultRenderer(TableCellRenderer renderer) Clears all previous set renderers and registers renderer as default renderer for Object.class, which makes it the default renderer as long as no other renderer is set for a specific column class.
void	setEditable(boolean editable) Sets the specified boolean to indicate whether or not this ExtendedTable should be editable.
void	setEvenBackground(Color evenBackground) Sets the background Color of even rows.
void	setModel(VirtualTable vt) Creates a new TableModel based on a VirtualTable and other specified parameters and sets it for this Table.
void	setModel(VirtualTable vt, String columns, boolean queryData) Creates a new TableModel based on a VirtualTable and other specified parameters and sets it for this Table.
void	setModel(VirtualTable vt, String columns, boolean queryData, boolean selectiveQuery) Creates a new TableModel based on a VirtualTable and other specified parameters and sets it for this Table.
void	setModel(VirtualTable vt, String columns, SELECT select, Object... params) Creates a new TableModel based on a VirtualTable and other specified parameters and sets it for this Table.
void	setOddBackground(Color oddBackground) Sets the background Color of odd rows.
void	setSelectedModelRow(int row) Selects the row row in the view.
void	setSelectedModelRows(int[] rows) Selects all rows with the indices specified in the list.
void	setSelectedModelRows(int start, int end) Changes the selection to be between start and end inclusive.
void	setSelectedRows(int[] indices) Changes the selection to be the set of indices specified by the given array.
void	setSelectedVirtualTableRow(VirtualTable.VirtualTableRow row) Selects the row in the table if present.
void	setSelectedVirtualTableRows(VirtualTable.VirtualTableRow[] rows) Selects the rows in the table if present.
void	setVisibleRowCount(int visibleRows) Sets the visibleRows property, which has different meanings depending on the layout orientation: For a VERTICAL layout orientation, this sets the preferred number of rows to display without requiring scrolling; for other orientations, it affects the wrapping of cells.

Methods inherited from interface xdev.ui.MasterDetailComponent

clearModel, refresh, setDetailHandler, setMasterValue

Methods inherited from interface xdev.ui.FormularComponent

addValidator, addValueChangeListener, getClientProperty, getDataField, getFilterOperator, getFormularName, getFormularValue, getValidators, hasStateChanged, isEnabled, isMultiSelect, isReadOnly, isVisible, putClientProperty, removeValidator, restoreState, saveState, setDataField, setFilterOperator, setFormularValue, setFormularValue, setReadOnly, validateState, validateState, verify

Methods inherited from interface xdev.ui.VirtualTableOwner

getVirtualTable, setVirtualTable, updateModel

Field Detail

EDITABLE_PROPERTY

static final String EDITABLE_PROPERTY

Property constant for "editable".

See Also:

Constant Field Values

Method Detail

isEditable

boolean isEditable()

Determines if the ExtendedTable is editable. Returns true if the ExtendedTable is editable or false if not.

Returns:

true if the ExtendedTable is editable or false if not.

setEditable

void setEditable(boolean editable)

Sets the specified boolean to indicate whether or not this ExtendedTable should be editable. A PropertyChange event ("EDITABLE_PROPERTY") is fired when the state is changed.

Parameters:

editable - the boolean to be set

setModel

void setModel(VirtualTable vt)

Creates a new TableModel based on a VirtualTable and other specified parameters and sets it for this Table.

The TableModel contains all columns and all rows of the specified vt

Parameters:

vt - the VirtualTable containing the data for the TableModel

setModel

void setModel(VirtualTable vt,
              String columns,
              boolean queryData)

Creates a new TableModel based on a VirtualTable and other specified parameters and sets it for this Table.

Parameters:

vt - the VirtualTable containing the data for the TableModel

columns - a comma separated list of valid column names for the param vt, may be "*" for all columns

queryData - if true, the best fitting select for this vt is used

setModel

void setModel(VirtualTable vt,
              String columns,
              boolean queryData,
              boolean selectiveQuery)

Creates a new TableModel based on a VirtualTable and other specified parameters and sets it for this Table.

Parameters:

vt - the VirtualTable containing the data for the TableModel

columns - a comma separated list of valid column names for the param vt, may be "*" for all columns

queryData - if true, the best fitting select for this vt is used

selectiveQuery - if true, only the display columns are queried

Since:

5.0

setModel

void setModel(VirtualTable vt,
              String columns,
              SELECT select,
              Object... params)

Creates a new TableModel based on a VirtualTable and other specified parameters and sets it for this Table.

Parameters:

vt - the VirtualTable containing the data for the TableModel

columns - a comma separated list of valid column names for the param vt, may be "*" for all columns

select - a custom SELECT for filtering or ordering the results of the vt, may be null for the default select

params - a set of parameters related to the param select, may be null

setVisibleRowCount

void setVisibleRowCount(int visibleRows)

Sets the visibleRows property, which has different meanings depending on the layout orientation: For a VERTICAL layout orientation, this sets the preferred number of rows to display without requiring scrolling; for other orientations, it affects the wrapping of cells.

Parameters:

visibleRows - an integer specifying the preferred number of rows to display without requiring scrolling

See Also:

getVisibleRowCount(), JComponent.getVisibleRect(), JViewport

getVisibleRowCount

int getVisibleRowCount()

Returns the value of the visibleRows property. See the documentation for setVisibleRowCount(int) for details on how to interpret this value.

Returns:

the value of the visibleRows property.

See Also:

setVisibleRowCount(int)

setEvenBackground

void setEvenBackground(Color evenBackground)

Sets the background Color of even rows.

Parameters:

evenBackground - The background of even rows as type Color.

getEvenBackground

Color getEvenBackground()

Returns the background Color of even rows.

Returns:

The background of even rows as type Color.

setOddBackground

void setOddBackground(Color oddBackground)

Sets the background Color of odd rows.

Parameters:

oddBackground - The background of odd rows as type Color.

getOddBackground

Color getOddBackground()

Returns the background Color of odd rows.

Returns:

The background of odd rows as type Color.

exportCSV

void exportCSV(Writer writer)
        throws IOException

Exports data of this XdevTable as CSV information to a specified Writer.

This is an alias for exportCSV(Writer, char).

Parameters:

writer - the Writer to write CSV information to

Throws:

IOException - if CSV file couldn't be written

exportCSV

void exportCSV(Writer writer,
               char delimiter)
        throws IOException

Exports data of this XdevTable as CSV information to a specified Writer.

This is an alias for exportCSV(Writer, char, boolean).

Parameters:

writer - the Writer to write CSV information to

delimiter - the delimiter to use for separating entries.

Throws:

IOException - if CSV file couldn't be written

exportCSV

void exportCSV(Writer writer,
               char delimiter,
               boolean withColumnNames)
        throws IOException

Exports data of this XdevTable as CSV information to a specified Writer.

Parameters:

writer - the Writer to write CSV information to

delimiter - the delimiter to use for separating entries.

withColumnNames - a flag to control whether the columns are written

Throws:

IOException - if CSV file couldn't be written

clear

void clear()

Clears any existing data before creating the new DefaultTableModel.

setDefaultRenderer

void setDefaultRenderer(TableCellRenderer renderer)

Clears all previous set renderers and registers renderer as default renderer for Object.class, which makes it the default renderer as long as no other renderer is set for a specific column class.

Parameters:

renderer - the new default renderer

See Also:

setDefaultEditor(TableCellEditor), TableColumn.setCellRenderer(TableCellRenderer)

setDefaultEditor

void setDefaultEditor(TableCellEditor editor)

Clears all previous set editors and registers editor as default editor for Object.class, which makes it the default editor as long as no other editor is set for a specific column class.

Parameters:

editor - the new default editor

See Also:

setDefaultRenderer(TableCellRenderer), TableColumn.setCellEditor(TableCellEditor)

isSomethingSelected

boolean isSomethingSelected()

Return true if something is selected, otherwise false.

Returns:

true if something is selected, otherwise false

getSelectedModelRow

int getSelectedModelRow()
                 throws IndexOutOfBoundsException

Returns the index of the TableModel for the first selected row or -1 if no row is selected.

Returns:

the index of the corresponding row in the TableModel

Throws:

IndexOutOfBoundsException - if sorting is enabled and passed an index outside the range of the JTable as determined by the method JTable.getRowCount()

See Also:

JTable.convertRowIndexToModel(int), JTable.getSelectedRow()

getSelectedModelRows

int[] getSelectedModelRows()
                    throws IndexOutOfBoundsException

Returns the indices of all selected rows in the TableModel.

Returns:

a list of integers containing the indices of all selected rows, or an empty list if no row is selected

Throws:

IndexOutOfBoundsException - if sorting is enabled and passed an index outside the range of the JTable as determined by the method JTable.getRowCount()

See Also:

JTable.convertRowIndexToModel(int), JTable.getSelectedRows()

getSelectedVirtualTableRow

VirtualTable.VirtualTableRow getSelectedVirtualTableRow()

Returns the selected VirtualTable.VirtualTableRow of this component, or null if nothing is selected.

Specified by:

getSelectedVirtualTableRow in interface MasterDetailComponent<C extends JComponent>

Returns:

the selected VirtualTable.VirtualTableRow of this component

setSelectedVirtualTableRow

void setSelectedVirtualTableRow(VirtualTable.VirtualTableRow row)

Selects the row in the table if present.

Parameters:

row - the row to select

Since:

3.2

getSelectedVirtualTableRows

VirtualTable.VirtualTableRow[] getSelectedVirtualTableRows()

Returns the selected VirtualTable.VirtualTableRows of this component, or an empty array if nothing is selected.

Returns:

the selected VirtualTable.VirtualTableRows of this component

setSelectedVirtualTableRows

void setSelectedVirtualTableRows(VirtualTable.VirtualTableRow[] rows)

Selects the rows in the table if present.

Parameters:

rows - the rows to select

Since:

3.2

setSelectedModelRow

void setSelectedModelRow(int row)
                  throws IndexOutOfBoundsException,
                         IllegalArgumentException

Selects the row row in the view. If the row < 0, all columns and rows are deselected.

Parameters:

row - the index of the row in terms of the model

Throws:

IndexOutOfBoundsException - if sorting is enabled and passed an index outside the range of the JTable as determined by the method JTable.getRowCount()

IllegalArgumentException - if row lie outside [0, JTable.getRowCount()-1]

See Also:

JTable.convertRowIndexToView(int), JTable.addRowSelectionInterval(int, int), JTable.clearSelection()

setSelectedModelRows

void setSelectedModelRows(int[] rows)
                   throws IndexOutOfBoundsException,
                          IllegalArgumentException

Selects all rows with the indices specified in the list. If rows are null all columns and rows are deselected.

Parameters:

rows - an list of integers containing the row indices

Throws:

IndexOutOfBoundsException - if sorting is enabled and passed an index outside the range of the JTable as determined by the method JTable.getRowCount()

IllegalArgumentException - if row lie outside [0, JTable.getRowCount()-1]

See Also:

JTable.convertRowIndexToView(int), JTable.addRowSelectionInterval(int, int), JTable.clearSelection(), setSelectedModelRows(int[])

setSelectedModelRows

void setSelectedModelRows(int start,
                          int end)

Changes the selection to be between start and end inclusive. start doesn't have to be less than or equal to end.

In SINGLE_SELECTION selection mode, only the second index is used.

If this represents a change to the current selection, then each ListSelectionListener is notified of the change.

Parameters:

start - one end of the interval.

end - other end of the interval

setSelectedRows

void setSelectedRows(int[] indices)

Changes the selection to be the set of indices specified by the given array. Indices greater than or equal to the model size are ignored. This is a convenience method that clears the selection and then uses addSelectionInterval on the selection model to add the indices. Refer to the documentation of the selection model class being used for details on how values less than 0 are handled.

Parameters:

indices - an array of the indices of the rows to select, non-null

getRowAtPoint

int getRowAtPoint(int x,
                  int y)
           throws IndexOutOfBoundsException

Returns the view-index of the row that x- and y-coordinate lies in.

Parameters:

x - the x coordinate of the row

y - the y coordinate of the row

Returns:

the index of the corresponding row

Throws:

IndexOutOfBoundsException - if sorting is enabled and passed an index outside the range of the JTable as determined by the method JTable.getRowCount()

See Also:

getRowAtPoint(Point)

getRowAtPoint

int getRowAtPoint(Point location)
           throws IndexOutOfBoundsException

Returns the view-index of the row that Point lies in, or -1 if the result is not in the range [0, JTable.getRowCount()-1].

Parameters:

location - the Point of the row

Returns:

the index of the corresponding row

Throws:

IndexOutOfBoundsException - if sorting is enabled and passed an index outside the range of the JTable as determined by the method JTable.getRowCount()

See Also:

getRowAtPoint(int, int)

getColumnAtPoint

int getColumnAtPoint(int x,
                     int y)

Returns the index of the column that x- and y-coordinate lies in or -1 if the result is not in the range [0, JTable.getColumnCount() -1].

Parameters:

x - the x coordinate of the column

y - the y coordinate of the column

Returns:

the index of the column that x- and y-coordinate lies in or -1 if the result is not in the range [0, JTable.getColumnCount() -1]

See Also:

getColumnAtPoint(Point)

getColumnAtPoint

int getColumnAtPoint(Point location)

This method is a alias for JTable.columnAtPoint(Point).

Parameters:

location - of interest

Returns:

the index of the column that location lies in or -1 if the result is not in the range [0, JTable.getColumnCount() -1]

See Also:

getColumnAtPoint(int, int)

setColumnWidth

void setColumnWidth(int index,
                    int width)

Sets the columns preferredWidth and the columns width.

Parameters:

index - the index of the desired column

width - the value for the column width

See Also:

TableColumn.setPreferredWidth(int), TableColumn.setWidth(int)

setColumnTitle

void setColumnTitle(int index,
                    String title)

Sets the title of the desired column with the index.

Parameters:

index - the index of the desired column

title - the value for the column title

See Also:

TableColumn.setHeaderValue(Object)

ensureCellIsVisible

void ensureCellIsVisible(int rowIndex,
                         int columnIndex)

Scrolls to the desired cell. After the call the desired cell is visible in the viewport.

Note: Works only if the table is contained in a JScrollPane.

Parameters:

rowIndex - index of row to scroll to

columnIndex - index of the column to scroll to

ensureRowIsVisible

void ensureRowIsVisible(int rowIndex)

Scrolls to the desired row. After the call the desired row is visible in the viewport. The selected column will be preserved during the process.

Note: Works only if the table is contained in a JScrollPane.

Parameters:

rowIndex - index of row to scroll to

ensureColumnIsVisible

void ensureColumnIsVisible(int columnIndex)

Scrolls to the desired column. After the call the desired column is visible in the viewport. The selected row will be preserved during the process.

Note: Works only if the table is contained in a JScrollPane.

Parameters:

columnIndex - index of the column to scroll to