net.sf.gridarta.model.archetypechooser

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

java.lang.Object

net.sf.gridarta.model.archetypechooser.ArchetypeChooserPanel<G,A,R>

All Implemented Interfaces:

java.io.Serializable

public class ArchetypeChooserPanel<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object
implements java.io.Serializable

A named panel within the ArchetypeChooserModel. A panel consists of a set of ArchetypeChooserFolders. One panel is selected at any time.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ArchetypeChooserPanel(java.lang.String name) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addArchetype(java.lang.String folder, R archetype) Adds an Archetype to this panel.
void	addArchetypeChooserPanelListener(ArchetypeChooserPanelListener<G,A,R> listener) Adds a listener to be notified of changes.
ArchetypeChooserFolder<G,A,R>	getDefaultFolder() Returns the default ArchetypeChooserFolder that contains all Archetypes of all folders.
ArchetypeChooserFolder<G,A,R>	getFolder(java.lang.String folderName) Returns an ArchetypeChooserFolder by folder name.
java.util.List<ArchetypeChooserFolder<G,A,R>>	getFolders() Returns the ArchetypeChooserFolders.
java.lang.String	getName() Returns the panel name.
ArchetypeChooserFolder<G,A,R>	getSelectedFolder() Returns the selected ArchetypeChooserFolder.
void	removeArchetypeChooserPanelListener(ArchetypeChooserPanelListener<G,A,R> listener) Removes a listener to be notified of changes.
void	setSelectedFolder(ArchetypeChooserFolder<G,A,R> selectedFolder) Sets the selected ArchetypeChooserFolder.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchetypeChooserPanel

public ArchetypeChooserPanel(@NotNull
                             java.lang.String name)

Creates a new instance.

Parameters:

name - the panel name

Method Detail

addArchetypeChooserPanelListener

public void addArchetypeChooserPanelListener(@NotNull
                                             ArchetypeChooserPanelListener<G,A,R> listener)

Adds a listener to be notified of changes.

Parameters:

listener - the listener

removeArchetypeChooserPanelListener

public void removeArchetypeChooserPanelListener(@NotNull
                                                ArchetypeChooserPanelListener<G,A,R> listener)

Removes a listener to be notified of changes.

Parameters:

listener - the listener

getName

@NotNull
public java.lang.String getName()

Returns the panel name.

Returns:

the panel name

getFolders

@NotNull
public java.util.List<ArchetypeChooserFolder<G,A,R>> getFolders()

Returns the ArchetypeChooserFolders.

Returns:

the folders ordered by folder name; the first entry contains all archetypes

addArchetype

public void addArchetype(@NotNull
                         java.lang.String folder,
                         @NotNull
                         R archetype)

Adds an Archetype to this panel.

Parameters:

folder - the folder name to add to

archetype - the archetype to add

getDefaultFolder

@NotNull
public ArchetypeChooserFolder<G,A,R> getDefaultFolder()

Returns the default ArchetypeChooserFolder that contains all Archetypes of all folders.

Returns:

the default folder

getFolder

@Nullable
public ArchetypeChooserFolder<G,A,R> getFolder(@NotNull
                                                         java.lang.String folderName)

Returns an ArchetypeChooserFolder by folder name.

Parameters:

folderName - the folder name

Returns:

the folder or null if no such folder exists

getSelectedFolder

@NotNull
public ArchetypeChooserFolder<G,A,R> getSelectedFolder()

Returns the selected ArchetypeChooserFolder.

Returns:

the selected folder

setSelectedFolder

public void setSelectedFolder(@NotNull
                              ArchetypeChooserFolder<G,A,R> selectedFolder)

Sets the selected ArchetypeChooserFolder.

Parameters:

selectedFolder - the selected folder