net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R > Class Template Reference

An EditorAction that runs the map validator on the current map. More...

Inheritance diagram for net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Collaboration diagram for net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
void	setAction (@NotNull final Action action, @NotNull final String name)
	Sets the Action instance for this editor action. More...
void	validateMap ()
	Runs the map validator on the current map. More...
	ValidateMapAction (@NotNull final DelegatingMapValidator< G, A, R > validators, @NotNull final MapManager< G, A, R > mapManager)
	Creates a new instance. More...

Private Member Functions
boolean	doValidateMap (final boolean performAction)
	Executes the "validate map" action. More...
MapManagerListener< G, A, R >	newMapManagerListener ()
	Creates a new MapManagerListener that refreshes the actions when the current map changes. More...
void	updateActions ()
	Updates the state of the action. More...

Private Attributes
Action	action
	The Action associated with this editor action. More...
MapControl< G, A, R >	currentMapControl
	The last known active map, or. More...
final DelegatingMapValidator< G, A, R >	validators
	The map validators. More...

Detailed Description

An EditorAction that runs the map validator on the current map.

Author

Andreas Kirschbaum

Definition at line 39 of file ValidateMapAction.java.

Constructor & Destructor Documentation

ValidateMapAction()

net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ValidateMapAction	(	@NotNull final DelegatingMapValidator< G, A, R >	validators,
		@NotNull final MapManager< G, A, R >	mapManager
	)

Creates a new instance.

Parameters

validators	the map validators
mapManager	the map manager instance

Definition at line 98 of file ValidateMapAction.java.

References net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newMapManagerListener(), and net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.validators.

Here is the call graph for this function:

Member Function Documentation

doValidateMap()

boolean net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doValidateMap ( final boolean  performAction )

private

Executes the "validate map" action.

Parameters

performAction

whether the action should be performed

Returns

whether the action was or can be performed

Definition at line 122 of file ValidateMapAction.java.

References net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.currentMapControl, net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapModel(), and net.sf.gridarta.model.validation.DelegatingMapValidator< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.validateAll().

Referenced by net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateActions(), and net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.validateMap().

Here is the call graph for this function:

Here is the caller graph for this function:

newMapManagerListener()

MapManagerListener<G, A, R> net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newMapManagerListener ( )

private

Creates a new MapManagerListener that refreshes the actions when the current map changes.

Returns

the map manager listener

Definition at line 66 of file ValidateMapAction.java.

References net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateActions().

Referenced by net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ValidateMapAction().

Here is the call graph for this function:

Here is the caller graph for this function:

setAction()

void net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setAction	(	@NotNull final Action	action,
		@NotNull final String	name
	)

Sets the Action instance for this editor action.

Parameters

action	the action instance
name	the name of the action

Implements net.sf.gridarta.utils.EditorAction.

Definition at line 113 of file ValidateMapAction.java.

References net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.action.

updateActions()

void net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateActions ( )

private

Updates the state of the action.

Definition at line 138 of file ValidateMapAction.java.

References net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doValidateMap().

Referenced by net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newMapManagerListener().

Here is the call graph for this function:

Here is the caller graph for this function:

validateMap()

void net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.validateMap

(

)

Runs the map validator on the current map.

Definition at line 108 of file ValidateMapAction.java.

References net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doValidateMap().

Here is the call graph for this function:

Member Data Documentation

action

Action net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.action

private

The Action associated with this editor action.

Set to

null 

if no action is associated.

Definition at line 52 of file ValidateMapAction.java.

Referenced by net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setAction().

currentMapControl

MapControl<G, A, R> net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.currentMapControl

private

The last known active map, or.

null 

if no map is active.

Definition at line 58 of file ValidateMapAction.java.

Referenced by net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doValidateMap().

validators

final DelegatingMapValidator<G, A, R> net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.validators

private

The map validators.

Definition at line 45 of file ValidateMapAction.java.

Referenced by net.sf.gridarta.action.ValidateMapAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ValidateMapAction().

---

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

• gridarta-gridarta/src/gridarta/src/main/java/net/sf/gridarta/action/ValidateMapAction.java