bibliothek.gui.dock.action.AbstractDockActionSource Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of docking-frames-core Show documentation
${project.name} is base or core library
The newest version!
/*
 * 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;

import java.util.ArrayList;
import java.util.List;

import bibliothek.gui.dock.event.DockActionSourceListener;

/**
 * A simple implementation of {@link DockActionSource} that just handles
 * the {@link DockActionSourceListener listeners} for sources.
 * @author Benjamin Sigg
 */
public abstract class AbstractDockActionSource implements DockActionSource {
    /**
     * The listeners which are registered on this source
     */
    protected List listeners = new ArrayList();
    
    public void addDockActionSourceListener( DockActionSourceListener listener ) {
        listeners.add( listener );
    }

    public void removeDockActionSourceListener( DockActionSourceListener listener ) {
        listeners.remove( listener );
    }

    /**
     * Checks whether this {@link DockActionSource} has at least one registered {@link DockActionSourceListener}.
     * @return whether at least one listener is registered
     */
    public boolean hasListeners(){
    	return listeners.size() > 0;
    }
    
    /**
     * Invokes the {@link DockActionSourceListener#actionsAdded(DockActionSource, int, int) actionsAdded}-method
     * on all registered {@link DockActionSourceListener DockActionSourceListeners}.
     * @param firstIndex The index of the first action that was added
     * @param lastIndex The index of the last action that was added
     */
    protected void fireAdded( int firstIndex, int lastIndex ){
        for( DockActionSourceListener listener : listeners.toArray( new DockActionSourceListener[ listeners.size() ] ))
            listener.actionsAdded( this, firstIndex, lastIndex );
    }
    
    /**
     * Invokes the {@link DockActionSourceListener#actionsRemoved(DockActionSource, int, int) actionRemoved}-method
     * on all registered {@link DockActionSourceListener DockActionSourceListeners}.
     * @param firstIndex The old index of the first action that was removed
     * @param lastIndex The old index of the last action that was removed
     */
    protected void fireRemoved( int firstIndex, int lastIndex ){
        for( DockActionSourceListener listener : listeners.toArray( new DockActionSourceListener[ listeners.size() ] ))
            listener.actionsRemoved( this, firstIndex, lastIndex );
    }
    
    /**
     * Gets the index of the given {@link DockAction action}
     * @param action The action to search in this source
     * @return The index of the action, -1 if the action was not found
     */
	public int indexOf( DockAction action ){
		int count = 0;
		for( DockAction check : this ){
			if( check == action )
				return count;
			
			count++;
		}
		
		return -1;
	}
}