com.jidesoft.grid
Class JideTableSearchable

java.lang.Object
  com.jidesoft.swing.Searchable
      com.jidesoft.swing.TableSearchable
          com.jidesoft.grid.JideTableSearchable

All Implemented Interfaces:

PropertyChangeListener, EventListener, TableModelListener

Direct Known Subclasses:

ContextSensitiveTableSearchable

public class JideTableSearchable
extends TableSearchable

This is the Searchable class for JideTable when table's isNonContiguousCellSelection is true. Otherwise, TableSearchable should work just fine with JideTable.

If JideTable's isNonContiguousCellSelection is true, we will assume it is cell based search. So it will search for all cells and ignore settings such as TableSearchable.setMainIndex(int).

Nested Class Summary

Nested classes/interfaces inherited from class com.jidesoft.swing.Searchable

Searchable.SearchField, Searchable.SearchPopup

Field Summary

Fields inherited from class com.jidesoft.swing.Searchable

_component, _componentListener, _focusListener, _keyListener, _matchCount, CLIENT_PROPERTY_SEARCHABLE, listenerList, PROPERTY_SEARCH_TEXT

Constructor Summary

JideTableSearchable(JTable table)

Method Summary

protected Object	getElementAt(int index) Gets the element at the specified index.
protected int	getElementCount() Gets the total element count in the component.
protected int	getSelectedIndex() Gets the selected index.
protected boolean	isNonContiguousCellSelection()
protected void	setSelectedIndex(int index, boolean incremental) Sets the selected index.

Methods inherited from class com.jidesoft.swing.TableSearchable

addTableSelection, convertElementToString, getMainIndex, getSearchColumnIndices, getValueAt, installListeners, isActivateKey, isColumnSelectionAllowed, isFindNextKey, isFindPreviousKey, isRowSelectionAllowed, isSearchSelectedRows, isSelectedCellEditable, propertyChange, setMainIndex, setSearchColumnIndices, tableChanged, uninstallListeners

Methods inherited from class com.jidesoft.swing.Searchable

addPropertyChangeListener, addSearchableListener, adjustSelectedIndex, cancelHighlightAll, compare, compare, convertToString, createComponentListener, createFocusListener, createKeyListener, createSearchPopup, findAll, findFirst, findFromCursor, findLast, findNext, findPrevious, firePropertyChangeEvent, fireSearchableEvent, getBackground, getComponent, getCurrentIndex, getCursor, getElementAtAsString, getForeground, getMismatchForeground, getPopupLocation, getPopupLocationRelativeTo, getPopupTimeout, getResourceString, getSearchable, getSearchableListeners, getSearchableProvider, getSearchingDelay, getSearchingText, getSearchLabel, getWildcardSupport, hidePopup, highlightAll, isCaseSensitive, isCountMatch, isDeactivateKey, isFindFirstKey, isFindLastKey, isFromStart, isHeavyweightComponentEnabled, isHideSearchPopupOnEvent, isIncrementalSelectKey, isNavigationKey, isPopupVisible, isProcessModelChangeEvent, isRepeats, isReverseOrder, isSearchableListenerInstalled, isSelectAllKey, isWildcardEnabled, keyTypedOrPressed, removePropertyChangeListener, removeSearchableListener, reverseFindFromCursor, searchingTextEmpty, select, setBackground, setCaseSensitive, setCountMatch, setCursor, setCursor, setForeground, setFromStart, setHeavyweightComponentEnabled, setHideSearchPopupOnEvent, setMismatchForeground, setPopupLocation, setPopupLocationRelativeTo, setPopupTimeout, setProcessModelChangeEvent, setRepeats, setReverseOrder, setSearchableProvider, setSearchingDelay, setSearchLabel, setWildcardEnabled, setWildcardSupport, showPopup, textChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JideTableSearchable

public JideTableSearchable(JTable table)

Method Detail

isNonContiguousCellSelection

protected boolean isNonContiguousCellSelection()

setSelectedIndex

protected void setSelectedIndex(int index,
                                boolean incremental)

Description copied from class: Searchable

Sets the selected index. The concrete implementation should call methods on the component to select the element at the specified index. The incremental flag is used to do multiple select. If the flag is true, the element at the index should be added to current selection. If false, you should clear previous selection and then select the element.

Overrides:

setSelectedIndex in class TableSearchable

Parameters:

index - the index to be selected

incremental - a flag to enable multiple selection. If the flag is true, the element at the index should be added to current selection. If false, you should clear previous selection and then select the element.

getSelectedIndex

protected int getSelectedIndex()

Description copied from class: TableSearchable

Gets the selected index.

Overrides:

getSelectedIndex in class TableSearchable

Returns:

the selected index.

getElementAt

protected Object getElementAt(int index)

Description copied from class: Searchable

Gets the element at the specified index. The element could be any data structure that internally used in the component. The convertElementToString method will give you a chance to convert the element to string which is used to compare with the string that user types in.

Overrides:

getElementAt in class TableSearchable

Parameters:

index - the index

Returns:

the element at the specified index.

getElementCount

protected int getElementCount()

Description copied from class: Searchable

Gets the total element count in the component. Different concrete implementation could have different interpretation of the count. This is totally OK as long as it's consistent in all the methods. For example, the index parameter in other methods should be always a valid value within the total count.

Overrides:

getElementCount in class TableSearchable

Returns:

the total element count.