An EditorAction that opens the game object attributes dialog for the currently selected game object. More...

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

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

Public Member Functions
void	activeMapViewChanged (@Nullable final MapView< G, A, R > mapView)
	This event handler is called when the current map view has changed. More...

void	archAttributes ()
	Action method for "arch attributes". More...

	ArchAttributesAction (@NotNull final GameObjectAttributesDialogFactory< G, A, R > gameObjectAttributesDialogFactory)
	Creates a new instance. More...

void	mapCursorChangedGameObject (@Nullable final MapSquare< G, A, R > mapSquare, @Nullable final G gameObject)
	Called whenever the selected game object has changed. More...

void	mapCursorChangedMode ()
	This event handler is called when MapCursor changes mode (drag, select). More...

void	mapCursorChangedPos (@NotNull final Point location)
	This event handler is called when MapCursor has moved. More...

void	mapCursorChangedSize ()
	Called whenever the map cursor's map grid size has changed. More...

void	mapViewClosing (@NotNull final MapView< G, A, R > mapView)
	This event handler is called when a map view is to be closed. More...

void	mapViewCreated (@NotNull final MapView< G, A, R > mapView)
	This event handler is called when a map view was created. More...

void	setAction (@NotNull final Action action, @NotNull final String name)
	Sets the Action instance for this editor action. More...

Private Member Functions
boolean	doArchAttributes (final boolean performAction)
	Executes the "arch attributes" action. More...

void	updateActions ()
	Updates the enabled state of action. More...

Private Attributes
Action	action
	The associated Action. More...

MapView< G, A, R >	currentMapView
	The active map view, or. More...

final GameObjectAttributesDialogFactory< G, A, R >	gameObjectAttributesDialogFactory
	The factory for creating game object attributes dialog instances. More...

Detailed Description

An EditorAction that opens the game object attributes dialog for the currently selected game object.

Author: Andreas Kirschbaum

Definition at line 43 of file ArchAttributesAction.java.

Constructor & Destructor Documentation

◆ ArchAttributesAction()

net.sf.gridarta.action.ArchAttributesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ArchAttributesAction ( @NotNull final GameObjectAttributesDialogFactory< G, A, R > gameObjectAttributesDialogFactory )

Creates a new instance.

Parameters

gameObjectAttributesDialogFactory the factory for creating game object attributes dialog instances

Definition at line 69 of file ArchAttributesAction.java.

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

Here is the call graph for this function:

Member Function Documentation

◆ activeMapViewChanged()

void net.sf.gridarta.action.ArchAttributesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.activeMapViewChanged ( @Nullable final MapView< G, A, R > mapView )

This event handler is called when the current map view has changed.

Parameters

mapView

the new map view or

null

if no opened map view exists

Implements net.sf.gridarta.gui.map.mapview.MapViewManagerListener< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.

Definition at line 121 of file ArchAttributesAction.java.

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

Here is the call graph for this function:

◆ archAttributes()

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

Action method for "arch attributes".

Definition at line 78 of file ArchAttributesAction.java.

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

Here is the call graph for this function:

◆ doArchAttributes()

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

private

Executes the "arch attributes" action.

Parameters

performAction whether the action should be performed

Returns: whether the action was or can be performed

Definition at line 102 of file ArchAttributesAction.java.

References net.sf.gridarta.model.mapcursor.MapCursor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getGameObject(), net.sf.gridarta.gui.map.mapview.MapView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapCursor(), and net.sf.gridarta.gui.dialog.gameobjectattributes.GameObjectAttributesDialogFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.showAttributeDialog().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mapCursorChangedGameObject()

void net.sf.gridarta.action.ArchAttributesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapCursorChangedGameObject	(	@Nullable final MapSquare< G, A, R >	mapSquare,
		@Nullable final G	gameObject
	)

Called whenever the selected game object has changed.

This function is not called if mapCursorChangedPos(Point) occurs concurrently.

Parameters

mapSquare	the newly selected map square or null if no map square is selected
gameObject	the newly selected game object or null if no game object is selected

Implements net.sf.gridarta.model.mapcursor.MapCursorListener< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.

Definition at line 147 of file ArchAttributesAction.java.

◆ mapCursorChangedMode()

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

This event handler is called when MapCursor changes mode (drag, select).

Implements net.sf.gridarta.model.mapcursor.MapCursorListener< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.

Definition at line 142 of file ArchAttributesAction.java.

◆ mapCursorChangedPos()

void net.sf.gridarta.action.ArchAttributesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapCursorChangedPos ( @NotNull final Point location )

This event handler is called when MapCursor has moved.

Parameters

location the new location

Implements net.sf.gridarta.model.mapcursor.MapCursorListener< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.

Definition at line 137 of file ArchAttributesAction.java.

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

Here is the call graph for this function:

◆ mapCursorChangedSize()

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

Called whenever the map cursor's map grid size has changed.

Implements net.sf.gridarta.model.mapcursor.MapCursorListener< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.

Definition at line 152 of file ArchAttributesAction.java.

◆ mapViewClosing()

void net.sf.gridarta.action.ArchAttributesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewClosing ( @NotNull final MapView< G, A, R > mapView )

This event handler is called when a map view is to be closed.

Parameters

mapView the map view that is to be closed

Implements net.sf.gridarta.gui.map.mapview.MapViewManagerListener< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.

Definition at line 132 of file ArchAttributesAction.java.

◆ mapViewCreated()

void net.sf.gridarta.action.ArchAttributesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewCreated ( @NotNull final MapView< G, A, R > mapView )

This event handler is called when a map view was created.

Parameters

mapView the created map view

Implements net.sf.gridarta.gui.map.mapview.MapViewManagerListener< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.

Definition at line 127 of file ArchAttributesAction.java.

◆ setAction()

void net.sf.gridarta.action.ArchAttributesAction< 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 83 of file ArchAttributesAction.java.

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

◆ updateActions()

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

private

Updates the enabled state of action.

Definition at line 90 of file ArchAttributesAction.java.

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

Referenced by net.sf.gridarta.action.ArchAttributesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.activeMapViewChanged(), net.sf.gridarta.action.ArchAttributesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ArchAttributesAction(), and net.sf.gridarta.action.ArchAttributesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapCursorChangedPos().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ action

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

private

The associated Action.

Set to

null

if none is associated.

Definition at line 62 of file ArchAttributesAction.java.

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

◆ currentMapView

MapView<G, A, R> net.sf.gridarta.action.ArchAttributesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.currentMapView

private

The active map view, or.

null

if no map view exists.

Definition at line 55 of file ArchAttributesAction.java.

◆ gameObjectAttributesDialogFactory

final GameObjectAttributesDialogFactory<G, A, R> net.sf.gridarta.action.ArchAttributesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.gameObjectAttributesDialogFactory

private

The factory for creating game object attributes dialog instances.

Definition at line 49 of file ArchAttributesAction.java.

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

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

gridarta-gridarta/src/gridarta/src/main/java/net/sf/gridarta/action/ArchAttributesAction.java

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ArchAttributesAction()

Member Function Documentation

◆ activeMapViewChanged()

◆ archAttributes()

◆ doArchAttributes()

◆ mapCursorChangedGameObject()

◆ mapCursorChangedMode()

◆ mapCursorChangedPos()

◆ mapCursorChangedSize()

◆ mapViewClosing()

◆ mapViewCreated()

◆ setAction()

◆ updateActions()

Member Data Documentation

◆ action

◆ currentMapView

◆ gameObjectAttributesDialogFactory