org.jdesktop.swingx.search
Class TableSearchable

java.lang.Object
  org.jdesktop.swingx.search.AbstractSearchable
      org.jdesktop.swingx.search.TableSearchable

All Implemented Interfaces:

Searchable

public class TableSearchable
extends AbstractSearchable

Nested Class Summary

Nested classes/interfaces inherited from class org.jdesktop.swingx.search.AbstractSearchable

AbstractSearchable.SearchResult

Field Summary

protected JXTable

table

Fields inherited from class org.jdesktop.swingx.search.AbstractSearchable

lastSearchResult, MATCH_HIGHLIGHTER, NO_MATCH

Constructor Summary

TableSearchable(JXTable table)

Method Summary

protected void	addHighlighter(Highlighter highlighter)
protected int	adjustStartPosition(int startIndex, boolean backwards) Called if startIndex is different from last search, reset the column to -1 and make sure a backwards/forwards search starts at last/first row, respectively.
protected int	convertColumnIndexToModel(int viewColumn) Converts and returns the given column index from view coordinates to model coordinates.
protected AbstractSearchable.SearchResult	findExtendedMatch(Pattern pattern, int row) called if sameRowIndex && !hasEqualRegEx.
protected void	findMatchAndUpdateState(Pattern pattern, int startRow, boolean backwards) Loops through the searchable until a match is found or the end is reached.
protected AbstractSearchable.SearchResult	findMatchAt(Pattern pattern, int row, int column) Matches the cell content at row/col against the given Pattern.
protected Highlighter[]	getHighlighters()
protected int	getSize() returns the size of this searchable.
JXTable	getTarget() It's the responsibility of subclasses to covariant override.
protected boolean	isEqualStartIndex(int startIndex) Checks if the startIndex is a candidate for trying a re-match.
protected void	moveMatchByHighlighter() use and move the match highlighter.
protected void	moveMatchBySelection()
protected void	moveMatchMarker() Moves the match marker according to current found state.
protected int	moveStartPosition(int startRow, boolean backwards) Moves the internal start for matching as appropriate and returns the new startIndex to use.
protected void	removeHighlighter(Highlighter searchHighlighter)

Methods inherited from class org.jdesktop.swingx.search.AbstractSearchable

createMatchHighlighter, createMatchPredicate, createSearchResult, doSearch, ensureInsertedSearchHighlighters, getConfiguredMatchHighlighter, getMatchHighlighter, hasMatch, isEmpty, isEqualPattern, isTrivialNoMatch, isValidIndex, markByHighlighter, search, search, search, search, search, search, setMatchHighlighter, updateState

Methods inherited from class java.lang.Object

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

Field Detail

table

protected JXTable table

Constructor Detail

TableSearchable

public TableSearchable(JXTable table)

Parameters:

table -

Method Detail

findMatchAndUpdateState

protected void findMatchAndUpdateState(Pattern pattern,
                                       int startRow,
                                       boolean backwards)

Description copied from class: AbstractSearchable

Loops through the searchable until a match is found or the end is reached. Updates internal search state.

Specified by:

findMatchAndUpdateState in class AbstractSearchable

Parameters:

pattern - Pattern that we will try to locate

startRow - position in the document in the appropriate coordinates from which we will start search or -1 to start from the beginning

backwards - true if we should perform search towards the beginning

findExtendedMatch

protected AbstractSearchable.SearchResult findExtendedMatch(Pattern pattern,
                                                            int row)

called if sameRowIndex && !hasEqualRegEx. Matches the cell at row/lastFoundColumn against the pattern. PRE: lastFoundColumn valid.

Specified by:

findExtendedMatch in class AbstractSearchable

Parameters:

pattern -

row -

Returns:

an appropriate SearchResult if matching or null

findMatchAt

protected AbstractSearchable.SearchResult findMatchAt(Pattern pattern,
                                                      int row,
                                                      int column)

Matches the cell content at row/col against the given Pattern. Returns an appropriate SearchResult if matching or null if no matching

Parameters:

pattern -

row - a valid row index in view coordinates

column - a valid column index in view coordinates

Returns:

an appropriate SearchResult if matching or null

adjustStartPosition

protected int adjustStartPosition(int startIndex,
                                  boolean backwards)

Called if startIndex is different from last search, reset the column to -1 and make sure a backwards/forwards search starts at last/first row, respectively.

Overrides:

adjustStartPosition in class AbstractSearchable

Parameters:

startIndex -

backwards -

Returns:

adjusted startIndex

moveStartPosition

protected int moveStartPosition(int startRow,
                                boolean backwards)

Moves the internal start for matching as appropriate and returns the new startIndex to use. Called if search was messaged with the same startIndex as previously.

Overrides:

moveStartPosition in class AbstractSearchable

Parameters:

startRow -

backwards -

Returns:

new start index to use

isEqualStartIndex

protected boolean isEqualStartIndex(int startIndex)

Checks if the startIndex is a candidate for trying a re-match.

Overrides:

isEqualStartIndex in class AbstractSearchable

Parameters:

startIndex -

Returns:

true if the startIndex should be re-matched, false if not.

getSize

protected int getSize()

returns the size of this searchable.

Specified by:

getSize in class AbstractSearchable

Returns:

size of this searchable

getTarget

public JXTable getTarget()

It's the responsibility of subclasses to covariant override.

Specified by:

getTarget in class AbstractSearchable

Returns:

the target component

moveMatchByHighlighter

protected void moveMatchByHighlighter()

use and move the match highlighter. PRE: markByHighlighter

convertColumnIndexToModel

protected int convertColumnIndexToModel(int viewColumn)

Converts and returns the given column index from view coordinates to model coordinates. This implementation returns the view coordinate, that is assumes that both coordinate systems are the same. Overridden to convert the column index in the table's view coordinate system to model coordinate.

PENDING JW: this is only necessary because the SearchPredicate wants its highlight column in model coordinates. But code comments in the SearchPredicate seem to indicate that we probably want to revise that (legacy?).

Overrides:

convertColumnIndexToModel in class AbstractSearchable

Parameters:

viewColumn - the column index in view coordinates, must be a valid index in that system.

Returns:

the column index in model coordinates.

moveMatchBySelection

protected void moveMatchBySelection()

moveMatchMarker

protected void moveMatchMarker()

Description copied from class: AbstractSearchable

Moves the match marker according to current found state.

Specified by:

moveMatchMarker in class AbstractSearchable

removeHighlighter

protected void removeHighlighter(Highlighter searchHighlighter)

Specified by:

removeHighlighter in class AbstractSearchable

Parameters:

searchHighlighter -

getHighlighters

protected Highlighter[] getHighlighters()

Specified by:

getHighlighters in class AbstractSearchable

Returns:

addHighlighter

protected void addHighlighter(Highlighter highlighter)

Specified by:

addHighlighter in class AbstractSearchable

Parameters:

highlighter -