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

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

Collaboration diagram for net.sf.gridarta.action.ShrinkSelectionAction< 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)
void	mapViewClosing (@NotNull final MapView< G, A, R > mapView)
void	mapViewCreated (@NotNull final MapView< G, A, R > mapView)
void	setAction (@NotNull final Action action, @NotNull final String name)
void	shrinkSelection ()

Private Member Functions
boolean	doShrinkSelection (final boolean performAction)
void	updateAction ()

Private Attributes
Action	action
MapView< G, A, R >	currentMapView
final MapGridListener	mapGridListener

Detailed Description

An EditorAction that shrinks the current selection by one map square.

Author

Andreas Kirschbaum

Definition at line 48 of file ShrinkSelectionAction.java.

Member Function Documentation

activeMapViewChanged()

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

References net.sf.gridarta.model.mapgrid.MapGrid.addMapGridListener(), net.sf.gridarta.action.ShrinkSelectionAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.currentMapView, net.sf.gridarta.gui.map.mapview.MapView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapGrid(), net.sf.gridarta.action.ShrinkSelectionAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapGridListener, net.sf.gridarta.model.mapgrid.MapGrid.removeMapGridListener(), and net.sf.gridarta.action.ShrinkSelectionAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateAction().

Here is the call graph for this function:

doShrinkSelection()

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

private

Shrinks the current map selection by one map square.

Parameters

performAction

whether the action should be performed

Returns

whether the action was or can be performed

Definition at line 109 of file ShrinkSelectionAction.java.

References net.sf.gridarta.model.mapgrid.MapGrid.beginTransaction(), net.sf.gridarta.action.ShrinkSelectionAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.currentMapView, net.sf.gridarta.model.mapgrid.MapGrid.endTransaction(), net.sf.gridarta.model.mapgrid.MapGrid.getFlags(), net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapArchObject(), net.sf.gridarta.gui.map.mapview.MapView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapControl(), net.sf.gridarta.gui.map.mapview.MapView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapGrid(), net.sf.gridarta.model.mapcontrol.MapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapModel(), net.sf.gridarta.model.mapgrid.MapGrid.getSelectedRec(), net.sf.gridarta.gui.map.mapview.MapView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getSelectedSquares(), net.sf.gridarta.model.mapgrid.MapGrid.GRID_FLAG_SELECTION, net.sf.gridarta.model.maparchobject.MapArchObject< A extends MapArchObject< A >.isPointValid(), net.sf.gridarta.model.mapgrid.MapGrid.select(), and net.sf.gridarta.model.mapgrid.SelectionMode.SUB.

Referenced by net.sf.gridarta.action.ShrinkSelectionAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.shrinkSelection(), and net.sf.gridarta.action.ShrinkSelectionAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateAction().

Here is the call graph for this function:

Here is the caller graph for this function:

mapViewClosing()

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

mapViewCreated()

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

setAction()

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

References net.sf.gridarta.action.ShrinkSelectionAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.action, and net.sf.gridarta.action.ShrinkSelectionAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateAction().

Here is the call graph for this function:

shrinkSelection()

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

(

)

Grows the current map selection by one map square.

Definition at line 85 of file ShrinkSelectionAction.java.

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

Here is the call graph for this function:

updateAction()

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

private

Updates the action's enabled state.

Definition at line 98 of file ShrinkSelectionAction.java.

References net.sf.gridarta.action.ShrinkSelectionAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.action, and net.sf.gridarta.action.ShrinkSelectionAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doShrinkSelection().

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

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.ShrinkSelectionAction< 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 61 of file ShrinkSelectionAction.java.

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

currentMapView

MapView<G, A, R> net.sf.gridarta.action.ShrinkSelectionAction< 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 54 of file ShrinkSelectionAction.java.

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

mapGridListener

final MapGridListener net.sf.gridarta.action.ShrinkSelectionAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapGridListener

private

Initial value:

= new MapGridListener() {
 
        @Override
        public void mapGridChanged(@NotNull final MapGridEvent e) {
            updateAction();
        }
 
        @Override
        public void mapGridResized(@NotNull final MapGridEvent e) {
            updateAction();
        }
 
    }

The MapGridListener attached to currentMapView.

Definition at line 67 of file ShrinkSelectionAction.java.

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

---

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

• src/gridarta/src/main/java/net/sf/gridarta/action/ShrinkSelectionAction.java