bibliothek.gui.dock.title.DockTitleRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of docking-frames-core Show documentation
A window docking framework for Swing
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) 2008 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.title;

import bibliothek.gui.DockStation;
import bibliothek.gui.Dockable;
import bibliothek.gui.dock.util.ResourceRequest;

/**
 * Set of information and callback used to obtain a {@link DockTitle}
 * from a {@link DockTitleFactory}. 
 * @author Benjamin Sigg
 *
 */
public abstract class DockTitleRequest extends ResourceRequest{
	/** the element for which the title is shown */
	private Dockable target;
	/** the element that shows the title */
	private DockStation parent;
	/** the kind of title that is requested */
	private DockTitleVersion version;
	
	
	/** whether this request is installed on its {@link #version} */
	private boolean installed = false;
	
	/**
	 * Creates a new request.
	 * @param parent the element which will show the title, can be null
	 * @param target the element for which the title will be shown, not null
	 * @param version what kind of title is requested, not null
	 */
	public DockTitleRequest( DockStation parent, Dockable target, DockTitleVersion version ){
		if( target == null ){
			throw new IllegalArgumentException( "target must not be null" );
		}
		if( version == null ){
			throw new IllegalArgumentException( "version must not be null" );
		}
		
		this.target = target;
		this.parent = parent;
		this.version = version;
	}
	
	@Override
	public void request(){
		super.request();
	}
	
	/**
	 * Makes this request active. After installation the method {@link ResourceRequest#answer(Object,Object)} may
	 * be called anytimes. Please note that installing does not automatically trigger a call
	 * to {@link #request()}.
	 */
	public void install(){
		if( !installed ){
			installed = true;
			version.install( this );
		}
	}
	
	/**
	 * Makes this request inactive, calls to {@link ResourceRequest#answer(Object, Object)} will no longer happen.
	 */
	public void uninstall(){
		if( installed ){
			installed = false;
			version.uninstall( this );
		}
	}
	
	/**
	 * Tells whether this request is currently installed on its {@link #getVersion() version}.
	 * @return true if this request is active
	 */
	public boolean isInstalled(){
		return installed;
	}
	
	/**
	 * Gets the {@link Dockable} for which the title is requested.
	 * @return the target element
	 */
	public Dockable getTarget(){
		return target;
	}
	
	/**
	 * Gets the station that will show the title. The result might be null
	 * if the title is shown outside any station.
	 * @return the parent of {@link #getTarget()} or null
	 */
	public DockStation getParent(){
		return parent;
	}
	
	/**
	 * Gets the usage of the new title.
	 * @return the usage, not null
	 */
	public DockTitleVersion getVersion(){
		return version;
	}
	
	/**
	 * Asks all sources for a {@link DockTitle}, stops as soon
	 * as one source called {@link #answer(DockTitle)}.  
	 */
	protected void executeRequestList(){
		requestDockTitle( this );
		if( isAnswered() )
			return;
		
		target.requestDockTitle( this );
		if( isAnswered() )
			return;
		
		if( parent != null ){
			parent.requestChildDockTitle( this );
			if( isAnswered() )
				return;
		}
		
		version.request( this );
	}
	
	/**
	 * May answer a request for a title. Normally request
	 * will be this, but subclasses may forward the request
	 * to other {@link DockTitleRequest}. The default behavior of this
	 * method is to do nothing.
	 * @param request the request to answer
	 */
	public void requestDockTitle( DockTitleRequest request ){
		// ignore
	}
	
	/**
	 * Informs this request that title should be shown. This method
	 * can be called more than once to show different titles.

	 * An answer must fulfill some rules:
	 * 
     *  The {@link #getTarget() target} of this request must be the same {@link Dockable} as {@link DockTitle#getDockable()} .
     *  The {@link #getVersion() version} must match the {@link DockTitle#getOrigin() origin} of the title.
     *  The title must not be bound
     *  The client must call the {@link Dockable#bind(DockTitle)}-method of the target {@link Dockable}
     *  before using the title. Note that a client must not call the
     *  bind-method of {@link DockTitle}
     *  The client must call the {@link Dockable#unbind(DockTitle)}-method when he no
     *  longer needs the title. Note that the client must not call the
     *  unbind-method of {@link DockTitle}
     * 
	 * 
	 * @param title the new title or null to show no title at all
	 * @throws IllegalArgumentException if the title does not met the specifications described above
	 * @throws IllegalStateException if {@link #request()} is not currently executing
	 */
	@Override
	public void answer( DockTitle title ){
		super.answer( title );
	}
	
	@Override
	protected void validate( DockTitle resource ){
		if( resource != null ){
			if( resource.getDockable() != getTarget() ){	
				throw new IllegalArgumentException( "title.getDockable() does not return target");
			}
			if( resource.getOrigin() != getVersion() ){
				throw new IllegalArgumentException( "title.getOrigin() does not return version" );
			}
		}
	}
}