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

An EditorAction that openes the "go location" dialog. More...

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

Public Member Functions

void goLocation ()
 Opens the "go location" dialog. More...
 
 GoLocationAction (@NotNull final MapViewManager< G, A, R > mapViewManager)
 Creates a new instance. More...
 
void setAction (@NotNull final Action action, @NotNull final String name)
 Sets the Action instance for this editor action. More...
 
- Public Member Functions inherited from net.sf.gridarta.action.AbstractMapCursorAction< G, A, R >
void activeMapViewChanged ( @Nullable final MapView< G, A, R > mapView)
 This event handler is called when the current map view has changed. More...
 
void mapCursorChangedGameObject ( @Nullable final MapSquare< G, A, R > mapSquare, @Nullable final G gameObject)
 NoopMethodInAbstractClass 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 ()
 NoopMethodInAbstractClass More...
 
void mapViewClosing ( @NotNull final MapView< G, A, R > mapView)
 NoopMethodInAbstractClass More...
 
void mapViewCreated ( @NotNull final MapView< G, A, R > mapView)
 NoopMethodInAbstractClass More...
 

Protected Member Functions

void updateAction ()
 
- Protected Member Functions inherited from net.sf.gridarta.action.AbstractMapCursorAction< G, A, R >
MapCursor< G, A, R > getActiveMapCursor ()
 Return the map cursor of the current map view if it is active. More...
 
MapView< G, A, R > getActiveMapView ()
 Return the current map view. More...
 
abstract void updateAction ()
 Called whenever the current map cursor has changed. More...
 

Private Member Functions

boolean doGoLocation (final boolean performAction)
 Executes the "go location" action. More...
 

Private Attributes

Action action
 The Action associated with this editor action. More...
 
final AbstractPerMapDialogManager< G, A, R, GoLocationDialog< G, A, R > > goLocationDialogManager
 The AbstractPerMapDialogManager to track go location dialog instances. More...
 

Detailed Description

An EditorAction that openes the "go location" dialog.

Author
Andreas Kirschbaum

Definition at line 40 of file GoLocationAction.java.

Constructor & Destructor Documentation

◆ GoLocationAction()

net.sf.gridarta.action.GoLocationAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.GoLocationAction ( @NotNull final MapViewManager< G, A, R >  mapViewManager)

Creates a new instance.

Parameters
mapViewManagerthe map view manager

Definition at line 60 of file GoLocationAction.java.

Member Function Documentation

◆ doGoLocation()

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

◆ goLocation()

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

Opens the "go location" dialog.

Definition at line 73 of file GoLocationAction.java.

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

+ Here is the call graph for this function:

◆ setAction()

void net.sf.gridarta.action.GoLocationAction< 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
actionthe action instance
namethe name of the action

Implements net.sf.gridarta.utils.EditorAction.

Definition at line 65 of file GoLocationAction.java.

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

◆ updateAction()

void net.sf.gridarta.action.GoLocationAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateAction ( )
protected

Member Data Documentation

◆ action

Action net.sf.gridarta.action.GoLocationAction< 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 54 of file GoLocationAction.java.

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

◆ goLocationDialogManager

final AbstractPerMapDialogManager<G, A, R, GoLocationDialog<G, A, R> > net.sf.gridarta.action.GoLocationAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.goLocationDialogManager
private

The AbstractPerMapDialogManager to track go location dialog instances.

Definition at line 47 of file GoLocationAction.java.


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