org.jdesktop.swingx.search
Class AbstractSearchable.SearchResult

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

Enclosing class:

AbstractSearchable

public static class AbstractSearchable.SearchResult
extends Object

A convenience class to hold search state.

NOTE: this is still in-flow, probably will take more responsibility/ or even change altogether on further factoring

Constructor Summary

AbstractSearchable.SearchResult()
Instantiates an empty SearchResult.

AbstractSearchable.SearchResult(Pattern ex, MatchResult result, int row, int column)
Instantiates a SearchResult with the given state.

Method Summary

int	getFoundColumn() Returns the column index of the match position.
int	getFoundRow() Returns the row index of the match position.
MatchResult	getMatchResult() Returns the MatchResult representing the current match.
Pattern	getPattern() Returns the Pattern used for matching.
String	getRegEx() Returns the regex of the Pattern used for matching.
void	reset() Resets all internal state to no-match.
void	resetFoundColumn() Resets the column to OFF.
void	updateFrom(AbstractSearchable.SearchResult searchResult) Sets internal state to the same as the given SearchResult.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSearchable.SearchResult

public AbstractSearchable.SearchResult()

Instantiates an empty SearchResult.

AbstractSearchable.SearchResult

public AbstractSearchable.SearchResult(Pattern ex,
                                       MatchResult result,
                                       int row,
                                       int column)

Instantiates a SearchResult with the given state.

Parameters:

ex - the Pattern used for matching

result - the current MatchResult

row - the row index of the current match

column - the column index of the current match

Method Detail

updateFrom

public void updateFrom(AbstractSearchable.SearchResult searchResult)

Sets internal state to the same as the given SearchResult. Resets internals if the param is null.

Parameters:

searchResult - the SearchResult to copy internal state from.

getRegEx

public String getRegEx()

Returns the regex of the Pattern used for matching.

Returns:

the regex of the Pattern used for matching.

reset

public void reset()

Resets all internal state to no-match.

resetFoundColumn

public void resetFoundColumn()

Resets the column to OFF.

getFoundColumn

public int getFoundColumn()

Returns the column index of the match position.

Returns:

the column index of the match position.

getFoundRow

public int getFoundRow()

Returns the row index of the match position.

Returns:

the row index of the match position.

getMatchResult

public MatchResult getMatchResult()

Returns the MatchResult representing the current match.

Returns:

the MatchResult representing the current match.

getPattern

public Pattern getPattern()

Returns the Pattern used for matching.

Returns:

the Pattern used for the matching.