AdvancePageTableModel

Overview

Package

Class

Tree

Deprecated

Index

Help

JIDE 3.5.15

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.jidesoft.grid
Class AdvancePageTableModel

java.lang.Object
  javax.swing.table.AbstractTableModel
      com.jidesoft.grid.AbstractPageTableModel
          com.jidesoft.grid.AdvancePageTableModel

All Implemented Interfaces:: AutoFilterTableHeaderAdapter, AutoFilterTableModel, ContextSensitiveTableModel, IFilterableTableModel, ISortableTableModel, MultiTableModel, PageNavigationSupport, Serializable, EventListener, TableModelListener, TableModel

Direct Known Subclasses:: HibernatePageTableModel

public abstract class AdvancePageTableModel
extends AbstractPageTableModel
implements ISortableTableModel, IFilterableTableModel
extends AbstractPageTableModel
implements ISortableTableModel, IFilterableTableModel

AdvancedPageTableModel extends AbstractPageTableModel and provides more advanced features such as sorting and filtering. However it doesn't implement it by leaving it to the subclass. For example, if you are using Hibernate, you can ask Hibernate to do the filtering or sorting for you. Or if you have a business logic layer in your application, you can handle it in the business logic layer. All other logic is implemented in this class and you only need to implement refreshData(SortItemSupport, FilterItemSupport, int, int) method to provide the content for the current page.

See Also:: Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.jidesoft.grid.ISortableTableModel
`ISortableTableModel.SortItem`

Nested classes/interfaces inherited from interface com.jidesoft.grid.IFilterableTableModel
`IFilterableTableModel.FilterItem`

Nested classes/interfaces inherited from interface com.jidesoft.grid.AutoFilterTableHeaderAdapter
`AutoFilterTableHeaderAdapter.FilterTitleFormatter`

Field Summary
`protected FilterItemSupport`	`_filterItemSupport`
`protected SortItemSupport`	`_sortItemSupport`

Fields inherited from class javax.swing.table.AbstractTableModel
`listenerList`

Fields inherited from interface com.jidesoft.grid.ISortableTableModel
`SORT_PRIORITY_FIFO, SORT_PRIORITY_FILO`

Fields inherited from interface com.jidesoft.grid.IFilterableTableModel
`ALL_COLUMNS, ANY_COLUMNS, IDENTIFIER_ALL_COLUMNS, IDENTIFIER_ANY_COLUMNS`

Fields inherited from interface com.jidesoft.grid.MultiTableModel
`FOOTER_COLUMN, HEADER_COLUMN, REGULAR_COLUMN`

Constructor Summary
	`AdvancePageTableModel()`
`protected`	`AdvancePageTableModel(int pageSize)`

