Manager for shortcuts of all Actions in an {} instance. More...

Inheritance diagram for net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager:

Collaboration diagram for net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager:

Public Member Functions
Iterator< Action >	iterator ()
	Returns all Actions. More...

void	loadShortcuts ()
	Restores all shortcuts from the preferences. More...

void	revertAll ()
	Reverts all shortcuts to their default values. More...

void	saveShortcuts ()
	Saves all shortcuts to the preferences. More...

	ShortcutsManager (@NotNull final ActionBuilder actionBuilder)
	Creates a new instance. More...

void	showShortcutsDialog (@NotNull final Component parentComponent)
	Displays a dialog to edit shortcuts. More...

Private Member Functions
boolean	isValidAction (@NotNull final Action action)
	Returns whether an Action is a global action. More...

Private Attributes
final ActionBuilder	actionBuilder
	The managed ActionBuilder. More...

final Collection< String >	ignoreActions = new HashSet<>()
	The action names to hide. More...

final Preferences	preferences = Preferences.userNodeForPackage(MainControl.class)
	The Preferences for storing/restoring shortcuts. More...

Static Private Attributes
static final Comparator< Action >	ACTION_COMPARATOR = (o1, o2) -> ActionUtils.getActionName(o1).compareToIgnoreCase(ActionUtils.getActionName(o2))
	A Comparator that compares Actions by name. More...

static final String	PREFERENCES_COMMENT_PREFIX = "prefs." + PREFERENCES_SHORTCUT_PREFIX
	The prefix for preferences keys for shortcut comments. More...

static final String	PREFERENCES_SHORTCUT_PREFIX = "shortcut."
	The prefix for preferences keys for shortcuts. More...

Detailed Description

Manager for shortcuts of all Actions in an {} instance.

Author: Andreas Kirschbaum

Definition at line 50 of file ShortcutsManager.java.

Constructor & Destructor Documentation

◆ ShortcutsManager()

net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.ShortcutsManager ( @NotNull final ActionBuilder actionBuilder )

Creates a new instance.

Parameters

actionBuilder the action builder to manage

Definition at line 92 of file ShortcutsManager.java.

References net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.actionBuilder.

Member Function Documentation

◆ isValidAction()

boolean net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.isValidAction ( @NotNull final Action action )

private

Returns whether an Action is a global action.

Parameters

action the action to check

Returns: whether the action is valid

Definition at line 255 of file ShortcutsManager.java.

References net.sf.gridarta.utils.ActionUtils.getActionId(), and net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.ignoreActions.

Referenced by net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.iterator(), and net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.loadShortcuts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ iterator()

Iterator<Action> net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.iterator ( )

Returns all Actions.

Returns: an iterator returning the actions

Definition at line 234 of file ShortcutsManager.java.

References net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.ACTION_COMPARATOR, net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.actionBuilder, and net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.isValidAction().

Here is the call graph for this function:

◆ loadShortcuts()

void net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.loadShortcuts ( )

Restores all shortcuts from the preferences.

Definition at line 99 of file ShortcutsManager.java.

References net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.actionBuilder, net.sf.gridarta.utils.ActionUtils.DEFAULT_ACCELERATOR_KEY, net.sf.gridarta.utils.ActionUtils.getActionId(), net.sf.gridarta.utils.ActionUtils.getActionName(), net.sf.gridarta.utils.ActionBuilderUtils.getString(), net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.ignoreActions, net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.isValidAction(), name, net.sf.gridarta.utils.ActionUtils.NO_SHORTCUT, net.sf.gridarta.utils.StringUtils.PATTERN_SPACES, net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.preferences, net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.PREFERENCES_COMMENT_PREFIX, and net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.PREFERENCES_SHORTCUT_PREFIX.

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 call graph for this function:

Here is the caller graph for this function:

◆ revertAll()

void net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.revertAll ( )

Reverts all shortcuts to their default values.

Definition at line 223 of file ShortcutsManager.java.

