TableSupport (XDEV Application Framework 6.0.0 API)

java.lang.Object
- xdev.ui.FormularComponentSupport<T>
- - xdev.ui.TableSupport<T>

Type Parameters:

T - type table
```
public class TableSupport<T extends JTable & MasterDetailComponent<T>>
extends FormularComponentSupport<T>
```
This class provides common functionality used by all table types of the XAPI.

Author:

XDEV Software Corp.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`autoLock`
`protected long`	`autoRenewLockTime`
`protected List<JComponent>`	`countdownMonitorComponentList`
`protected MasterDetailComponent.DetailHandler`	`detailHandler`
`protected boolean`	`lazyLoadingEnabled`
`protected LazyLoadingTableModel<T>`	`lazyLoadingTableModel`
`protected long`	`lockingTime`
`protected XdevWindow`	`lockInUseDialog`
`protected String`	`modelColumns`
`protected JComponent`	`monitorCountdown`
`protected boolean`	`pagingEnabled`
`protected long`	`renewDialogTime`
`protected int[]`	`savedValue`
`protected boolean`	`showDialog`

Fields inherited from class xdev.ui.FormularComponentSupport
component, dataField, filterOperator, readOnly, validators

Constructor Summary

Constructors
Modifier Constructor and Description

protected TableSupport(T table)

Constructors
Modifier	Constructor and Description
`protected`	`TableSupport(T table)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addValueChangeListener(FormularComponent.ValueChangeListener l)`
`void`	`adjustColumnWidths()` Sets the column width of each column to its preferred size.
`void`	`clearModel()`
`RowSorter`	`createRowSorter(TableModel model)`
`static SELECT`	`createSelect(VirtualTable vt, boolean selectiveQuery, String... columns)`
`VirtualTable`	`createSubsettedVirtualTable()` Creates a Virtual Table from the currently displayed values of this supported table.
`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.
`protected String`	`exportCSV_getColumnName(TableColumn column)`
`protected String`	`exportCSV_getValue(Object value, int row, int col)`
`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)`.
`Object`	`getFormularValue()`
`protected KeyValues`	`getKeyValues(VirtualTable formularVT, VirtualTable tableVT, Map<String,Object> values)`
`protected LazyLoadingTableModel<T>`	`getLazyLoadingTableModel()`
`TablePageControl<T>`	`getPageControl()`
`int`	`getRowAtPoint(int x, int y)` Returns the index of the row that x- and y-coordinate lies in.
`int`	`getRowAtPoint(Point location)`
`RowSelectionHandler`	`getRowSelectionHandler()`
`int`	`getSelectedModelRow()`
`int[]`	`getSelectedModelRows()`
`VirtualTable.VirtualTableRow`	`getSelectedVirtualTableRow()`
`VirtualTable.VirtualTableRow[]`	`getSelectedVirtualTableRows()`
`static TableColumnConverter`	`getTableColumnConverter()` Returns the set `TableColumnConverter` to differ model data from view data.
`static TableModelWrapperLookup`	`getTableModelWrapperLookup()`
`static TableRowConverter`	`getTableRowConverter()` Returns the set `TableRowConverter` to differ model data from view data.
`VirtualTable`	`getVirtualTable()`
`VirtualTableWrapper`	`getVirtualTableWrapper()` Returns the underlying model which is a `VirtualTableWrapper`, or `null`.
`protected List<String>`	`getVisibleColumnNames()`
`boolean`	`hasStateChanged()`
`boolean`	`isLazyLoadingEnabled()`
`boolean`	`isMultiSelect()`
`boolean`	`isPagingEnabled()`
`boolean`	`isSomethingSelected()` Return `true` if something is selected, otherwise `false`.
`void`	`refresh()`
`void`	`restoreState()`
`void`	`saveState()`
`protected void`	`selectFormularValue(VirtualTable formularVT, VirtualTable tableVT, Map<String,Object> values)`
`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`	`setDetailHandler(MasterDetailComponent.DetailHandler detailHandler)`
`void`	`setFormularValue(VirtualTable vt, Map<String,Object> record)`
`void`	`setLazyLoadingEnabled(boolean lazyLoadingEnabled)`
`void`	`setModel(VirtualTable vt)` Sets the model for the supported table based on a `VirtualTable`.
`void`	`setModel(VirtualTable vt, String columns, boolean queryData)` Sets the model for the supported table based on a `VirtualTable` and additional configuration.
`void`	`setModel(VirtualTable vt, String columns, boolean queryData, boolean selectiveQuery)` Sets the model for the supported table based on a `VirtualTable` and additional configuration.
`void`	`setModel(VirtualTable vt, String columns, SELECT select, Object... params)` Sets the model for the supported table based on a `VirtualTable` and additional configuration.
`void`	`setPagingEnabled(boolean pagingEnabled)`
`void`	`setRowSelectionHandler(RowSelectionHandler rowSelectionHandler)`
`void`	`setSelectedModelRow(int row)`
`void`	`setSelectedModelRows(int[] rows)`
`void`	`setSelectedModelRows(int start, int end)`
`void`	`setSelectedRows(int[] indices)`
`void`	`setSelectedVirtualTableRow(VirtualTable.VirtualTableRow row)`
`void`	`setSelectedVirtualTableRows(VirtualTable.VirtualTableRow[] rows)`
`static void`	`setTableColumnConverter(TableColumnConverter tableColumnConverter)` Sets a `TableRowConverter` to differ model data from view data.
`static void`	`setTableModelWrapperLookup(TableModelWrapperLookup tableModelWrapperLookup)`
`static void`	`setTableRowConverter(TableRowConverter tableRowConverter)` Sets a `TableRowConverter` to differ model data from view data.
`void`	`setValue(VirtualTable vt, Map<String,Object> value)`
`void`	`updateModel(Condition condition, Object... params)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - savedValue
```
protected int[] savedValue
```
  - detailHandler
