bibliothek.gui.dock.action.actions.GroupedDropDownItemAction Maven / Gradle / Ivy

Go to download
/*
 * Bibliothek - DockingFrames
 * Library built on Java/Swing, allows the user to "drag and drop"
 * panels containing any Swing-Component the developer likes to add.
 * 
 * Copyright (C) 2007 Benjamin Sigg
 * 
 * This library 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 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Benjamin Sigg
 * [email protected]
 * CH - Switzerland
 */

package bibliothek.gui.dock.action.actions;

import bibliothek.gui.Dockable;
import bibliothek.gui.dock.action.DropDownAction;
import bibliothek.gui.dock.action.StandardDropDownItemAction;

/**
 * An action that can be shown as child of a {@link DropDownAction}.
 * @author Benjamin Sigg
 *
 * @param  the type of the keys used for groups
 * @param  the type of model used as group
 */
public abstract class GroupedDropDownItemAction extends GroupedDockAction implements StandardDropDownItemAction{    
    /**
     * Creates a new action.
     * @param generator the generator that will be used to get a key for 
     * Dockables which do not yet have a key. The generator can be null
     * and set later through the method {@link #setGenerator(GroupKeyGenerator)}
     */
    public GroupedDropDownItemAction( GroupKeyGenerator generator ){
    	super( generator );
    }
	
	public boolean isDropDownSelectable( Dockable dockable ){
		return getGroup( dockable ).isDropDownSelectable();
	}
	
	/**
	 * Tells whether the group key can be selected by a 
	 * {@link DropDownAction}.
	 * @param key the name of the group
	 * @return true if the group can be selected
	 */
	public boolean isDropDownSelectable( Object key ){
		return getGroup( key ).isDropDownSelectable();
	}
	
	/**
	 * Sets whether the group key can be selected by a 
	 * {@link DropDownAction}.
	 * @param key the name of the group
	 * @param selectable true if the group can be selected
	 */
	public void setDropDownSelectable( K key, boolean selectable ){
		ensureGroup( key ).setDropDownSelectable( selectable );
	}
	
	public boolean isDropDownTriggerable( Dockable dockable, boolean selected ){
		return getGroup( dockable ).isDropDownTriggerable( dockable, selected );
	}
	
	/**
	 * Tells whether the group key can be triggered by a 
	 * {@link DropDownAction}.
	 * @param key the name of the group
	 * @param selected true if the event will be on a 
	 * drop-down-button itself, false if the event is
	 * in the menu.
	 * @return true if the group can be triggered
	 */
	public boolean isDropDownTriggerable( Object key, boolean selected ){
		if( selected )
			return getGroup( key ).isDropDownTriggerableSelected();
		else
			return getGroup( key ).isDropDownTriggerableNotSelected();
	}

	/**
	 * Sets whether the group key can be triggered if the event
	 * occurs on a drop-down-button.
	 * @param key the name of the group
	 * @param triggerable true if the group can be triggered
	 */
	public void setDropDownTriggerableSelected( K key, boolean triggerable ){
		ensureGroup( key ).setDropDownTriggerableSelected( triggerable );
	}

	/**
	 * Sets whether the group key can be triggered if the event
	 * occurs in a menu.
	 * @param key the name of the group
	 * @param triggerable true if the group can be triggered
	 */
	public void setDropDownTriggerableNotSelected( K key, boolean triggerable ){
		ensureGroup( key ).setDropDownTriggerableNotSelected( triggerable );
	}
}