Method Summary
`void`	`addFilter(Filter filter)` Adds a filter to all columns.
`void`	`addFilter(IFilterableTableModel.FilterItem filterItem)` Adds a FilterItem.
`void`	`addFilter(int column, Filter filter)` Adds a filter to the specified column.
`void`	`addFilterableTableModelListener(FilterableTableModelListener l)` Adds a listener to the list that's notified each time a change to the filter occurs.
`void`	`addSortListener(SortListener l)` Adds the specified listener to receive SortEvents pane events from this SortableTableModel.
`void`	`clearFilters()` Removes all filters from all columns.
`void`	`fireFilterAdded(int column, Filter filter)`
`void`	`fireFilterChanged(FilterableTableModelEvent e)` Forwards the given notification event to all `FilterableTableModelListeners` that registered themselves as listeners for this table model.
`void`	`fireFilterRemoved(int column, Filter filter)`
`void`	`fireSortEvent()` Fires sort event.
`void`	`fireSortingEvent()` Fires sort event.
`int`	`getActualRowAt(int row)` Gets the actual row.
`Class<?>`	`getColumnClass(int columnIndex)`
`int`	`getColumnCount()`
`String`	`getColumnName(int column)`
`int`	`getColumnSortRank(int column)` In the case of sort by multiple columns, this method will return the rank of this column within all sorted columns.
`TableModel`	`getCurrentPageModel()`
`DynamicTableFilter[]`	`getDynamicTableFilters(int modelIndex)` Gets all the `DynamicTableFilter`s.
`FilterableTableModelListener[]`	`getFilterableTableModelListeners()` Returns an array of all the FilterableTableModel listeners registered on this filter.
`Icon`	`getFilterIcon(int column)` Gets the filter icon for a particular column.
`List<IFilterableTableModel.FilterItem>`	`getFilterItems()` Gets all the FilterItems added to this FilterableTableModel.
`Filter[]`	`getFilters(int column)` Gets the filters for the specified column.
`AutoFilterTableHeaderAdapter.FilterTitleFormatter`	`getFilterTitleFormatter(int column)` Gets the formatter that will format the title for the AutoFilterTableHeader.
`ListCellRenderer`	`getListCellRenderer(int column)` Gets the list cell renderer for the drop down filter list.
`int[]`	`getMasterSortColumns()` Gets the master sort columns.
`int`	`getMaximumSortColumns()` Gets the maximum columns can be sorted at once.
`Object[]`	`getPossibleValues(int columnIndex, Comparator comparator)` Gets all possible values of the table model.
`Object[]`	`getPossibleValuesAndConverters(int columnIndex, Comparator comparator)`
`int`	`getSortedRowAt(int actualRow)` Gets the visual row.
`List<ISortableTableModel.SortItem>`	`getSortingColumns()` Gets the sorting columns.
`SortListener[]`	`getSortListeners()` Returns an array of all the `SortListener`s added to this `SortableTableModel` with `addSortListener`.
`int`	`getSortPriority()` Gets the sort priority.
`StringConverter`	`getTitleConverter(int column)` Gets the title converter to convert the column name.
`int`	`getTotalRecordCount()` Gets the total record/row count.
`Object`	`getValueAt(int rowIndex, int columnIndex)`
`boolean`	`hasFilter()` Checks if the `FilterableTableModel` has any filters.
`boolean`	`hasFilter(int columnIndex)` Checks if the `FilterableTableModel` has any filters on the specified column.
`boolean`	`isAdjusting()` Checks if the FilterableTableModel is adjusting.
`boolean`	`isAllowCustomFilter(int column)` Checks if the `AutoFilterTableHeader` allows custom filter.
`boolean`	`isAllowMultipleValues(int column)` Checks if the `AutoFilterTableHeader` allows multiple values as the filter for the column index.
`boolean`	`isAndMode()` Sets the logic of filters on the same column.
`boolean`	`isCellEditable(int rowIndex, int columnIndex)`
`boolean`	`isColumnAscending(int column)` Checks if the column is sorted ascendingly.
`boolean`	`isColumnAutoFilterable(int column)` Checks if the column is auto-filterable.
`boolean`	`isColumnFilterable(int column)` Checks if the column is filterable for the filters that are added to `IFilterableTableModel.ALL_COLUMNS`.
`boolean`	`isColumnSortable(int column)` Check if a certain column is sortable.
`boolean`	`isColumnSorted(int column)` Checks if the column is sorted.
`boolean`	`isColumnVisible(int column)` Checks if the column is visible.
`boolean`	`isFilteringPaused()` Checks if the filtering is paused.
`boolean`	`isFiltersApplied()` Checks if the filters are in effect.
`boolean`	`isMultiColumnSortable()` Does this table allow sort by multiple columns.
`boolean`	`isSameConverterAt(int columnIndex)` Check if each converter in this column for each row is the same.
`boolean`	`isSortable()` Checks if the sortable table model is sortable.
`boolean`	`isUseTableCellRenderer(int column)` Checks if the table cell renderer will be used for the list.
`boolean`	`isValuePredetermined(int column)` Checks if the column is type-filterable.
`protected void`	`pageCountChanged(int oldPageCount, int newPageCount)`
`protected void`	`pageIndexChanged(int oldPageIndex, int newPageIndex)`
`void`	`refresh()` Reapply all filters after they are changed.
`abstract void`	`refreshData(SortItemSupport sortItemSupport, FilterItemSupport filterItemSupport, int currentPage, int pageSize)` Submits the query.
`void`	`removeAllFilters()` Removes all filters that are added using `IFilterableTableModel.addFilter(Filter)`.
`void`	`removeAllFilters(int column)` Removes all filters from the specified column.
`void`	`removeFilter(Filter filter)` Removes the filter from all columns.
`void`	`removeFilter(IFilterableTableModel.FilterItem filterItem)` Removes the filter item.
`void`	`removeFilter(int column, Filter filter)` Removes the filter from the specified column.
`void`	`removeFilterableTableModelListener(FilterableTableModelListener l)` Removes a listener from the list that's notified each time a change to the filter occurs.
`void`	`removeSortListener(SortListener l)` Removes the specified SortListener so that it no longer receives SortEvents from this SortableTableModel .
`void`	`reset()` Resets.
`void`	`resort()` Resort the table.
`void`	`reverseColumnSortOrder(int column)` Reverses the sort order of the column.
`void`	`setAdjusting(boolean adjusting)` Sets the FilterableTableModel to adjusting mode.
`void`	`setAndMode(boolean andMode)` Sets the logic among the filters.
`void`	`setColumnSortable(int column, boolean sortable)` Sets a column sortable or not sortable.
`void`	`setCurrentPageModel(TableModel model)`
`void`	`setFilteringPaused(boolean pause)` If filtering is paused, keep rows in same relative positions Inserts/Deletes shift rows without re-ordering
`void`	`setFiltersApplied(boolean apply)` Applies or unapplies the filters.
`void`	`setMasterSortColumns(int[] masterSortColumns)` Sets the master sort column.
`void`	`setMaximumSortColumns(int maximumSortColumns)` Set the maximum number of columns that can be sorted at once.
`void`	`setMultiColumnSortable(boolean multiColumnSortable)` Set the value if this table allows sort by multiple columns.
`void`	`setSortable(boolean sortable)` Sets the table model sortable.
`void`	`setSortingColumns(List<ISortableTableModel.SortItem> list)` Sets the soring columns.
`void`	`setSortPriority(int sortPriority)` Sets the sort priority.
`void`	`setTotalRecordCount(int totalRecordCount)` Sets the total record/row count.
`void`	`setValueAt(Object aValue, int rowIndex, int columnIndex)`
`protected void`	`sort()`
`void`	`sortColumn(int column)` Sort the column, equals to sortColumn(column, false).
`void`	`sortColumn(int column, boolean reset)` If reset is true, it will remove all existing sort-by columns and only sorts by `column`.
`void`	`sortColumn(int column, boolean reset, boolean ascending)` Sorts a column.
`void`	`toggleSortOrder(int column, boolean extend)` Toggles the sort order on the specified column.
`void`	`unsortColumn(int column)` Unsorts the column.