References net.sf.gridarta.utils.ActionUtils.DEFAULT_ACCELERATOR_KEY.

Referenced by net.sf.gridarta.gui.dialog.shortcuts.ShortcutsDialog.shortcutsDefaults().

Here is the caller graph for this function:

◆ saveShortcuts()

void net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.saveShortcuts ( )

Saves all shortcuts to the preferences.

Definition at line 188 of file ShortcutsManager.java.

References net.sf.gridarta.utils.ActionUtils.DEFAULT_ACCELERATOR_KEY, net.sf.gridarta.utils.ActionUtils.getActionId(), net.sf.gridarta.utils.ActionUtils.getShortcutDescription(), net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.preferences, and net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.PREFERENCES_SHORTCUT_PREFIX.

Referenced by net.sf.gridarta.gui.dialog.shortcuts.ShortcutsDialog.shortcutsDefaults(), net.sf.gridarta.gui.dialog.shortcuts.ShortcutsDialog.shortcutsSetShortcut(), and net.sf.gridarta.gui.dialog.shortcuts.ShortcutsDialog.shortcutsUnsetShortcut().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showShortcutsDialog()

void net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.showShortcutsDialog ( @NotNull final Component parentComponent )

Displays a dialog to edit shortcuts.

Parameters

parentComponent the parent component for the dialog

Definition at line 215 of file ShortcutsManager.java.

References net.sf.gridarta.gui.dialog.shortcuts.ShortcutsDialog.showDialog().

Referenced by net.sf.gridarta.action.ShortcutsAction.shortcuts().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ ACTION_COMPARATOR

final Comparator<Action> net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.ACTION_COMPARATOR = (o1, o2) -> ActionUtils.getActionName(o1).compareToIgnoreCase(ActionUtils.getActionName(o2))

staticprivate

A Comparator that compares Actions by name.

Definition at line 74 of file ShortcutsManager.java.

Referenced by net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.iterator().

◆ actionBuilder

final ActionBuilder net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.actionBuilder

private

The managed ActionBuilder.

Definition at line 80 of file ShortcutsManager.java.

Referenced by net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.iterator(), net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.loadShortcuts(), and net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.ShortcutsManager().

◆ ignoreActions

final Collection<String> net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.ignoreActions = new HashSet<>()

private

The action names to hide.

Definition at line 68 of file ShortcutsManager.java.

Referenced by net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.isValidAction(), and net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.loadShortcuts().

◆ preferences

final Preferences net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.preferences = Preferences.userNodeForPackage(MainControl.class)

private

The Preferences for storing/restoring shortcuts.

Definition at line 86 of file ShortcutsManager.java.

Referenced by net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.loadShortcuts(), and net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.saveShortcuts().

◆ PREFERENCES_COMMENT_PREFIX

final String net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.PREFERENCES_COMMENT_PREFIX = "prefs." + PREFERENCES_SHORTCUT_PREFIX

staticprivate

The prefix for preferences keys for shortcut comments.

Definition at line 62 of file ShortcutsManager.java.

Referenced by net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.loadShortcuts().

◆ PREFERENCES_SHORTCUT_PREFIX

final String net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.PREFERENCES_SHORTCUT_PREFIX = "shortcut."

staticprivate

The prefix for preferences keys for shortcuts.

Definition at line 56 of file ShortcutsManager.java.

Referenced by net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.loadShortcuts(), and net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.saveShortcuts().

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

src/gridarta/src/main/java/net/sf/gridarta/gui/dialog/shortcuts/ShortcutsManager.java

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ShortcutsManager()

Member Function Documentation

◆ isValidAction()

◆ iterator()

◆ loadShortcuts()

◆ revertAll()

◆ saveShortcuts()

◆ showShortcutsDialog()

Member Data Documentation

◆ ACTION_COMPARATOR

◆ actionBuilder

◆ ignoreActions

◆ preferences

◆ PREFERENCES_COMMENT_PREFIX

◆ PREFERENCES_SHORTCUT_PREFIX