oracle.javatools.ui.builders

Interface BuiltTable<T>

All Known Subinterfaces:

BuiltBreadcrumbsTable<T>

public interface BuiltTable<T>

The definition of an object containing a JTable and surrounding support components like a JScrollPane and ReorderableBar. These components are placed on another component retrieved via getGUI() which can be added a component hierarchy
A BuiltTable is built by a TableBuilder.

Type T is the type of a row in the table

Method Summary

Modifier and Type	Method and Description
ComponentWithTitlebar	getComponentWithTitlebar() The component can be optionally contained in a ComponentWithTitlebar
TextLayer	getEmptyTextLayer()
javax.swing.JComponent	getGUI()
int[]	getHiddenColumns() Get columns that are hidden.
javax.swing.JScrollPane	getScrollPane()
java.util.List<java.awt.Point>	getSelectedCells()
int	getSelectedRow()
java.util.List<java.lang.Integer>	getSelectedRows()
T	getSelectedValue()
java.util.List<T>	getSelectedValues()
javax.swing.JTable	getTable() Returns the table contained in the table component.
int	indexOf(T rowObject) For tables containing SimpleTableModels (e.g.
void	setHiddenColumns(int... hiddenColumns) Set columns that are hidden.
void	setHiddenColumnsVisible(int[] columns) Set columns that were previously hidden visible again.

Method Detail

getTable

javax.swing.JTable getTable()

Returns the table contained in the table component. Do not add this directly to the ui, instead add the component returned by getGUI()

Returns:

the table

getSelectedRow

int getSelectedRow()

Returns:

the index of the selected row, or -1 if no row is selected

getSelectedRows

java.util.List<java.lang.Integer> getSelectedRows()

Returns:

a list of selected rows or an empty list if no rows are selected

getSelectedCells

java.util.List<java.awt.Point> getSelectedCells()

Returns:

a list of cells currently selected in the table, or an empty list if no cells are selected. The list is made up of x/y points corresponding to a row/column in the table

indexOf

int indexOf(T rowObject)

For tables containing SimpleTableModels (e.g. the default type provided the builder) the method will return the index of the object represented by the selected row. Row selection must be allowed, and column selection must be not allowed.

Returns:

the object representing the selected row

getHiddenColumns

int[] getHiddenColumns()

Get columns that are hidden. You should only call this after setting the model.

Returns:

an array of model column indices

setHiddenColumns

void setHiddenColumns(int... hiddenColumns)

Set columns that are hidden. You should only call this after setting the model.

Parameters:

hiddenColumns - columns which are currently hidden

setHiddenColumnsVisible

void setHiddenColumnsVisible(int[] columns)

Set columns that were previously hidden visible again. You should only call this after setting the model.

Parameters:

columns - An array of hidden columns to be made visible

getScrollPane

javax.swing.JScrollPane getScrollPane()

Returns:

the scrollpane used within the BuiltBasic. Do not add the scrollpane directly to a container, instead add the component returned by getGUI()

getGUI

javax.swing.JComponent getGUI()

Returns:

the main component containing all of the ui to add to a container.

getEmptyTextLayer

TextLayer getEmptyTextLayer()

Returns:

the TextLayer sued to display text when the component is empty

getComponentWithTitlebar

ComponentWithTitlebar getComponentWithTitlebar()

The component can be optionally contained in a ComponentWithTitlebar

Returns:

the ComponentWithTitlebar containing the component (or null)

getSelectedValue

T getSelectedValue()

Returns:

the selected item in the component. For multi select it returns the 'lead selection'.

getSelectedValues

java.util.List<T> getSelectedValues()

Returns:

a java.util.List of items selected in the component.