A View for choosing pickmaps. More...

Inheritance diagram for net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Collaboration diagram for net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
void	addChangeListener (@NotNull final ChangeListener changeListener)
	Adds a ChangeListener to be notified when the selected pickmap tab changes. More...

Component	getPickmapPanel ()
	Returns the JTabbedPane with all pickmaps. More...

int	getSelectedIndex ()
	Returns the selected index. More...

void	newPickmap (@NotNull final Size2D mapSize, @NotNull final String pickmapName) throws DuplicatePickmapException, IOException
	Add a new pickmap. More...

	PickmapChooserView (@NotNull final PickmapChooserModel< G, A, R > pickmapChooserModel, @NotNull final MapFolderTree< G, A, R > mapFolderTree, @NotNull final MapArchObjectFactory< A > mapArchObjectFactory, @NotNull final MapReaderFactory< G, A > mapReaderFactory, @NotNull final MapManager< G, A, R > pickmapManager)
	Creates a new instance. More...

void	setPopupMenu (@NotNull final JPopupMenu popupMenu)
	Sets the popup menu to show. More...

Private Member Functions
void	addPickmap (@NotNull final PickmapState< G, A, R > pickmapState)
	Called when a new pickmap has been added to the model. More...

String	getTitle (@NotNull final PickmapState< G, A, R > pickmapState)
	Returns the title of a pickmap to use as the tab name. More...

void	removePickmap (@NotNull final PickmapState< G, A, R > pickmapState)
	Called when a pickmap has been removed from the model. More...

void	revertPickmap (@NotNull final PickmapState< G, A, R > pickmapState, @NotNull final MapControl< G, A, R > oldPickmap)
	Called when a pickmap in the model has been reverted. More...

void	setActivePickmap (@NotNull final PickmapState< G, A, R > pickmapState)
	Sets the active pickmap. More...

Private Attributes
MapFolder< G, A, R >	activeMapFolder
	The last known active folder. More...

final MapArchObjectFactory< A >	mapArchObjectFactory
	The MapArchObjectFactory instance. More...

final MapFolderListener< G, A, R >	mapFolderListener
	The listener attached to activeMapFolder. More...

final MapFolderTree< G, A, R >	mapFolderTree
	The model to display. More...

final MapFolderTreeListener< G, A, R >	mapFolderTreeListener
	The listener attached to mapFolderTree. More...

final MapReaderFactory< G, A >	mapReaderFactory
	The map reader factory instance. More...

final PickmapChooserModel< G, A, R >	pickmapChooserModel
	The attached PickmapChooserModel. More...

final PickmapChooserModelListener< G, A, R >	pickmapChooserModelListener
	The PickmapChooserModelListener attached to {} to detect modified pickmaps. More...

final MapManager< G, A, R >	pickmapManager
	The MapManager instance for loading pickmaps. More...

final JTabbedPane	pickmapPanel = new JTabbedPane(SwingConstants.TOP)
	Panel with pickmaps. More...

Static Private Attributes
static final Category	LOG = Logger.getLogger(PickmapChooserView.class)
	The Logger for printing log messages. More...

Detailed Description

A View for choosing pickmaps.

Author: Andreas Kirschbaum

Definition at line 58 of file PickmapChooserView.java.

Constructor & Destructor Documentation

◆ PickmapChooserView()

net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.PickmapChooserView	(	@NotNull final PickmapChooserModel< G, A, R >	pickmapChooserModel,
		@NotNull final MapFolderTree< G, A, R >	mapFolderTree,
		@NotNull final MapArchObjectFactory< A >	mapArchObjectFactory,
		@NotNull final MapReaderFactory< G, A >	mapReaderFactory,
		@NotNull final MapManager< G, A, R >	pickmapManager
	)

Creates a new instance.

Parameters

pickmapChooserModel	the attached pickmap chooser model
mapFolderTree	the model to display
mapArchObjectFactory	the map arch object factory instance
mapReaderFactory	the map reader factory instance
pickmapManager	the pickmap manager for loading pickmaps

Definition at line 200 of file PickmapChooserView.java.

Member Function Documentation

◆ addChangeListener()

void net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addChangeListener ( @NotNull final ChangeListener changeListener )

Adds a ChangeListener to be notified when the selected pickmap tab changes.

Parameters

changeListener the listener to add

Definition at line 228 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserControl<?, ?, ?>.PickmapChooserControl().

Here is the caller graph for this function:

◆ addPickmap()

void net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addPickmap ( @NotNull final PickmapState< G, A, R > pickmapState )

private

Called when a new pickmap has been added to the model.

Parameters

pickmapState the pickmap

Definition at line 236 of file PickmapChooserView.java.

◆ getPickmapPanel()

Component net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getPickmapPanel ( )

Returns the JTabbedPane with all pickmaps.

Returns: the
JTabbedPane

with all pickmaps

Definition at line 305 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserControl<?, ?, ?>.getComponent().

Here is the caller graph for this function:

◆ getSelectedIndex()

int net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getSelectedIndex ( )

Returns the selected index.

Returns: the index

Definition at line 313 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserControl<?, ?, ?>.getSelectedPickmap().

Here is the caller graph for this function:

◆ getTitle()

String net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getTitle ( @NotNull final PickmapState< G, A, R > pickmapState )

private

Returns the title of a pickmap to use as the tab name.

Parameters

pickmapState the pickmap

Returns: the title

Definition at line 293 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.addPickmap(), and net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.revertPickmap().

Here is the caller graph for this function:

◆ newPickmap()

void net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newPickmap	(	@NotNull final Size2D	mapSize,
		@NotNull final String	pickmapName
	)		throws DuplicatePickmapException, IOException

Add a new pickmap.

Parameters

mapSize	the pickmap size in squares
pickmapName	the name of the pickmap

