bibliothek.gui.dock.support.mode.HistoryRewriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of docking-frames-common Show documentation

Docking Frames Common legacy version used in openTCS

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) 2011 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.support.mode;

import bibliothek.gui.Dockable;

/**
 * A {@link HistoryRewriter} can be 
 * @author Benjamin Sigg
 * @param  the kind of {@link Mode} this rewriter accepts
 * @param  the kind of history this rewriter accepts
 */
public interface HistoryRewriter> {
	/**
	 * Checks whether the history object history is still valid.
	 * @param dockable the element which is about to change its mode
	 * @param mode the mode that is going to be applied
	 * @param history the history object that will be forwarded to mode, may be null
	 * @return the history object to use, may be null
	 */
	public H rewrite( Dockable dockable, M mode, H history );
}