bibliothek.gui.dock.station.screen.ScreenToolbarInserter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of docking-frames-ext-toolbar Show documentation
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) 2012 Herve Guillaume, 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
 * 
 * Herve Guillaume
 * [email protected]
 * FR - France
 *
 * Benjamin Sigg
 * [email protected]
 * CH - Switzerland
 */

package bibliothek.gui.dock.station.screen;

import java.awt.Dimension;

import bibliothek.gui.DockController;
import bibliothek.gui.DockStation;
import bibliothek.gui.Dockable;
import bibliothek.gui.Orientation;
import bibliothek.gui.dock.ScreenDockStation;
import bibliothek.gui.dock.control.relocator.Inserter;
import bibliothek.gui.dock.control.relocator.InserterSource;
import bibliothek.gui.dock.displayer.DisplayerCombinerTarget;
import bibliothek.gui.dock.station.OrientedDockStation;
import bibliothek.gui.dock.station.OrientingDockStation;
import bibliothek.gui.dock.station.StationDropOperation;
import bibliothek.gui.dock.station.support.CombinerTarget;
import bibliothek.gui.dock.station.toolbar.ToolbarStrategy;

/**
 * This {@link Inserter} searches for toolbars using the {@link ToolbarStrategy}
 * , and adds them to {@link ScreenDockStation}s, creating any additional layers
 * that are required for the operation.
 * 
 * @author Benjamin Sigg
 */
public class ScreenToolbarInserter implements Inserter {
	private final DockController controller;

	/**
	 * Creates a new inserter
	 * 
	 * @param controller
	 *            the controller in whose realm this inserter will be used
	 */
	public ScreenToolbarInserter( DockController controller ){
		this.controller = controller;
	}

	@Override
	public StationDropOperation before( InserterSource source ){
		return null;
	}

	/**
	 * Gets the {@link ToolbarStrategy} that is currently in use.
	 * 
	 * @return the current strategy
	 */
	protected ToolbarStrategy getStrategy(){
		return controller.getProperties().get( ToolbarStrategy.STRATEGY );
	}

	@Override
	public StationDropOperation after( InserterSource source ){
		if( (source.getOperation() != null) || !(source.getParent() instanceof ScreenDockStation) ) {
			return null;
		}
		final ToolbarStrategy strategy = getStrategy();
		Dockable child = source.getItem().getDockable();
		
		if( !strategy.isToolbarPart( child ) ) {
			return null;
		}

		if( source.getParent().accept( child ) && child.accept( source.getParent() ) ) {
			// if a DockAcceptance does not allow the combination, while the
			// involved elements do, we better
			// assume the DockAcceptance has a good reason.
			return null;
		}

		return new Operation( source );
	}

	/**
	 * Called if the toolbar item defined by source has to be put
	 * onto the {@link ScreenDockStation} defined by source.
	 * 
	 * @param source
	 *            all the information about the operation
	 * @param orientation
	 *            the preferred orientation of the new window, might be
	 *            null
	 */
	protected void execute( InserterSource source, Orientation orientation ){
		final ToolbarStrategy strategy = getStrategy();
		
		Dockable child = source.getItem().getDockable();
		final Dockable item = strategy.ensureToolbarLayer( source.getParent(), child );
		if( item != child ){
			item.setController( controller );
			item.asDockStation().drop( child );
			item.setController( null );
		}
		
		if( (orientation != null) && (item.asDockStation() instanceof OrientedDockStation) ) {
			((OrientedDockStation) item).setOrientation( orientation );
		}

		final ScreenDockStation station = (ScreenDockStation) source.getParent();

		item.getComponent().validate();
		final Dimension size = item.getComponent().getPreferredSize();

		final ScreenDockProperty location = new ScreenDockProperty( source.getItem().getTitleX(), source.getItem().getTitleY(), size.width, size.height );
		station.drop( item, location, false );
	}

	/**
	 * This {@link StationDropOperation} will add a toolbar part to a
	 * {@link ScreenDockStation} using
	 * {@link ToolbarStrategy#ensureToolbarLayer(DockStation, Dockable)}
	 * 
	 * @author Benjamin Sigg
	 */
	private class Operation implements StationDropOperation {
		private final InserterSource source;
		private Orientation orientation;

		/**
		 * Creates a new operation
		 * 
		 * @param source
		 *            information about the operation that is going to happen
		 */
		public Operation( InserterSource source ){
			this.source = source;

			final Dockable dockable = source.getItem().getDockable();
			final DockStation parent = dockable.getDockParent();

			orientation = null;
			if( parent instanceof OrientingDockStation ) {
				orientation = ((OrientingDockStation) parent).getOrientationOf( dockable );
			}
			else if( dockable.asDockStation() instanceof OrientedDockStation ) {
				orientation = ((OrientedDockStation) dockable.asDockStation()).getOrientation();
			}
		}

		@Override
		public void draw(){
			// nothing to do
		}

		@Override
		public void destroy( StationDropOperation next ){
			// nothing to do
		}

		@Override
		public boolean isMove(){
			return false;
		}

		@Override
		public void execute(){
			ScreenToolbarInserter.this.execute( source, orientation );
		}

		@Override
		public DockStation getTarget(){
			return source.getParent();
		}

		@Override
		public Dockable getItem(){
			return source.getItem().getDockable();
		}

		@Override
		public CombinerTarget getCombination(){
			return null;
		}

		@Override
		public DisplayerCombinerTarget getDisplayerCombination(){
			return null;
		}

	}
}