net.sf.gridarta.gui.panel.selectedsquare

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

java.lang.Object

net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel<G,A,R>

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

The model component of the selected square control.

Constructor Summary

Constructors

Constructor and Description
SelectedSquareModel()

Method Summary

Modifier and Type	Method and Description
void	addSelectedSquareListener(@NotNull SelectedSquareModelListener<G,A,R> listener) Adds a SelectedSquareModelListener to be notified.
G	getSelectedGameObject() Returns the currently selected GameObject within this list (currently selected MapSquare).
@Nullable MapSquare<G,A,R>	getSelectedMapSquare() Returns the currently selected map square.
boolean	isSelectedGameObjects(@NotNull java.lang.Iterable<G> gameObjects)
boolean	isSelectedMapSquares(@NotNull java.lang.Iterable<MapSquare<G,A,R>> mapSquares)
void	removeSelectedSquareListener(@NotNull SelectedSquareModelListener<G,A,R> listener) Removes a SelectedSquareModelListener to be notified.
void	setSelectedGameObject(G gameObject) Sets the currently selected GameObject.
boolean	setSelectedMapSquare(@Nullable MapSquare<G,A,R> mapSquare, G gameObject) Sets the currently selected map square.

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectedSquareModel

public SelectedSquareModel()

Method Detail

getSelectedMapSquare

@Nullable
public @Nullable MapSquare<G,A,R> getSelectedMapSquare()

Returns the currently selected map square.

Returns:

the currently selected map square, or null if no square is selected

getSelectedGameObject

@Nullable
public G getSelectedGameObject()

Returns the currently selected GameObject within this list (currently selected MapSquare).

Returns:

the currently selected game object or null

addSelectedSquareListener

public void addSelectedSquareListener(@NotNull
                                      @NotNull SelectedSquareModelListener<G,A,R> listener)

Adds a SelectedSquareModelListener to be notified.

Parameters:

listener - the listener to add

removeSelectedSquareListener

public void removeSelectedSquareListener(@NotNull
                                         @NotNull SelectedSquareModelListener<G,A,R> listener)

Removes a SelectedSquareModelListener to be notified.

Parameters:

listener - the listener to remove

isSelectedMapSquares

public boolean isSelectedMapSquares(@NotNull
                                    @NotNull java.lang.Iterable<MapSquare<G,A,R>> mapSquares)

isSelectedGameObjects

public boolean isSelectedGameObjects(@NotNull
                                     @NotNull java.lang.Iterable<G> gameObjects)

setSelectedMapSquare

public boolean setSelectedMapSquare(@Nullable
                                    @Nullable MapSquare<G,A,R> mapSquare,
                                    @Nullable
                                    G gameObject)

Sets the currently selected map square.

Parameters:

mapSquare - the selected map square

gameObject - the selected game object, or null to deselect it

Returns:

true if the state has changed

setSelectedGameObject

public void setSelectedGameObject(@Nullable
                                  G gameObject)

Sets the currently selected GameObject.

Parameters:

gameObject - the selected game object or null