net.sf.gridarta.gui.filter

Class DefaultFilterControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

java.lang.Object

net.sf.gridarta.gui.filter.DefaultFilterControl<G,A,R>

All Implemented Interfaces:

FilterControl<G,A,R>

public class DefaultFilterControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object
implements FilterControl<G,A,R>

Control for filters.

Control to check if 1) a specific GameObject can be shown (filter out of view part) 2) a specific MapSquare must be highlighted (analysis part) It provides only one filterOut path (and so elements are visible or not, they can't be twice visible or such). It provides 3 highlight paths. each of them can be (dis)enabled. So you can, e.g., highlight walls in a specific color, teleporters in another and monsters in a third. highlight and filterOut filters works all the same. You can activate specific predefined filters or you can provide your own If several predefined Filters are activated for a path, they are combined in an OR way. For example, if you enable the filterOut path, activate in this path the wall and the floor filters, only walls and floors will be shown.

Field Summary

Fields inherited from interface net.sf.gridarta.gui.filter.FilterControl

MAX_HIGHLIGHT

Constructor Summary

Constructors

Constructor and Description
DefaultFilterControl(NamedFilter filterList) Create a new FilterControl.

Method Summary

Modifier and Type	Method and Description
void	addConfigListener(FilterConfigListener listener) Adds a FilterConfigListener to be notified about changes.
void	addFilter(java.lang.String name, Filter<?,?> filter)
boolean	canShow(G gameObject)
void	createMenuEntries(javax.swing.JMenu menu)
boolean	isHighlightedSquare(FilterState filterState, int path)
void	newSquare(FilterState filterState)
void	objectInSquare(FilterState filterState, G gameObject)
void	removeConfigListener(FilterConfigListener listener) Removes a FilterConfigListener to be notified about changes.
void	removeFilter(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFilterControl

public DefaultFilterControl(@NotNull
                            NamedFilter filterList)

Create a new FilterControl. Do not highlight anything and does not filterOut anything

Parameters:

filterList - the filter list instance to use

Method Detail

addConfigListener

public void addConfigListener(@NotNull
                              FilterConfigListener listener)

Adds a FilterConfigListener to be notified about changes.

Specified by:

addConfigListener in interface FilterControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

listener - the config listener

removeConfigListener

public void removeConfigListener(@NotNull
                                 FilterConfigListener listener)

Removes a FilterConfigListener to be notified about changes.

Specified by:

removeConfigListener in interface FilterControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

listener - the config listener

createMenuEntries

public void createMenuEntries(@NotNull
                              javax.swing.JMenu menu)

Specified by:

createMenuEntries in interface FilterControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

newSquare

public void newSquare(@NotNull
                      FilterState filterState)

Specified by:

newSquare in interface FilterControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

isHighlightedSquare

public boolean isHighlightedSquare(@NotNull
                                   FilterState filterState,
                                   int path)

Specified by:

isHighlightedSquare in interface FilterControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

objectInSquare

public void objectInSquare(@NotNull
                           FilterState filterState,
                           @NotNull
                           G gameObject)

Specified by:

objectInSquare in interface FilterControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

canShow

public boolean canShow(@NotNull
                       G gameObject)

Specified by:

canShow in interface FilterControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

addFilter

public void addFilter(@NotNull
                      java.lang.String name,
                      @NotNull
                      Filter<?,?> filter)

Specified by:

addFilter in interface FilterControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

removeFilter

public void removeFilter(@NotNull
                         java.lang.String name)

Specified by:

removeFilter in interface FilterControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>