Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.table.group
Class ColumnFilterHeaderModel

java.lang.Object
  extended by com.citra.filter.tree.TreeFilterHeaderModel
      extended by com.citra.filter.tree.PopupTreeFilterHeaderModel
          extended by com.citra.table.group.ColumnFilterHeaderModel
All Implemented Interfaces:
FilterHeaderCallback

public class ColumnFilterHeaderModel
extends PopupTreeFilterHeaderModel

ColumnFilterHeaderModel is a PopupTreeFilterHeaderModel subclass used for filtering the nodes of a TreeTableColumnModel. The only extension that this class provides is to install a filter control on column nodes that are not leaf.


Field Summary
protected  boolean synchFilters
          variable that determines whether level with node filters are kept in synch
 
Fields inherited from class com.citra.filter.tree.PopupTreeFilterHeaderModel
ARROW_LEFT, ARROW_RIGHT, arrowMode, box, defaultHeaderCursor, filteredColor, unfilteredColor
 
Fields inherited from class com.citra.filter.tree.TreeFilterHeaderModel
ALL_VALUES_MODE, autoCreateAllFilters, columnShowing, defaultFiltersByColumnClass, dynamicFilterTreeTableModel, filterHeader, filterMode, filterTreeTableModel, mapper, PROGRESSIVE_MODE, removeOnInvisible
 
Constructor Summary
ColumnFilterHeaderModel()
          Constructs a ColumnFilterHeaderModel.
 
Method Summary
protected  FilterTreeRenderer createDefaultFilterRenderer()
          Creates and returns the default filter renderer that will be used to display the filterable header component.
protected  ColumnFilterMapper createFilterMapper()
          This will return a custom ColumnFilterMapper.
 boolean getSynchWithLevelFilters()
          Determines whether the header model will synch its level filters with the node filters.
 boolean hasFilterControl(int modelIndex)
          Determines whether a column has a filter control installed.
 void setFilterControlInColumn(TableColumn aColumn)
          Installs a filter on the supplied column.
 void setFilterMapper(ColumnFilterMapper mapper)
          Assigns the column filter mapper that will be used to install and uninstall the column filters.
 void setModel(FilterTreeTableModel ftm)
          Assigns the filter tree table model that will be used to provide the filtering.
 void setSynchWithLevelFilters(boolean synchFilters)
          Determines whether the header model will synch its level filters with the node filters.
 void setTableHeader(FilterTableHeader header)
          Associates a header that will be used for displaying a visual representation of a filter on columns.
 
Methods inherited from class com.citra.filter.tree.PopupTreeFilterHeaderModel
createFilterWrapper, getArrowMode, getComboBox, getDefaultHeaderCursor, getFilteredColor, getUnfilteredColor, popupWillShow, removeFromTable, removeRenderer, setArrowMode, setDefaultHeaderCursor, setFilteredColor, setRenderer, setUnfilteredColor, shouldProcessEvent, updateUI
 
Methods inherited from class com.citra.filter.tree.TreeFilterHeaderModel
attachToTable, attachToTable, createDefaultFilters, createTableHeader, getAutoCreateAllFilters, getColumnShowing, getDefaultFilter, getFilter, getFilterMapper, getFilterMode, getRemoveOnInvisible, getTableHeader, hasFilter, hasFilterControl, inferColumnClass, removeFilter, removeFilterControlFromColumn, removeFilterControlFromColumns, setAutoCreateAllFilters, setColumnShowing, setDefaultFilter, setFilterControlInColumns, setFilterMode, setModel, setRemoveOnInvisible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

synchFilters

protected boolean synchFilters
variable that determines whether level with node filters are kept in synch

Constructor Detail

ColumnFilterHeaderModel

public ColumnFilterHeaderModel()
Constructs a ColumnFilterHeaderModel.

Method Detail

createFilterMapper

protected ColumnFilterMapper createFilterMapper()
This will return a custom ColumnFilterMapper.

This will return a DefaultColumnFilterMapper.

Creates a new instance of the column filter mapper that will be used to install and uninstall the filters.

Overrides:
createFilterMapper in class PopupTreeFilterHeaderModel
Returns:
a new instance of the column filter mapper object.

getSynchWithLevelFilters

public boolean getSynchWithLevelFilters()
Determines whether the header model will synch its level filters with the node filters.

Returns:
true if level filters with node filters are synchronized, false otherwise

setFilterControlInColumn

public void setFilterControlInColumn(TableColumn aColumn)
Installs a filter on the supplied column.

Overrides:
setFilterControlInColumn in class TreeFilterHeaderModel
Parameters:
aColumn - the column for which a filter we want to add.

setFilterMapper

public void setFilterMapper(ColumnFilterMapper mapper)
Assigns the column filter mapper that will be used to install and uninstall the column filters.

Overrides:
setFilterMapper in class TreeFilterHeaderModel
Parameters:
mapper - the column filter mapper to assign.

hasFilterControl

public boolean hasFilterControl(int modelIndex)
Determines whether a column has a filter control installed.

Overrides:
hasFilterControl in class TreeFilterHeaderModel
Parameters:
modelIndex - the model index of the column
Returns:
true if the column at modelIndex has a filter control installed, false otherwise

setModel

public void setModel(FilterTreeTableModel ftm)
Assigns the filter tree table model that will be used to provide the filtering.

Overrides:
setModel in class TreeFilterHeaderModel
Parameters:
ftm - the new filter tree table model to assign.

setSynchWithLevelFilters

public void setSynchWithLevelFilters(boolean synchFilters)
Determines whether the header model will synch its level filters with the node filters.

Parameters:
synchFilters - true if level filters with node filters are synchronized, false otherwise

setTableHeader

public void setTableHeader(FilterTableHeader header)
Associates a header that will be used for displaying a visual representation of a filter on columns.

Overrides:
setTableHeader in class PopupTreeFilterHeaderModel
Parameters:
header - the new header to assign

createDefaultFilterRenderer

protected FilterTreeRenderer createDefaultFilterRenderer()
Creates and returns the default filter renderer that will be used to display the filterable header component.

Overrides:
createDefaultFilterRenderer in class PopupTreeFilterHeaderModel
Returns:
the default filter renderer

Copyright © 2011 Citra Technologies. All Rights Reserved.