ActionUtils.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 The Gridarta Developers.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package net.sf.gridarta.utils;
 
import javax.swing.Action;
import javax.swing.Icon;
import javax.swing.KeyStroke;
import net.sf.japi.swing.action.ActionBuilder;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class ActionUtils {
 
    @NotNull
    private static final String CATEGORY = "Category";
 
    @NotNull
    private static final String UNDEFINED_CATEGORY = "Other";
 
    @NotNull
    public static final String NO_SHORTCUT = "none";
 
    @NotNull
    public static final String DEFAULT_ACCELERATOR_KEY = "DefaultAcceleratorKey";
 
    private ActionUtils() {
    }
 
    @NotNull
    public static String getActionName(@NotNull final Action action) {
        final String name = getStringValue(action, Action.NAME);
        if (name != null && !name.isEmpty()) {
            return name;
        }
 
        final String shortDescription = getStringValue(action, Action.SHORT_DESCRIPTION);
        return shortDescription == null ? getActionId(action) : shortDescription;
    }
 
    @NotNull
    public static String getActionId(@NotNull final Action action) {
        final String id = getStringValue(action, ActionBuilder.ACTION_ID);
        if (id == null) {
            throw new IllegalArgumentException("action does not define an action ID: " + action);
        }
        return id;
    }
 
    @NotNull
    public static String getActionDescription(@NotNull final Action action) {
        final String longDescription = getStringValue(action, Action.LONG_DESCRIPTION);
        if (longDescription != null) {
            return longDescription;
        }
 
        final String shortDescription = getStringValue(action, Action.SHORT_DESCRIPTION);
        return shortDescription == null ? "" : shortDescription;
    }
 
    @Nullable
    public static KeyStroke getShortcut(@NotNull final Action action) {
        return getShortcut(action, Action.ACCELERATOR_KEY);
    }
 
    @Nullable
    public static KeyStroke getAlternativeShortcut(@NotNull final Action action) {
        return getShortcut(action, ActionBuilder.ACCELERATOR_KEY_2);
    }
 
    @Nullable
    private static KeyStroke getShortcut(@NotNull final Action action, @NotNull final String key) {
        final Object acceleratorKey = action.getValue(key);
        return acceleratorKey instanceof KeyStroke ? (KeyStroke) acceleratorKey : null;
    }
 
    public static void setActionShortcut(@NotNull final Action action, @Nullable final KeyStroke shortcut) {
        action.putValue(Action.ACCELERATOR_KEY, shortcut);
    }
 
    @NotNull
    public static String getShortcutDescription(@NotNull final Action action, @NotNull final String key) {
        final KeyStroke shortcut = getShortcut(action, key);
        return shortcut == null ? NO_SHORTCUT : shortcut.toString();
    }
 
    @Nullable
    public static Icon getActionIcon(@NotNull final Action action) {
        final Object icon = action.getValue(Action.SMALL_ICON);
        return icon instanceof Icon ? (Icon) icon : null;
    }
 
    @Nullable
    private static String getStringValue(@NotNull final Action action, @NotNull final String key) {
        final Object value = action.getValue(key);
        return value instanceof String ? (String) value : null;
 
    }
 
    @NotNull
    public static Action newAction(@NotNull final ActionBuilder actionBuilder, @NotNull final String category, @NotNull final EditorAction editorAction, @NotNull final String key) {
        final Action action = actionBuilder.createAction(true, key, editorAction);
        action.putValue(CATEGORY, category);
        editorAction.setAction(action, key);
        return action;
    }
 
    @NotNull
    public static Action newToggleAction(@NotNull final ActionBuilder actionBuilder, @NotNull final String category, @NotNull final EditorAction editorAction, @NotNull final String key) {
        final Action action = actionBuilder.createToggle(true, key, editorAction);
        action.putValue(CATEGORY, category);
        editorAction.setAction(action, key);
        return action;
    }
 
    @NotNull
    public static String getActionCategory(@NotNull final Action action) {
        final String category = getStringValue(action, CATEGORY);
        return category == null ? UNDEFINED_CATEGORY : category;
    }
 
}