JIDE 3.5.15

com.jidesoft.grid
Interface AutoFilterTableHeaderAdapter

All Known Subinterfaces:
AutoFilterTableModel, IFilterableTableModel
All Known Implementing Classes:
AdvancePageTableModel, CrudDatabaseTableModel, DatabaseTableModel, FilterableAggregateTableModel, FilterableTableModel, FilterableTreeTableModel, HibernatePageTableModel, LuceneFilterableTableModel

Deprecated. replaced by AutoFilterTableModel.

@Deprecated
public interface AutoFilterTableHeaderAdapter


Nested Class Summary
static interface AutoFilterTableHeaderAdapter.FilterTitleFormatter
          Deprecated. An interface which is used to format the filter title.
 
Method Summary
 DynamicTableFilter[] getDynamicTableFilters(int column)
          Deprecated. Gets all the DynamicTableFilters.
 AutoFilterTableHeaderAdapter.FilterTitleFormatter getFilterTitleFormatter(int column)
          Deprecated. Gets the formatter that will format the title for the AutoFilterTableHeader.
 ListCellRenderer getListCellRenderer(int column)
          Deprecated. Gets the list cell renderer for the drop down filter list.
 StringConverter getTitleConverter(int column)
          Deprecated. Gets the title converter to convert the column name.
 boolean isAllowCustomFilter(int column)
          Deprecated. Checks if the AutoFilterTableHeader allows custom filter.
 boolean isAllowMultipleValues(int column)
          Deprecated. Checks if the AutoFilterTableHeader allows multiple values as the filter for the column index.
 boolean isColumnAutoFilterable(int column)
          Deprecated. Checks if the column is auto-filterable.
 boolean isUseTableCellRenderer(int column)
          Deprecated. Checks if the table cell renderer will be used for the list.
 boolean isValuePredetermined(int column)
          Deprecated. Checks if the column is type-filterable.
 

Method Detail

isColumnAutoFilterable

boolean isColumnAutoFilterable(int column)
Deprecated. 
Checks if the column is auto-filterable. Please note, this is used in AutoFilterHeader. If it returns false, we will not show the filter button on the header for that column.

Parameters:
column - the column index.
Returns:
true if the column can be filtered.

isValuePredetermined

boolean isValuePredetermined(int column)
Deprecated. 
Checks if the column is type-filterable. Please note, this is used in AutoFilterHeader at multiple line mode. If it returns false, we will not show the filter field on the header for that column.

Parameters:
column - the column index.
Returns:
true if the column can be filtered.

isAllowMultipleValues

boolean isAllowMultipleValues(int column)
Deprecated. 
Checks if the AutoFilterTableHeader allows multiple values as the filter for the column index. The difference will be to use a CheckBoxList or a regular JList as the popup panel when clicking on the filter button.

Parameters:
column - the column index.
Returns:
true or false.

getTitleConverter

StringConverter getTitleConverter(int column)
Deprecated. 
Gets the title converter to convert the column name. The converter will be used when isShowFilterName() returns true.

Parameters:
column - the column index
Returns:
the title converter. null if no converter is needed.

getFilterTitleFormatter

AutoFilterTableHeaderAdapter.FilterTitleFormatter getFilterTitleFormatter(int column)
Deprecated. 
Gets the formatter that will format the title for the AutoFilterTableHeader. This formatter will be used, when isShowFilterName() returns true, to format the title including column name and filter names.

Parameters:
column - the column index
Returns:
the title converter. null if no converter is needed.

getDynamicTableFilters

DynamicTableFilter[] getDynamicTableFilters(int column)
Deprecated. 
Gets all the DynamicTableFilters.

DynamicTableFilter allows to add your own customize filter to the drop down filter list. Any DynamicTableFilter will become an entry in the list. If user clicks on that entry, the filter will be used to filter the column. What's special about DynamicTableFilter is it allows to to create a filter on fly. For example, in initializeFilter method of DynamicTableFilter, you can pop up a dialog to allow user to select certain information and you return a filter based on user selection. If returning null, no filter will be added. If not null, the filter you just created will be added to the IFilterableTableModel.

Parameters:
column - the column in the model to add the DynamicTableFilter
Returns:
an array of DynamicTableFilters.

getListCellRenderer

ListCellRenderer getListCellRenderer(int column)
Deprecated. 
Gets the list cell renderer for the drop down filter list.

Parameters:
column - the column in the model to add the DynamicTableFilter
Returns:
an array of DynamicTableFilters.

isUseTableCellRenderer

boolean isUseTableCellRenderer(int column)
Deprecated. 
Checks if the table cell renderer will be used for the list.

Parameters:
column - the column index.
Returns:
true or false.

isAllowCustomFilter

boolean isAllowCustomFilter(int column)
Deprecated. 
Checks if the AutoFilterTableHeader allows custom filter. The difference is there will be a (Custom...) item in the drop down list.when clicking on the filter button. The value is only considered when AutoFilterTableHeader.isAllowMultipleValues() returns false.

Parameters:
column - the column index.
Returns:
true or false.

JIDE 3.5.15