net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R > Interface Template Reference

Currently nothing more than a marker interface for unification. More...

Inheritance diagram for net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Collaboration diagram for net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
void	acquire ()
	Increases the use counter. More...
void	addMapControlListener (@NotNull MapControlListener< G, A, R > listener)
	Registers a MapControlListener. More...
MapModel< G, A, R >	getMapModel ()
	Returns the map model. More...
int	getUseCounter ()
	Returns the use counter. More...
boolean	isPickmap ()
	Return flag that indicates whether this is a pickmap or not. More...
void	release ()
	Decreases the use counter and possibly frees the map control. More...
void	removeMapControlListener (@NotNull MapControlListener< G, A, R > listener)
	Unregisters a MapControlListener. More...
void	save () throws IOException
	Saves the map to a file. More...
void	saveAs (@NotNull MapFile mapFile) throws IOException
	Saves the file with the given map file. More...

Detailed Description

Currently nothing more than a marker interface for unification.

Author

Christian Hujer

Andreas Kirschbaum

Definition at line 35 of file MapControl.java.

Member Function Documentation

acquire()

void net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.acquire

(

)

Increases the use counter.

Referenced by net.sf.gridarta.plugin.parameter.MapParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getValue().

Here is the caller graph for this function:

addMapControlListener()

void net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addMapControlListener

(

@NotNull MapControlListener< G, A, R >

listener

)

Registers a MapControlListener.

Parameters

listener

the listener to register

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

Here is the caller graph for this function:

getMapModel()

MapModel<G, A, R> net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapModel

(

)

Returns the map model.

Returns

the map model