```
protected MasterDetailComponent.DetailHandler detailHandler
```
  - modelColumns
```
protected String modelColumns
```
  - pagingEnabled
```
protected boolean pagingEnabled
```
  - lazyLoadingEnabled
```
protected boolean lazyLoadingEnabled
```
  - lazyLoadingTableModel
```
protected LazyLoadingTableModel<T extends JTable & MasterDetailComponent<T>> lazyLoadingTableModel
```
  - autoLock
```
protected boolean autoLock
```
  - lockInUseDialog
```
protected XdevWindow lockInUseDialog
```
  - autoRenewLockTime
```
protected long autoRenewLockTime
```
  - renewDialogTime
```
protected long renewDialogTime
```
  - lockingTime
```
protected long lockingTime
```
  - showDialog
```
protected boolean showDialog
```
  - monitorCountdown
```
protected JComponent monitorCountdown
```
  - countdownMonitorComponentList
```
protected List<JComponent> countdownMonitorComponentList
```
- Constructor Detail
  - TableSupport
```
protected TableSupport(T table)
```
- Method Detail
  - setRowSelectionHandler
```
public void setRowSelectionHandler(RowSelectionHandler rowSelectionHandler)
```
  - getRowSelectionHandler
```
public RowSelectionHandler getRowSelectionHandler()
```
  - setTableRowConverter
```
public static void setTableRowConverter(TableRowConverter tableRowConverter)
```
    Sets a TableRowConverter to differ model data from view data.
    
    Since:
    
    3.1
  - getTableRowConverter
```
public static TableRowConverter getTableRowConverter()
```
    Returns the set TableRowConverter to differ model data from view data. Or if no TableRowConverter was set it returns TableRowConverter default implementation. * @return the set TableRowConverter or its default implementation.
    
    Since:
    
    3.1
  - setTableColumnConverter
```
public static void setTableColumnConverter(TableColumnConverter tableColumnConverter)
```
    Sets a TableRowConverter to differ model data from view data.
    
    Since:
    
    3.2
  - getTableColumnConverter