Exceptions

IOException	if an I/O error occurs
DuplicatePickmapException	if the pickmap name is not unique

Definition at line 324 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.dialog.newmap.NewPickmapDialog< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.createNew().

Here is the caller graph for this function:

◆ removePickmap()

void net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.removePickmap ( @NotNull final PickmapState< G, A, R > pickmapState )

private

Called when a pickmap has been removed from the model.

Parameters

pickmapState the pickmap

Definition at line 253 of file PickmapChooserView.java.

◆ revertPickmap()

void net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.revertPickmap	(	@NotNull final PickmapState< G, A, R >	pickmapState,
		@NotNull final MapControl< G, A, R >	oldPickmap
	)

private

Called when a pickmap in the model has been reverted.

Parameters

pickmapState	the pickmap
oldPickmap	the map control before revert

Definition at line 265 of file PickmapChooserView.java.

◆ setActivePickmap()

void net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setActivePickmap ( @NotNull final PickmapState< G, A, R > pickmapState )

private

Sets the active pickmap.

Parameters

pickmapState the pickmap

Definition at line 279 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.newPickmap().

Here is the caller graph for this function:

◆ setPopupMenu()

void net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setPopupMenu ( @NotNull final JPopupMenu popupMenu )

Sets the popup menu to show.

Parameters

popupMenu the popup menu to use

Definition at line 219 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserControl<?, ?, ?>.setPopupMenu().

Here is the caller graph for this function:

Member Data Documentation

◆ activeMapFolder

MapFolder<G, A, R> net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.activeMapFolder

private

The last known active folder.

Definition at line 106 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.newPickmap().

◆ LOG

final Category net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.LOG = Logger.getLogger(PickmapChooserView.class)

staticprivate

The Logger for printing log messages.

Definition at line 64 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.addPickmap().

◆ mapArchObjectFactory

final MapArchObjectFactory<A> net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapArchObjectFactory

private

The MapArchObjectFactory instance.

Definition at line 82 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.newPickmap(), and net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.PickmapChooserView().

◆ mapFolderListener

final MapFolderListener<G, A, R> net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapFolderListener

private

Initial value:

= new MapFolderListener<G, A, R>() {
 
        @Override
        public void pickmapAdded(@NotNull final PickmapState<G, A, R> pickmapState) {
            addPickmap(pickmapState);
        }
 
        @Override
        public void pickmapRemoved(@NotNull final PickmapState<G, A, R> pickmapState) {
            removePickmap(pickmapState);
        }
 
        @Override
        public void pickmapReverted(@NotNull final PickmapState<G, A, R> pickmapState, @NotNull final MapControl<G, A, R> oldPickmap) {
            revertPickmap(pickmapState, oldPickmap);
        }
 
    }

The listener attached to activeMapFolder.

Definition at line 151 of file PickmapChooserView.java.

◆ mapFolderTree

final MapFolderTree<G, A, R> net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapFolderTree

private

The model to display.

Definition at line 76 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.PickmapChooserView().

◆ mapFolderTreeListener

final MapFolderTreeListener<G, A, R> net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapFolderTreeListener

private

The listener attached to mapFolderTree.

Definition at line 112 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.PickmapChooserView().

◆ mapReaderFactory

final MapReaderFactory<G, A> net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapReaderFactory

private

The map reader factory instance.

Definition at line 88 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.newPickmap(), and net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.PickmapChooserView().

◆ pickmapChooserModel

final PickmapChooserModel<G, A, R> net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pickmapChooserModel

private

The attached PickmapChooserModel.

Definition at line 70 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.addPickmap(), net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.PickmapChooserView(), net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.removePickmap(), net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.revertPickmap(), and net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.setActivePickmap().

◆ pickmapChooserModelListener

final PickmapChooserModelListener<G, A, R> net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pickmapChooserModelListener

private

Initial value:

= new PickmapChooserModelListener<G, A, R>() {
 
        @Override
        public void activePickmapChanged(@Nullable final PickmapState<G, A, R> pickmapState) {
        }
 
        @Override
        public void pickmapReverted(@NotNull final PickmapState<G, A, R> pickmapState) {
        }
 
        @Override
        public void pickmapModifiedChanged(final int index, @NotNull final PickmapState<G, A, R> pickmapState) {
            pickmapPanel.setTitleAt(index, getTitle(pickmapState));
        }
 
    }

The PickmapChooserModelListener attached to {} to detect modified pickmaps.

Definition at line 175 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.PickmapChooserView().

◆ pickmapManager

final MapManager<G, A, R> net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pickmapManager

private

The MapManager instance for loading pickmaps.

Definition at line 94 of file PickmapChooserView.java.

Referenced by net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.newPickmap(), and net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.PickmapChooserView().

◆ pickmapPanel

final JTabbedPane net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pickmapPanel = new JTabbedPane(SwingConstants.TOP)

private

Panel with pickmaps.

Definition at line 100 of file PickmapChooserView.java.

The documentation for this class was generated from the following file:

src/gridarta/src/main/java/net/sf/gridarta/gui/panel/pickmapchooser/PickmapChooserView.java

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PickmapChooserView()

Member Function Documentation

◆ addChangeListener()

◆ addPickmap()

◆ getPickmapPanel()

◆ getSelectedIndex()

◆ getTitle()

◆ newPickmap()

◆ removePickmap()

◆ revertPickmap()

◆ setActivePickmap()

◆ setPopupMenu()

Member Data Documentation

◆ activeMapFolder

◆ LOG

◆ mapArchObjectFactory

◆ mapFolderListener

◆ mapFolderTree

◆ mapFolderTreeListener

◆ mapReaderFactory

◆ pickmapChooserModel

◆ pickmapChooserModelListener

◆ pickmapManager

◆ pickmapPanel