bibliothek.gui.dock.common.preference.CLayoutPreferenceModel 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) 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
 * [email protected]
 * CH - Switzerland
 */
package bibliothek.gui.dock.common.preference;

import bibliothek.extension.gui.dock.preference.DefaultPreferenceModel;
import bibliothek.extension.gui.dock.preference.preferences.choice.TabContentFilterPreference;
import bibliothek.extension.gui.dock.preference.preferences.choice.TabPlacementPreference;
import bibliothek.gui.DockTheme;
import bibliothek.gui.Dockable;
import bibliothek.gui.dock.common.CControl;
import bibliothek.util.Path;

/**
 * A model showing various preferences that are used for the layout.
 * 
 * 	What content to show on the button for a minimized {@link Dockable} 
 * 	Where to place tabs
 * 	What to show on tabs
 * 	Which {@link CControl#setTheme(String) theme} to use
 * 
 * @author Benjamin Sigg
 */
public class CLayoutPreferenceModel extends DefaultPreferenceModel{
	private TabPlacementPreference tabPlacement;
	private TabContentFilterPreference tabContentFilter;
	private ThemePreference theme;
	
    /**
     * Creates a new model.
     * @param control the control whose settings this model represents
     */
    public CLayoutPreferenceModel( CControl control ){
    	super( control.getController() );
        add( tabPlacement = new TabPlacementPreference( control.intern().getDockProperties(), new Path( "dock.layout.tabplacement" )));
        add( tabContentFilter = new TabContentFilterPreference( control.intern().getDockProperties(), new Path( "dock.layout.tabcontentfilter" )));
        add( theme = new ThemePreference( control.intern().getDockProperties(), control.getThemes() ));
    }
    
    /**
     * Grants access to the preference that tells what content to show on a tab.
     * @return the preference, not null
     */
    public TabContentFilterPreference getTabContentFilter(){
		return tabContentFilter;
	}
    
    /**
     * Grants access to the preference that tells where tabs are placed.
     * @return the preference, not null
     */
    public TabPlacementPreference getTabPlacement(){
		return tabPlacement;
	}
 
    /**
     * Grants access to the preference that selects the {@link DockTheme}.
     * @return the preference, not null
     */
    public ThemePreference getTheme(){
		return theme;
	}
}