```
public static TableColumnConverter getTableColumnConverter()
```
    Returns the set TableColumnConverter to differ model data from view data. Or if no TableColumnConverter was set it returns TableColumnConverter default implementation.
    
    Returns:
    
    the set TableColumnConverter or its default implementation.
    
    Since:
    
    3.2
  - setTableModelWrapperLookup
```
public static void setTableModelWrapperLookup(TableModelWrapperLookup tableModelWrapperLookup)
```
    Since:
    
    3.1
  - getTableModelWrapperLookup
```
public static TableModelWrapperLookup getTableModelWrapperLookup()
```
    Since:
    
    3.1
  - setModel
```
public void setModel(VirtualTable vt)
```
    Sets the model for the supported table based on a VirtualTable.
    
    Parameters:
    
    vt - a VirtualTable.
  - setModel
```
public void setModel(VirtualTable vt,
                     String columns,
                     boolean queryData)
```
    Sets the model for the supported table based on a VirtualTable and additional configuration.
    
    Parameters:
    
    vt - a VirtualTable.
    
    columns - a comma separated list of column names.
    
    queryData - if set to true the vt will be queried with the default select for the vt.
  - setModel
```
public void setModel(VirtualTable vt,
                     String columns,
                     boolean queryData,
                     boolean selectiveQuery)
```
    Sets the model for the supported table based on a VirtualTable and additional configuration.
    
    Parameters:
    
    vt - a VirtualTable.
    
    columns - a comma separated list of column names.
    
    queryData - if set to true the vt will be queried with the default select for the vt.
    
    selectiveQuery - if true, only the display columns are queried
    
    Since:
    
    5.0
  - createSelect
```
public static SELECT createSelect(VirtualTable vt,
                                  boolean selectiveQuery,
                                  String... columns)
```
    Since:
    
    5.0
  - setModel
```
public void setModel(VirtualTable vt,
                     String columns,
                     SELECT select,
                     Object... params)
```
    Sets the model for the supported table based on a VirtualTable and additional configuration.
    
    Parameters:
    
    vt - a VirtualTable.
    
    columns - a comma separated list of column names.
    
    select - a custom SELECT used to query the VirtualTable .
    
    params - a number of parameters for the custom select
  - setPagingEnabled
```
public void setPagingEnabled(boolean pagingEnabled)
```
    Since:
    
    4.0
  - isPagingEnabled
```
public boolean isPagingEnabled()
```
    Since:
    
    4.0
  - getPageControl
```
public TablePageControl<T> getPageControl()
```
    Since:
    
    4.0
  - setLazyLoadingEnabled
```
public void setLazyLoadingEnabled(boolean lazyLoadingEnabled)
```
    Since:
    
    4.0
  - isLazyLoadingEnabled
```
public boolean isLazyLoadingEnabled()
```
    Since:
    
    4.0
  - getLazyLoadingTableModel
```
protected LazyLoadingTableModel<T> getLazyLoadingTableModel()
```
  - createRowSorter
```
public RowSorter createRowSorter(TableModel model)
```
    Since:
    
    4.0
  - adjustColumnWidths
```
public void adjustColumnWidths()
```
    Sets the column width of each column to its preferred size.
  - getVirtualTable
```
public VirtualTable getVirtualTable()
```
    See Also:
    
    VirtualTableOwner.getVirtualTable()
  - getVirtualTableWrapper
```
public final VirtualTableWrapper getVirtualTableWrapper()
```
    Returns the underlying model which is a VirtualTableWrapper, or null.
    
    Returns:
    
    the VirtualTableWrapper model
  - getRowAtPoint
```
public int getRowAtPoint(Point location)
                  throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException
    
    See Also:
    
    ExtendedTable.getRowAtPoint(Point)
  - getSelectedModelRow
```
public final int getSelectedModelRow()
                              throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException
    
    See Also:
    
    ExtendedTable.getSelectedModelRow()
  - getSelectedModelRows
