/*
 * 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
 * benjamin_sigg@gmx.ch
 * CH - Switzerland
 */
package bibliothek.extension.gui.dock.preference.preferences;

import bibliothek.gui.Dockable;
import bibliothek.gui.dock.ScreenDockStation;
import bibliothek.gui.dock.control.DockRelocatorMode;
import bibliothek.gui.dock.control.ModifierMask;
import bibliothek.gui.dock.util.DockProperties;
import bibliothek.util.Path;

/**
 * Preference for the mask that forces a {@link Dockable} onto the {@link ScreenDockStation}
 * when moving.
 * @author Benjamin Sigg
 * @see DockRelocatorMode#SCREEN_MASK
 */
public class ModifierMaskScreenOnlyPreference extends DockPropertyPreference<ModifierMask>{
	/**
	 * Creates a new preference
	 * @param properties to read and write the value of this preference
	 */
	public ModifierMaskScreenOnlyPreference( DockProperties properties ){
		super( properties, DockRelocatorMode.SCREEN_MASK, Path.TYPE_MODIFIER_MASK_PATH, new Path( "dock.DockRelocatorMode.SCREEN_MASK" ) );

		setLabelId( "preference.shortcuts.screen_only.label" );
		setDescriptionId( "preference.shortcuts.screen_only.description" );
		
		setDefaultValue( DockRelocatorMode.SCREEN_MASK.getDefault( null ) );
	}
}