org.jfree.ui.action.DowngradeActionMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jtstand-common Show documentation
jtstand-common is a library derived from jcommon, used by jtstand-chart, which is derived from jfreechart
There is a newer version: 1.5.9
/*
 * Copyright (c) 2009 Albert Kurucz. 
 *
 * This file, DowngradeActionMap.java is part of JTStand.
 *
 * JTStand is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JTStand 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with GTStand.  If not, see .
 */

package org.jfree.ui.action;

import java.util.ArrayList;
import java.util.HashMap;
import javax.swing.Action;

/**
 * An actionmap, which is JDK 1.2.2 compatible.
 * 
 * This implementation does not implement the ActionMap interface of
 * JDK 1.3 or higher to maintain the compatibility with JDK 1.2 which
 * does not know this interface.
 * 

 * The usage is still the same.
 *
 * @author Thomas Morger
 */
public class DowngradeActionMap {

    /** A map containing the key to action mapping. */
    private final HashMap actionMap;
  
    /** A list containing the actionkeys in their order of addition. */
    private final ArrayList actionList;
  
    /** The parent of this action map. */
    private DowngradeActionMap parent;

    /**
     * Default Constructor. Creates a new empty map.
     */
    public DowngradeActionMap() {
        this.actionMap = new HashMap();
        this.actionList = new ArrayList();
    }

    /**
     * Sets this ActionMap's parent.
     *
     * @param map  the ActionMap that is the parent of this one
     */
    public void setParent(final DowngradeActionMap map) {
        this.parent = map;
    }

    /**
     * Returns this ActionMap's parent.
     *
     * @return the ActionMap that is the parent of this one,
     *         or null if this ActionMap has no parent
     */
    public DowngradeActionMap getParent() {
        return this.parent;
    }

    /**
     * Adds a binding for key to action.
     * If action is null, this removes the current binding
     * for key.
     * In most instances, key will be
     * action.getValue(NAME).
     *
     * @param key the key for the action.
     * @param action the action to be added.
     */
    public void put(final Object key, final Action action) {
        if (action == null) {
            remove(key);
        }
        else {
           if (this.actionMap.containsKey(key)) {
               remove(key);
           }
           this.actionMap.put(key, action);
           this.actionList.add (key);
        }
    }

    /**
     * Returns the binding for key, messaging the
     * parent ActionMap if the binding is not locally defined.
     *
     * @param key the key to be queried.
     * @return the action for this key, or null if there is no such action.
     */
    public Action get(final Object key) {
        final Action retval = (Action) this.actionMap.get(key);
        if (retval != null) {
            return retval;
        }
        if (this.parent != null) {
            return this.parent.get(key);
        }
        return null;
    }

    /**
     * Removes the binding for key from this ActionMap.
     *
     * @param key the key to be removed.
     */
    public void remove(final Object key) {
        this.actionMap.remove(key);
        this.actionList.remove(key);
    }

    /**
     * Removes all the mappings from this ActionMap.
     */
    public void clear() {
        this.actionMap.clear();
        this.actionList.clear();
    }

    /**
     * Returns the Action names that are bound in this ActionMap.
     *
     * @return the keys which are directly bound to this map.
     */
    public Object[] keys() {
        return this.actionList.toArray();
    }

    /**
     * Returns the number of bindings.
     *
     * @return the number of entries in this map.
     */
    public int size() {
        return this.actionMap.size();
    }

    /**
     * Returns an array of the keys defined in this ActionMap and
     * its parent. This method differs from keys() in that
     * this method includes the keys defined in the parent.
     *
     * @return all keys of this map and all parents.
     */
    public Object[] allKeys() {
        if (this.parent == null) {
            return keys();
        }
        final Object[] parentKeys = this.parent.allKeys();
        final Object[] key = keys();
        final Object[] retval = new Object[parentKeys.length + key.length];
        System.arraycopy(key, 0, retval, 0, key.length);
        System.arraycopy(retval, 0, retval, key.length, retval.length);
        return retval;
    }

}