```
public final int[] getSelectedModelRows()
                                 throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException
    
    See Also:
    
    ExtendedTable.getSelectedModelRows()
  - setSelectedRows
```
public void setSelectedRows(int[] indices)
```
    See Also:
    
    ExtendedTable.setSelectedRows(int[])
  - setSelectedModelRow
```
public final void setSelectedModelRow(int row)
                               throws IndexOutOfBoundsException,
                                      IllegalArgumentException
```
    Throws:
    
    IndexOutOfBoundsException
    
    IllegalArgumentException
    
    See Also:
    
    ExtendedTable.setSelectedModelRow(int)
  - setSelectedModelRows
```
public final void setSelectedModelRows(int[] rows)
                                throws IndexOutOfBoundsException,
                                       IllegalArgumentException
```
    Throws:
    
    IndexOutOfBoundsException
    
    IllegalArgumentException
    
    See Also:
    
    ExtendedTable.setSelectedModelRows(int[])
  - setSelectedModelRows
```
public final void setSelectedModelRows(int start,
                                       int end)
```
    See Also:
    
    ExtendedTable.setSelectedModelRows(int, int)
  - isMultiSelect
```
public boolean isMultiSelect()
```
    See Also:
    
    FormularComponent.isMultiSelect()
  - setFormularValue
```
public void setFormularValue(VirtualTable vt,
                             Map<String,Object> record)
```
    See Also:
    
    FormularComponent.setFormularValue(VirtualTable, Map)
  - setValue
```
public void setValue(VirtualTable vt,
                     Map<String,Object> value)
```
  - selectFormularValue
```
protected void selectFormularValue(VirtualTable formularVT,
                                   VirtualTable tableVT,
                                   Map<String,Object> values)
```
  - getKeyValues
```
protected KeyValues getKeyValues(VirtualTable formularVT,
                                 VirtualTable tableVT,
                                 Map<String,Object> values)
                          throws MasterDetailException,
                                 VirtualTableException
```
    Throws:
    
    MasterDetailException
    
    VirtualTableException
  - getFormularValue
```
public Object getFormularValue()
```
    See Also:
    
    FormularComponent.getFormularValue()
  - saveState
```
public void saveState()
```
    See Also:
    
    FormularComponent.saveState()
  - restoreState
```
public void restoreState()
```
    See Also:
    
    FormularComponent.restoreState()
  - hasStateChanged
```
public boolean hasStateChanged()
```
    Since:
    
    3.1
    
    See Also:
    
    FormularComponent.hasStateChanged()
  - getSelectedVirtualTableRow
```
public VirtualTable.VirtualTableRow getSelectedVirtualTableRow()
```
    See Also:
    
    ExtendedTable.getSelectedVirtualTableRow()
  - setSelectedVirtualTableRow
```
public void setSelectedVirtualTableRow(VirtualTable.VirtualTableRow row)
```
    Since:
    
    3.2
    
    See Also:
    
    ExtendedTable#setSelectedVirtualTableRow(VirtualTableRow)
  - getSelectedVirtualTableRows
```
public VirtualTable.VirtualTableRow[] getSelectedVirtualTableRows()
```
    See Also:
    
    ExtendedTable.getSelectedVirtualTableRows()
  - setSelectedVirtualTableRows
```
public void setSelectedVirtualTableRows(VirtualTable.VirtualTableRow[] rows)
```
    Since:
    
    3.2
    
    See Also:
    
    ExtendedTable#setSelectedVirtualTableRows(VirtualTableRow[])
  - refresh
```
public void refresh()
```
    See Also:
    
    MasterDetailComponent.refresh()
  - updateModel
```
public void updateModel(Condition condition,
                        Object... params)