Methods inherited from class com.jidesoft.grid.AbstractPageTableModel
addPageNavigationListener, createCompoundTableModelEvent, firePageNavigationEvent, fireTableCellsUpdated, fireTableChanged, firstPage, getCellClassAt, getColumnType, getConverterContextAt, getCurrentPage, getEditorContextAt, getPageCount, getPageNavigationListeners, getPageSize, getRowCount, getTableIndex, lastPage, nextPage, pageSizeChanged, previousPage, removePageNavigationListener, setCurrentPage, setPageCount, setPageSize, tableCellsUpdated, tableChanged, tableDataChanged, tableRowsDeleted, tableRowsInserted, tableRowsUpdated, tableStructureChanged

Methods inherited from class com.jidesoft.grid.AbstractPageTableModel

addPageNavigationListener, createCompoundTableModelEvent, firePageNavigationEvent, fireTableCellsUpdated, fireTableChanged, firstPage, getCellClassAt, getColumnType, getConverterContextAt, getCurrentPage, getEditorContextAt, getPageCount, getPageNavigationListeners, getPageSize, getRowCount, getTableIndex, lastPage, nextPage, pageSizeChanged, previousPage, removePageNavigationListener, setCurrentPage, setPageCount, setPageSize, tableCellsUpdated, tableChanged, tableDataChanged, tableRowsDeleted, tableRowsInserted, tableRowsUpdated, tableStructureChanged

Methods inherited from class javax.swing.table.AbstractTableModel
`addTableModelListener, findColumn, fireTableCellUpdated, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getListeners, getTableModelListeners, removeTableModelListener`

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

Methods inherited from interface javax.swing.table.TableModel
`addTableModelListener, getRowCount, removeTableModelListener`

Field Detail

_sortItemSupport

protected SortItemSupport _sortItemSupport

_filterItemSupport

protected FilterItemSupport _filterItemSupport

Constructor Detail

AdvancePageTableModel

public AdvancePageTableModel()

AdvancePageTableModel

protected AdvancePageTableModel(int pageSize)

Method Detail

pageCountChanged

protected void pageCountChanged(int oldPageCount,
                                int newPageCount)

Specified by:: pageCountChanged in class AbstractPageTableModel

pageIndexChanged

protected void pageIndexChanged(int oldPageIndex,
                                int newPageIndex)

Specified by:: pageIndexChanged in class AbstractPageTableModel

setTotalRecordCount

public void setTotalRecordCount(int totalRecordCount)

Description copied from interface: PageNavigationSupport

Sets the total record/row count.

Specified by:: setTotalRecordCount in interface PageNavigationSupport

Parameters:: totalRecordCount - the new total row count.

getTotalRecordCount

public int getTotalRecordCount()

Description copied from interface: PageNavigationSupport

Gets the total record/row count.

Specified by:: getTotalRecordCount in interface PageNavigationSupport

Returns:: the total record/row count.

getColumnCount

public int getColumnCount()

Specified by:: getColumnCount in interface TableModel

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

Specified by:: getValueAt in interface TableModel

isCellEditable

public boolean isCellEditable(int rowIndex,
                              int columnIndex)

Specified by:: isCellEditable in interface TableModel
Overrides:: isCellEditable in class AbstractTableModel

setValueAt

public void setValueAt(Object aValue,
                       int rowIndex,
                       int columnIndex)

Specified by:: setValueAt in interface TableModel
Overrides:: setValueAt in class AbstractTableModel

getColumnClass

public Class<?> getColumnClass(int columnIndex)

Specified by:: getColumnClass in interface TableModel
Overrides:: getColumnClass in class AbstractTableModel

getColumnName

public String getColumnName(int column)

Specified by:: getColumnName in interface TableModel
Overrides:: getColumnName in class AbstractTableModel