/*
 * 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) 2010 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
 * benjamin_sigg@gmx.ch
 * CH - Switzerland
 */
package bibliothek.gui.dock.common.mode;

import bibliothek.gui.DockStation;
import bibliothek.gui.Dockable;
import bibliothek.gui.dock.common.CControl;
import bibliothek.gui.dock.common.CLocation;
import bibliothek.gui.dock.common.CStation;
import bibliothek.gui.dock.common.CStationContainer;
import bibliothek.gui.dock.common.action.predefined.CMaximizeAction;
import bibliothek.gui.dock.common.intern.CDockable;
import bibliothek.gui.dock.common.perspective.mode.CMaximizedModePerspective;
import bibliothek.gui.dock.common.perspective.mode.LocationModePerspective;
import bibliothek.gui.dock.facile.mode.Location;
import bibliothek.gui.dock.facile.mode.MaximizedMode;
import bibliothek.gui.dock.facile.mode.MaximizedModeArea;

/**
 * Manages {@link CMaximizedModeArea}s.
 * @author Benjamin Sigg
 */
public class CMaximizedMode extends MaximizedMode<CMaximizedModeArea> implements CLocationMode {
	/** the control in whose realm this mode is working */
	private CControl control;
	
	/**
	 * Creates a new mode.
	 * @param control the control in whose realm this mode works.
	 */
	public CMaximizedMode( CControl control ){
		this.control = control;
		setActionProvider( new KeyedLocationModeActionProvider(
				CDockable.ACTION_KEY_MAXIMIZE,
				new CMaximizeAction( control )) );
	}
	
	public CLocation getCLocation( Dockable dockable ){
		CMaximizedModeArea area = get( dockable );
		if( area == null )
			return null;
			
		return area.getCLocation( dockable );
	}
	
	public CLocation getCLocation( Dockable dockable, Location location ){
		CModeArea area = get( location.getRoot() );
		if( area == null )
			return null;
			
		return area.getCLocation( dockable, location );
	}
	
	public boolean isBasicMode(){
		return false;
	}
	
	public boolean respectWorkingAreas( DockStation station ){
		CModeArea area = get( station );
		if( area == null ){
			return true;
		}
		return area.respectWorkingAreas();
	}
	
	public LocationModePerspective createPerspective(){
		return new CMaximizedModePerspective();
	}
	
	@Override
	public MaximizedModeArea getMaximizeArea( Dockable dockable, Location history ){
		MaximizedModeArea area = super.getMaximizeArea( dockable, history );
		if( area == null ){
			DockStation parent = dockable.getDockParent();
			while( parent != null ){
				CStation<?> station = control.getStation( parent );
				if( station != null ){
					CStationContainer container = control.getRegister().getContainer( station );
					if( container != null ){
						CStation<? extends DockStation> result = container.getDefaultStation( ExtendedMode.MAXIMIZED );
						if( result != null ){
							return getMaximizeArea( result.getStation() );
						}
					}
				}
				Dockable temp = parent.asDockable();
				if( temp == null ){
					parent = null;
				}
				else{
					parent = temp.getDockParent();
				}
			}
		}
		return area;
	}
}