```
    See Also:
    
    VirtualTableOwner.updateModel(Condition, Object...)
  - clearModel
```
public void clearModel()
```
    See Also:
    
    MasterDetailComponent.clearModel()
  - addValueChangeListener
```
public void addValueChangeListener(FormularComponent.ValueChangeListener l)
```
    See Also:
    
    FormularComponent.addValueChangeListener(ValueChangeListener)
  - setDetailHandler
```
public void setDetailHandler(MasterDetailComponent.DetailHandler detailHandler)
```
    See Also:
    
    MasterDetailComponent.setDetailHandler(DetailHandler)
  - exportCSV
```
public 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
```
public 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
```
public 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
  - exportCSV_getColumnName
```
protected String exportCSV_getColumnName(TableColumn column)
```
  - exportCSV_getValue
```
protected String exportCSV_getValue(Object value,
                                    int row,
                                    int col)
```
  - isSomethingSelected
```
public boolean isSomethingSelected()
```
    Return true if something is selected, otherwise false.
    
    Returns:
    
    true if something is selected, otherwise false
  - setColumnWidth
```
public 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
```
public 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)
  - getRowAtPoint
```
public int getRowAtPoint(int x,
                         int y)
                  throws IndexOutOfBoundsException
```
    Returns the index of the row that x- and y-coordinate lies in. Maps the index of the row in terms of the view to the underlying TableModel.
    
    Parameters:
    
    x - the x coordinate of the row
    
    y - the y coordinate of the row
    
    Returns:
    
    the index of the corresponding row in 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()
    
    See Also:
    
    getRowAtPoint(Point), JTable.convertRowIndexToModel(int)
  - getColumnAtPoint
```
public 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
```
public 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)
  - ensureCellIsVisible
```
public 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
```
public 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
```
public 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
  - createSubsettedVirtualTable
```
public VirtualTable createSubsettedVirtualTable()
```
    Creates a Virtual Table from the currently displayed values of this supported table.
    The generated Virtual Table has the same order of columns and rows as currently displayed in the view.
    
    The supported table must have a referenced VirtualTable VirtualTableModel for this method to work)
    
    Returns:
    
    a VirtualTable representing the currently displayed results of the table
    
    Throws:
    
    IllegalStateException - if the supported table is not based on a VirtualTableModel or if a new VirtualTable could not be created.
  - getVisibleColumnNames
```
protected List<String> getVisibleColumnNames()
```
    Returns:
    
    a List of all currently visible column names ordered from left to right

Class TableSupport<T extends JTable & MasterDetailComponent<T>>

Field Summary

Fields inherited from class xdev.ui.FormularComponentSupport

Constructor Summary

Method Summary

Methods inherited from class xdev.ui.FormularComponentSupport

Methods inherited from class java.lang.Object

Field Detail

savedValue

detailHandler

modelColumns

pagingEnabled

lazyLoadingEnabled

lazyLoadingTableModel

autoLock

lockInUseDialog

autoRenewLockTime

renewDialogTime

lockingTime

showDialog

monitorCountdown

countdownMonitorComponentList

Constructor Detail

TableSupport

Method Detail

setRowSelectionHandler

getRowSelectionHandler

setTableRowConverter

getTableRowConverter

setTableColumnConverter

getTableColumnConverter

setTableModelWrapperLookup

getTableModelWrapperLookup

setModel

setModel

setModel

createSelect

setModel

setPagingEnabled

isPagingEnabled

getPageControl

setLazyLoadingEnabled

isLazyLoadingEnabled

getLazyLoadingTableModel

createRowSorter

adjustColumnWidths

getVirtualTable

getVirtualTableWrapper

getRowAtPoint

getSelectedModelRow

getSelectedModelRows

setSelectedRows

setSelectedModelRow

setSelectedModelRows

setSelectedModelRows

isMultiSelect

setFormularValue

setValue

selectFormularValue

getKeyValues

getFormularValue

saveState

restoreState

hasStateChanged

getSelectedVirtualTableRow

setSelectedVirtualTableRow

getSelectedVirtualTableRows

setSelectedVirtualTableRows

refresh

updateModel

clearModel

addValueChangeListener

setDetailHandler

exportCSV

exportCSV

exportCSV

exportCSV_getColumnName

exportCSV_getValue

isSomethingSelected

setColumnWidth