bibliothek.gui.dock.support.mode.UndoableModeSettings 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

DockingFrames is an open source Java Swing docking framework, licenced under LGPL 2.1. This is the same distribution as the original distribution (http://www.docking-frames.org/), only reinstalled in maven

There is a newer version: 1.1.2p20b.fix-1

Show 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) 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
 * [email protected]
 * CH - Switzerland
 */
package bibliothek.gui.dock.support.mode;

/**
 * This class is used by a {@link ModeManager} during a read operation to create
 * entries even if it not entirely sure whether the entry will ever be used.
 * @author Benjamin Sigg
 */
public interface UndoableModeSettings {
	/**
	 * Called during a read operation if {@link ModeManager#createEntryDuringRead(String)}
	 * did already return false for key.
	 * @param key the key of some element that might be important later
	 * @return true if an entry for key should be created
	 * temporarily
	 * @see ModeManager#readSettings(ModeSettings, UndoableModeSettings)
	 */
	public boolean createTemporaryDuringRead( String key );
}