net.sf.gridarta.gui.panel.archetypechooser

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

java.lang.Object

net.sf.gridarta.gui.panel.archetypechooser.ArchetypeChooserControl<G,A,R>

All Implemented Interfaces:

java.lang.Iterable<R>, ObjectChooserTab<G,A,R>

public class ArchetypeChooserControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object
implements java.lang.Iterable<R>, ObjectChooserTab<G,A,R>

That control of the archetype chooser.

Constructor Summary

Constructors

Constructor and Description
ArchetypeChooserControl(@NotNull ArchetypeChooserModel<G,A,R> archetypeChooserModel, @NotNull ArchetypeChooserView<G,A,R> archetypeChooserView) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
@NotNull java.awt.Component	getComponent() Returns the component to show in the object chooser.
R	getSelection() Returns the selected game object.
@NotNull java.util.List<R>	getSelections() Returns the selected game objects.
@NotNull java.lang.String	getTitle() Returns the title to display in the object chooser.
boolean	isMatching(G gameObject) Returns whether the current selection matches the given game object.
@NotNull java.util.Iterator<R>	iterator() Returns all archetypes in the panel.
void	selectArchetype(R archetype) Select an archetype.
void	setActive(boolean active) Called whenever this tab becomes active or inactive.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ArchetypeChooserControl

public ArchetypeChooserControl(@NotNull
                               @NotNull ArchetypeChooserModel<G,A,R> archetypeChooserModel,
                               @NotNull
                               @NotNull ArchetypeChooserView<G,A,R> archetypeChooserView)

Creates a new instance.

Parameters:

archetypeChooserModel - the archetype chooser model to use; no new archetypes must be added afterwards

archetypeChooserView - the archetype chooser view to use

Method Detail

selectArchetype

public void selectArchetype(@NotNull
                            R archetype)

Select an archetype. If necessary, select the archetype's tab.

Parameters:

archetype - the archetype to select

iterator

@NotNull
public @NotNull java.util.Iterator<R> iterator()

Returns all archetypes in the panel. The archetypes are not sorted..

Specified by:

iterator in interface java.lang.Iterable<R extends Archetype<G,A,R>>

Returns:

an iterator returning all archetypes

getComponent

@NotNull
public @NotNull java.awt.Component getComponent()

Description copied from interface: ObjectChooserTab

Returns the component to show in the object chooser.

Specified by:

getComponent in interface ObjectChooserTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the component to show

setActive

public void setActive(boolean active)

Description copied from interface: ObjectChooserTab

Called whenever this tab becomes active or inactive.

Specified by:

setActive in interface ObjectChooserTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

active - whether this tab is active

isMatching

public boolean isMatching(@NotNull
                          G gameObject)

Description copied from interface: ObjectChooserTab

Returns whether the current selection matches the given game object.

Specified by:

isMatching in interface ObjectChooserTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

gameObject - the game object to compare to

Returns:

whether the game object matches

getSelection

@Nullable
public R getSelection()

Description copied from interface: ObjectChooserTab

Returns the selected game object.

Specified by:

getSelection in interface ObjectChooserTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

one of the selected game objects or null if no game objects are selected

getSelections

@NotNull
public @NotNull java.util.List<R> getSelections()

Description copied from interface: ObjectChooserTab

Returns the selected game objects.

Specified by:

getSelections in interface ObjectChooserTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the selected game objects

getTitle

@NotNull
public @NotNull java.lang.String getTitle()

Description copied from interface: ObjectChooserTab

Returns the title to display in the object chooser.

Specified by:

getTitle in interface ObjectChooserTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the title