Manages edit type actions in "view" menu. More...

Inheritance diagram for net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Collaboration diagram for net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
void	init (@NotNull final Iterable< NamedGameObjectMatcher > gameObjectMatchers)
	Creates the view actions. More...

void	resetView ()
	Action method for "reset view". More...

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

void	setMenu (@Nullable final Container viewActionsMenu)
	Sets the menu to add the actions to. More...

	ViewActions (@NotNull final MapViewSettings mapViewSettings, @NotNull final MapManager< G, A, R > mapManager)
	Creates a new instance. More...

Private Member Functions
void	updateActions ()
	Updates the actions' state to the current edit mode. More...

Private Attributes
final MapManagerListener< G, A, R >	mapManagerListener
	The map manager listener which is attached to the current map if the current map is tracked. More...

final MapViewSettings	mapViewSettings
	The map view settings instance. More...

final MapViewSettingsListener	mapViewSettingsListener
	The MapViewSettingsListener attached to mapViewSettings to detect edit types changes. More...

final List< ViewAction >	viewActions = new LinkedList<>()
	The view actions. More...

Static Private Attributes
static final Comparator< ViewAction >	ACTION_NAME_COMPARATOR = (o1, o2) -> String.CASE_INSENSITIVE_ORDER.compare(o1.getName(), o2.getName())
	The comparator for sorting menu entries. More...

Detailed Description

Manages edit type actions in "view" menu.

Author: Andreas Kirschbaum

Definition at line 46 of file ViewActions.java.

Constructor & Destructor Documentation

◆ ViewActions()

net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ViewActions	(	@NotNull final MapViewSettings	mapViewSettings,
		@NotNull final MapManager< G, A, R >	mapManager
	)

Creates a new instance.

Parameters

mapViewSettings	the map view settings instance
mapManager	the map manager

Definition at line 143 of file ViewActions.java.

References net.sf.gridarta.model.mapviewsettings.MapViewSettings.addMapViewSettingsListener(), net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapManagerListener, net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewSettings, and net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewSettingsListener.

Here is the call graph for this function:

Member Function Documentation

◆ init()

void net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.init ( @NotNull final Iterable< NamedGameObjectMatcher > gameObjectMatchers )

Creates the view actions.

Parameters

gameObjectMatchers the game object matchers

Definition at line 159 of file ViewActions.java.

References net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewSettings, and net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.viewActions.

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

Here is the caller graph for this function:

◆ resetView()

void net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.resetView ( )

Action method for "reset view".

Definition at line 186 of file ViewActions.java.

References net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewSettings, and net.sf.gridarta.model.mapviewsettings.MapViewSettings.unsetEditType().

Here is the call graph for this function:

◆ setAction()

void net.sf.gridarta.gui.map.viewaction.ViewActions< 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 201 of file ViewActions.java.

◆ setMenu()

void net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setMenu ( @Nullable final Container viewActionsMenu )

Sets the menu to add the actions to.

Parameters

viewActionsMenu the menu

Definition at line 169 of file ViewActions.java.

References net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ACTION_NAME_COMPARATOR, and net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.viewActions.

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

Here is the caller graph for this function:

◆ updateActions()

void net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateActions ( )

private

Updates the actions' state to the current edit mode.

Definition at line 194 of file ViewActions.java.

References net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.viewActions.

Member Data Documentation

◆ ACTION_NAME_COMPARATOR

final Comparator<ViewAction> net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ACTION_NAME_COMPARATOR = (o1, o2) -> String.CASE_INSENSITIVE_ORDER.compare(o1.getName(), o2.getName())

staticprivate

The comparator for sorting menu entries.

Definition at line 153 of file ViewActions.java.

Referenced by net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setMenu().

◆ mapManagerListener

final MapManagerListener<G, A, R> net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapManagerListener

private

Initial value:

= new MapManagerListener<G, A, R>() {
 
        @Override
        public void currentMapChanged(@Nullable final MapControl<G, A, R> mapControl) {
            updateActions();
        }
 
        @Override
        public void mapCreated(@NotNull final MapControl<G, A, R> mapControl, final boolean interactive) {
            
        }
 
        @Override
        public void mapClosing(@NotNull final MapControl<G, A, R> mapControl) {
            
        }
 
        @Override
        public void mapClosed(@NotNull final MapControl<G, A, R> mapControl) {
            
        }
 
    }

The map manager listener which is attached to the current map if the current map is tracked.

Otherwise it is unused.

Definition at line 65 of file ViewActions.java.

Referenced by net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ViewActions().

◆ mapViewSettings

final MapViewSettings net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewSettings

private

The map view settings instance.

Definition at line 52 of file ViewActions.java.

Referenced by net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.init(), net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.resetView(), and net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ViewActions().

◆ mapViewSettingsListener

final MapViewSettingsListener net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewSettingsListener

private

The MapViewSettingsListener attached to mapViewSettings to detect edit types changes.

Definition at line 94 of file ViewActions.java.

Referenced by net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ViewActions().

◆ viewActions

final List<ViewAction> net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.viewActions = new LinkedList<>()

private

The view actions.

Definition at line 58 of file ViewActions.java.

Referenced by net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.init(), net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setMenu(), and net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateActions().

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

src/gridarta/src/main/java/net/sf/gridarta/gui/map/viewaction/ViewActions.java

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ViewActions()

Member Function Documentation

◆ init()

◆ resetView()

◆ setAction()

◆ setMenu()

◆ updateActions()

Member Data Documentation

◆ ACTION_NAME_COMPARATOR

◆ mapManagerListener

◆ mapViewSettings

◆ mapViewSettingsListener

◆ viewActions