org.jfree.ui.action.ActionConcentrator 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, ActionConcentrator.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 javax.swing.Action;

/**
 * This class is used to collect actions to be enabled or disabled
 * by a sinle call.
 * 
 * @author Thomas Morgner
 */
public class ActionConcentrator {

    /** The collection used to store the actions of this concentrator. */
    private final ArrayList actions;

    /**
     * DefaultConstructor.
     */
    public ActionConcentrator() {
        this.actions = new ArrayList();
    }

    /**
     * Adds the action to this concentrator.
     * 
     * @param a the action to be added.
     */
    public void addAction(final Action a) {
        if (a == null) {
            throw new NullPointerException();
        }
        this.actions.add(a);
    }

    /**
     * Removes the action from this concentrator.
     * 
     * @param a the action to be removed.
     */
    public void removeAction(final Action a) {
        if (a == null) {
            throw new NullPointerException();
        }
        this.actions.remove(a);
    }

    /**
     * Defines the state for all actions. 
     * 
     * @param b the new state for all actions.
     */
    public void setEnabled(final boolean b) {
        for (int i = 0; i < this.actions.size(); i++) {
            final Action a = (Action) this.actions.get(i);
            a.setEnabled(b);
        }
    }

    /**
     * Returns, whether all actions are disabled.
     * If one action is enabled, then this method will return
     * true.
     * 
     * @return true, if at least one action is enabled, false
     * otherwise.
     */
    public boolean isEnabled() {
        for (int i = 0; i < this.actions.size(); i++) {
            final Action a = (Action) this.actions.get(i);
            if (a.isEnabled()) {
                return true;
            }
        }
        return false;
    }
    
}