FilterState (Gridarta)

java.lang.Object
- net.sf.gridarta.gui.filter.FilterState

```
public class FilterState
extends java.lang.Object
```
The highlighted state while using a FilterControl instance.

Constructor Summary

Constructors
Constructor Description

FilterState()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isHighlightedSquare(int path)`	Returns whether the given path should be highlighted.
`void`	`reset()`	Resets the state to no highlights.
`void`	`setHighlightedSquare(int path, boolean highlightedSquare)`	Sets the highlighted state for a given path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FilterState
```
public FilterState()
```
- Method Detail
  - reset
```
public void reset()
```
    Resets the state to no highlights.
  - isHighlightedSquare
```
public boolean isHighlightedSquare(int path)
```
    Returns whether the given path should be highlighted.
    
    Parameters:
    
    path - the path
    
    Returns:
    
    the highlighted state
  - setHighlightedSquare
```
public void setHighlightedSquare(int path,
                                 boolean highlightedSquare)
```
    Sets the highlighted state for a given path.
    
    Parameters:
    
    path - the path
    
    highlightedSquare - the highlighted state