Referenced by net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.activeMapViewChanged(), net.sf.gridarta.action.CleanCompletelyBlockedSquaresAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.cleanCompletelyBlockedSquares(), net.sf.gridarta.gui.map.MapFileActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.closeNotify(), net.sf.gridarta.gui.map.mapview.DefaultMapView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.closeNotify(), net.sf.gridarta.model.mapcontrol.TestMapControlCreator.createMaps(), net.sf.gridarta.gui.dialog.shrinkmapsize.ShrinkMapSizeDialog< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.createPanel(), net.sf.gridarta.gui.dialog.golocation.GoLocationDialog< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.createPanel(), net.sf.gridarta.action.AddBookmarkAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doAddBookmark(), net.sf.gridarta.gui.map.MapFileActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doCreateImage(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.doCreateTile(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.doDeleteUnknownObjects(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.doEnterExit(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.doEnterMap(), net.sf.gridarta.actions.ExitConnectorActions< G, A, R >.doExitConnect(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doExpandEmptySelection(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doFloodFill(), net.sf.gridarta.action.GrowSelectionAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doGrowSelection(), net.sf.gridarta.gui.panel.tools.InsertionTool< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doInsert(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.doMapProperties(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doMassChange(), net.sf.gridarta.actions.AbstractServerActions< GameObject, MapArchObject, Archetype >.doOpenInClient(), net.sf.gridarta.gui.map.MapFileActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doReloadMap(), net.sf.gridarta.gui.dialog.replace.ReplaceDialog< G, A, R >.doReplace(), net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserControl<?, ?, ?>.doRevertPickmap(), net.sf.gridarta.gui.map.MapFileActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doSaveMap(), net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserControl<?, ?, ?>.doSavePickmap(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doShift(), net.sf.gridarta.action.ShrinkSelectionAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doShrinkSelection(), net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doValidateMap(), net.sf.gridarta.gui.map.mapactions.EnterMap< G, A, R >.enterMap(), net.sf.gridarta.actions.AttachTiledMaps< G, A, R >.fillAdjacentMaps(), net.sf.gridarta.gui.panel.gameobjectattributes.GameObjectAttributesControl< G, A, R >.GameObjectAttributesControl(), net.sf.gridarta.gui.mainwindow.GameObjectTextEditorTab< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.GameObjectTextEditorTab(), net.sf.gridarta.gui.dialog.plugin.parameter.map.MapParameterCellRenderer.getListCellRendererComponent(), net.sf.gridarta.model.mapmanager.AbstractMapManager< G, A, R >.getLocalMapDir(), net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.getTitle(), net.sf.gridarta.gui.mapfiles.PickmapState< G, A, R >.getUnsavedPickmaps(), net.sf.gridarta.gui.dialog.golocation.GoLocationDialog< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.goLocation(), net.sf.gridarta.model.index.MapsIndexer< G, A, R >.indexPendingMaps(), net.sf.gridarta.gui.map.renderer.ImageCreator<?, ?, ?>.makeImage(), net.sf.gridarta.gui.map.MapFileActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapFileActions(), net.sf.gridarta.gui.dialog.plugin.parameter.map.MapParameterView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapParameterView(), net.sf.gridarta.model.mapcontrol.TestMapControlFactory.newMapControl(), net.sf.gridarta.var.daimonin.model.mapcontrol.DefaultMapControlFactory.newMapControl(), net.sf.gridarta.var.atrinik.model.mapcontrol.DefaultMapControlFactory.newMapControl(), net.sf.gridarta.var.crossfire.model.mapcontrol.DefaultMapControlFactory.newMapControl(), net.sf.gridarta.var.crossfire.model.mapcontrol.DefaultMapControlFactory.newPickmapControl(), net.sf.gridarta.var.daimonin.model.mapcontrol.DefaultMapControlFactory.newPickmapControl(), net.sf.gridarta.var.atrinik.model.mapcontrol.DefaultMapControlFactory.newPickmapControl(), net.sf.gridarta.gui.panel.tools.SelectionTool< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.released(), net.sf.gridarta.gui.mapfiles.PickmapState< G, A, R >.save(), net.sf.gridarta.gui.panel.connectionview.View< K, G, A, R >.scanMapForConnections(), net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserControl<?, ?, ?>.setCurrentPickmap(), net.sf.gridarta.gui.map.mapview.AbstractMapView< TestGameObject, TestMapArchObject, TestArchetype >.setCursorLocation(), net.sf.gridarta.gui.dialog.goexit.GoExitDialog< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.showDialog(), net.sf.gridarta.gui.dialog.shrinkmapsize.ShrinkMapSizeDialog< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.shrinkMapSize(), net.sf.gridarta.gui.copybuffer.CopyBufferTest.testCutPaste1(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareBottomMulti(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareBottomSingle(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareDownMulti(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareDownSingle(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareEnvMulti3(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareEnvMulti4(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareEnvSingle1(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareEnvSingle2(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareEnvSingle3(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareInvIntoHead1(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareInvMulti1(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareInvSingle1(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareTopMulti(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareTopSingle(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareUpMulti(), net.sf.gridarta.action.SelectedSquareActionsTest.testDoMoveSquareUpSingle(), net.sf.gridarta.actions.ExitConnectorActionsTest.testExitConnect1(), net.sf.gridarta.actions.ExitConnectorActionsTest.testExitConnectAuto1(), net.sf.gridarta.actions.ExitConnectorActionsTest.testExitCopy1(), net.sf.gridarta.actions.ExitConnectorActionsTest.testExitPaste1(), net.sf.gridarta.actions.ExitConnectorActionsTest.testExitPaste2(), net.sf.gridarta.actions.UndoActionsTest.testInsert1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testMapFromXml3(), net.sf.gridarta.action.SelectedSquareActionsTest.testMoveEnvIntoSelectedMapSquare(), net.sf.gridarta.action.SelectedSquareActionsTest.testMoveTailPart(), net.sf.gridarta.actions.ExitConnectorActionsTest.testPath(), net.sf.gridarta.model.io.DefaultMapReaderTest.testReorderMultiSquares(), net.sf.gridarta.model.mapmanager.DefaultMapManagerTest.testRevertResizedMap(), net.sf.gridarta.model.mapcontrol.DefaultMapControlTest.testSaveAs1(), net.sf.gridarta.gui.panel.gameobjectattributes.ErrorListView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateErrors(), net.sf.gridarta.gui.panel.objectchooser.DefaultObjectChooser< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updatePickmapInfo(), net.sf.gridarta.actions.AttachTiledMaps< G, A, R >.updateTilePaths(), net.sf.gridarta.gui.dialog.shrinkmapsize.ShrinkMapSizeDialog< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateWarnings(), and net.sf.gridarta.action.ZoomAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.zoom().

getUseCounter()

int net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getUseCounter

(

)

Returns the use counter.

Returns

the use counter

Referenced by net.sf.gridarta.gui.map.mapview.MapViewsManager<?, ?, ?>.closeMapView(), and net.sf.gridarta.actions.ExitConnectorActions< G, A, R >.doExitConnect().

Here is the caller graph for this function:

isPickmap()

boolean net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isPickmap

(

)

Return flag that indicates whether this is a pickmap or not.

Returns

flag that indicates whether this is a pickmap or not

Referenced by net.sf.gridarta.gui.panel.tools.InsertionTool< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doInsert().

Here is the caller graph for this function:

release()

void net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.release

(

)

Decreases the use counter and possibly frees the map control.

removeMapControlListener()

void net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.removeMapControlListener

(

@NotNull MapControlListener< G, A, R >

listener

)

Unregisters a MapControlListener.

Parameters

listener

the listener to unregister

Referenced by net.sf.gridarta.gui.map.mapview.DefaultMapView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.closeNotify(), and net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserControl<?, ?, ?>.setCurrentPickmap().

Here is the caller graph for this function:

save()

void net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.save

(

)

throws IOException

Saves the map to a file.

Exceptions

IOException

if saving fails

Referenced by net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.doCreateTile(), net.sf.gridarta.actions.ExitConnectorActions< G, A, R >.doExitConnect(), net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.newPickmap(), net.sf.gridarta.gui.mapfiles.PickmapState< G, A, R >.save(), net.sf.gridarta.model.index.MapsIndexerTest.test2(), net.sf.gridarta.model.io.DefaultMapReaderTest.testReorderMultiSquares(), net.sf.gridarta.model.mapmanager.DefaultMapManagerTest.testRevertResizedMap(), net.sf.gridarta.model.mapcontrol.DefaultMapControlTest.testSave1(), and net.sf.gridarta.gui.mapmenu.MapMenuManagerTest.testSaveBookmarks().

Here is the caller graph for this function:

saveAs()

void net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.saveAs

(

@NotNull MapFile

mapFile

)

throws IOException

Saves the file with the given map file.

This implicitly sets the map file and resets the modified state.

Parameters

mapFile

the map file to be saved to

Exceptions

IOException

if saving fails; in this case the modified flag is not reset

Referenced by net.sf.gridarta.model.mapcontrol.TestMapControlCreator.createMaps(), and net.sf.gridarta.model.mapcontrol.DefaultMapControlTest.testSaveAs1().

Here is the caller graph for this function:

---

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

• gridarta-gridarta/src/model/src/main/java/net/sf/gridarta/model/mapcontrol/MapControl.java