bibliothek.gui.dock.station.screen.BoundaryRestriction 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) 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.station.screen;

import java.awt.Rectangle;

import bibliothek.gui.dock.station.screen.window.ScreenDockDialog;

/**
 * Restricts the boundaries of a {@link ScreenDockDialog}, a restriction might be,
 * that the dialog can't be placed outside the screen.
 * @author Benjamin Sigg
 */
public interface BoundaryRestriction {
    /** A restriction that allows all boundaries. */
    public BoundaryRestriction FREE = new AbstractBoundaryRestriction(){
    	@Override
    	protected Rectangle checkSize( ScreenDockWindow window ){
    		return null;
    	}
        @Override
        protected Rectangle checkSize( ScreenDockWindow window, Rectangle target ){
        	return null;
        }
    };
    
    /**
     * A restriction that will ensure that the title of a dialog cannot be moved
     * away from the screens.
     */
    public BoundaryRestriction MEDIUM = new MediumBoundaryRestriction();
    
    /** 
     * A restriction that will ensure that every dialog is always visible on
     * exactly one screen.
     */
    public BoundaryRestriction HARD = new HardBoundaryRestriction();
    
    /**
     * Calculates the bounds which window can have. 
     * @param window the window whose bounds should be checked.
     * @return the new boundaries of window, can be null
     * to indicate that the current boundaries are valid. 
     */
    public Rectangle check( ScreenDockWindow window );
    
    /**
     * Calculates the bounds which window can have.
     * @param window the window whose future bounds should be checked.
     * @param target the bounds window should have, this method
     * should not write into target.
     * @return the new boundaries, null to indicate that 
     * target is valid. 
     */
    public Rectangle check( ScreenDockWindow window, Rectangle target );
}