Package com.biglybt.ui.common.table
Interface TableView<DATASOURCETYPE>
- All Superinterfaces:
AEDiagnosticsEvidenceGenerator
- All Known Subinterfaces:
TableViewSWT<DATASOURCETYPE>
- All Known Implementing Classes:
TableViewImpl
,TableViewPainted
-
Method Summary
Modifier and TypeMethodDescriptionvoid
void
addDataSource
(DATASOURCETYPE dataSource) Adds a dataSource to the table as a new row.void
addDataSources
(DATASOURCETYPE[] dataSources) Add a list of dataSources to the table.void
void
void
addRefreshListener
(TableRefreshListener l, boolean trigger) void
addSelectionListener
(TableSelectionListener listener, boolean trigger) void
addSortColumn
(TableColumnCore column) Add a column to the sorting.void
addTableDataSourceChangedListener
(TableDataSourceChangedListener l, boolean trigger) The data set that this table represents has been changed.boolean
boolean
boolean
void
Send Selected rows to the clipboard in a SpreadSheet friendly format (tab/cr delimited)void
columnInvalidate
(TableColumnCore tableColumn) void
columnInvalidate
(String sColumnName) Invalidate all the cells in a columnvoid
columnInvalidate
(String sColumnName, boolean forceRefresh) boolean
dataSourceExists
(DATASOURCETYPE dataSource) void
delete()
getColumnCells
(String columnName) Retrieve a list ofgetDataSources
(boolean include_filtered) boolean
int
int
getRow
(int position) getRow
(int x, int y) getRow
(DATASOURCETYPE dataSource) Get the row associated with a datasourceint[]
int
int
getRows()
Get all the rows for this table, in the order they are displayedgetRowsAndSubRows
(boolean includeHidden) Returns an array of all selected Data Sources.Object[]
getSelectedDataSources
(boolean bCoreDataSource) Returns an array of all selected Data Sources.Returns an array of all selected TableRowSWT.int
int
getTableColumn
(String columnName) getTableColumn
(String columnName, boolean localized) Retrieves the row that has the cursor over itboolean
boolean
hasSortColumn
(TableColumn column) int
indexOf
(TableRowCore row) boolean
isColumnVisible
(TableColumn column) boolean
boolean
isRowVisible
(TableRowCore row) boolean
isSelected
(TableRow row) boolean
boolean
void
moveBack()
void
void
Process the queue of datasources to be added and removedvoid
void
refreshTable
(boolean bForceSort) void
Remove all the data sources (table rows) from the table.void
void
removeDataSource
(DATASOURCETYPE dataSource) void
removeDataSources
(DATASOURCETYPE[] dataSources) void
void
void
void
runForAllRows
(TableGroupRowRunner runner) For every row source, run the code provided by the specified parameter.void
For every row source, run the code provided by the specified parameter.void
void
scrollVertically
(int distance) void
Does not fire off selection eventsvoid
setEnabled
(boolean enable) void
setEnableTabViews
(boolean enableTabViews, boolean expandByDefault) void
setHeaderVisible
(boolean visible) void
setMaxItemShown
(int newIndex) void
setParentDataSource
(Object newDataSource) void
setRowDefaultHeight
(int iHeight) void
setRowDefaultHeightEM
(float lineHeight) void
setRowDefaultHeightPX
(int realPX) void
setSelectedRows
(TableRowCore[] rows) boolean
setSortColumns
(TableColumnCore[] newSortColumns, boolean allowOrderChange) void
showRow
(TableRowCore row) int
size
(boolean bIncludeQueue) void
sortRows
(boolean bForceDataRefresh, boolean async) Sort rows using the columns specified ingetSortColumns()
Methods inherited from interface com.biglybt.core.util.AEDiagnosticsEvidenceGenerator
generate
-
Method Details
-
addCountChangeListener
- Parameters:
listener
-
-
addDataSource
Adds a dataSource to the table as a new row. If the data source is already added, a new row will not be added. This function runs asynchronously, so the rows creation is not guaranteed directly after calling this function. You can't add datasources until the table is initialized- Parameters:
dataSource
- data source to add to the table
-
addDataSources
Add a list of dataSources to the table. The array passed in may be modified, so make sure you don't need it afterwards. You can't add datasources until the table is initialized- Parameters:
dataSources
-
-
addLifeCycleListener
-
addRefreshListener
-
addSelectionListener
- Parameters:
listener
-bFireSelection
-
-
addTableDataSourceChangedListener
The data set that this table represents has been changed. This is not for listening on changes to data sources changing within the table- Parameters:
l
-trigger
-
-
clipboardSelected
void clipboardSelected()Send Selected rows to the clipboard in a SpreadSheet friendly format (tab/cr delimited) -
columnInvalidate
Invalidate all the cells in a column- Parameters:
sColumnName
- Name of column to invalidate
-
columnInvalidate
-
columnInvalidate
- Parameters:
tableColumn
-
-
delete
void delete() -
getColumnCells
Retrieve a list ofTableCell
s, in the last sorted order. The order will not be of the supplied cell's sort unless the table has been sorted by that column previously.ie. You can sort on the 5th column, and retrieve the cells for the 3rd column, but they will be in order of the 5th columns sort.
- Parameters:
sColumnName
- Which column cell's to return. This does not sort the array on the column.- Returns:
- array of cells
-
getDataSources
HashSet<DATASOURCETYPE> getDataSources()- Returns:
- a new, unsorted Hashset of all datasources
-
getDataSources
- Returns:
- a new, unsorted Hashset of datasources
-
getFirstSelectedDataSource
Object getFirstSelectedDataSource() -
getTextPrefixID
String getTextPrefixID()- Returns:
- Prefix for i18n strings. Typically
getTableID()
+ "View"
-
getRow
Get the row associated with a datasource- Parameters:
dataSource
- a reference to a core Datasource object (not a plugin datasource object)- Returns:
- The row, or null
-
getRows
TableRowCore[] getRows()Get all the rows for this table, in the order they are displayed- Returns:
- a list of TableRowSWT objects in the order the user sees them
-
getRowsAndSubRows
-
getSelectedDataSources
Returns an array of all selected Data Sources. Null data sources are ommitted.- Returns:
- an array containing the selected data sources
-
getSelectedDataSources
Returns an array of all selected Data Sources. Null data sources are ommitted.- Parameters:
bCoreDataSource
-- Returns:
- an array containing the selected data sources
-
getSelectedRows
TableRowCore[] getSelectedRows()Returns an array of all selected TableRowSWT. Null data sources are ommitted.- Returns:
- an array containing the selected data sources
-
hasSortColumn
-
getSortColumnCount
int getSortColumnCount() -
getSortColumns
TableColumnCore[] getSortColumns() -
addSortColumn
Add a column to the sorting. If the column already is in the sort list, flip its order -
setSortColumns
-
sortRows
void sortRows(boolean bForceDataRefresh, boolean async) Sort rows using the columns specified ingetSortColumns()
-
isDisposed
boolean isDisposed()- Returns:
-
processDataSourceQueue
void processDataSourceQueue()Process the queue of datasources to be added and removed -
refreshTable
void refreshTable(boolean bForceSort) - Parameters:
bForceSort
-
-
removeAllTableRows
void removeAllTableRows()Remove all the data sources (table rows) from the table. -
removeDataSource
- Parameters:
dataSource
-
-
removeTableDataSourceChangedListener
- Parameters:
l
-
-
runForAllRows
For every row source, run the code provided by the specified parameter.- Parameters:
runner
- Code to run for each row/datasource
-
runForAllRows
For every row source, run the code provided by the specified parameter.- Parameters:
runner
- Code to run for each row/datasource
-
runForSelectedRows
- Parameters:
runner
-
-
selectAll
void selectAll()Does not fire off selection events -
setEnableTabViews
void setEnableTabViews(boolean enableTabViews, boolean expandByDefault) -
setParentDataSource
- Parameters:
newDataSource
-
-
getParentDataSource
Object getParentDataSource() -
setRowDefaultHeight
void setRowDefaultHeight(int iHeight) - Parameters:
iHeight
- Height will be adjusted for larger DPI
-
setRowDefaultHeightEM
void setRowDefaultHeightEM(float lineHeight) -
setRowDefaultHeightPX
void setRowDefaultHeightPX(int realPX) -
setSelectedRows
-
size
int size(boolean bIncludeQueue) - Parameters:
bIncludeQueue
-- Returns:
-
getFocusedRow
TableRowCore getFocusedRow()- Returns:
-
showRow
-
getTableID
String getTableID()- Returns:
-
getTableViewCreator
TableViewCreator getTableViewCreator() -
getRow
- Parameters:
x
-y
-- Returns:
-
dataSourceExists
- Parameters:
dataSource
-- Returns:
-
getVisibleColumns
TableColumnCore[] getVisibleColumns()- Returns:
-
getVisibleRows
TableRowCore[] getVisibleRows() -
removeDataSources
- Parameters:
dataSources
-
-
getSelectedRowsSize
int getSelectedRowsSize()- Returns:
- Since:
- 3.0.0.7
-
scrollVertically
void scrollVertically(int distance) -
indexOf
- Parameters:
row
-- Returns:
- Since:
- 3.0.0.7
-
isRowVisible
- Parameters:
row
-- Returns:
- Since:
- 3.0.4.3
-
getTableCellWithCursor
TableCellCore getTableCellWithCursor()- Returns:
- Since:
- 3.0.4.3
-
getTableRowWithCursor
TableRowCore getTableRowWithCursor()Retrieves the row that has the cursor over it- Returns:
- null if mouse isn't over a row
- Since:
- 3.0.4.3
-
getRowDefaultHeight
int getRowDefaultHeight()- Returns:
- Since:
- 3.0.4.3
-
getLineHeight
int getLineHeight() -
isColumnVisible
-
getRow
- Parameters:
position
-- Returns:
- Since:
- 3.0.4.3
-
getDataSourceType
Class getDataSourceType()- Returns:
- Since:
- 3.1.1.1
-
getTableColumn
- Parameters:
columnName
-- Returns:
- Since:
- 3.1.1.1
-
getTableColumn
-
setEnabled
void setEnabled(boolean enable) -
canHaveSubItems
boolean canHaveSubItems() -
isSelected
- Parameters:
tableRowImpl
-- Returns:
- Since:
- 4.4.0.5
-
isUnfilteredDataSourceAdded
-
setHeaderVisible
void setHeaderVisible(boolean visible) - Parameters:
visible
-- Since:
- 4.6.0.5
-
getHeaderVisible
boolean getHeaderVisible()- Returns:
- Since:
- 4.6.0.5
-
processDataSourceQueueSync
void processDataSourceQueueSync()- Since:
- 4.6.0.5
-
getMaxItemShown
int getMaxItemShown()- Since:
- 4.6.0.5
-
setMaxItemShown
void setMaxItemShown(int newIndex) - Parameters:
newIndex
-- Since:
- 4.6.0.5
-
getRowCount
int getRowCount() -
getRowAndSubRowCount
int[] getRowAndSubRowCount() -
resetLastSortedOn
void resetLastSortedOn() -
hasChangesPending
boolean hasChangesPending() -
getAllColumns
TableColumnCore[] getAllColumns() -
removeCountChangeListener
-
addExpansionChangeListener
-
removeExpansionChangeListener
-
isTableSelected
boolean isTableSelected() -
canMoveBack
boolean canMoveBack() -
moveBack
void moveBack() -
canMoveForward
boolean canMoveForward() -
moveForward
void moveForward()
-