/* $Id: GUISettingsTabInterface.java 17749 2010-01-11 18:49:17Z linus $
 *******************************************************************************
 * Copyright (c) 2009 Contributors - see below
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    mvw
 *******************************************************************************
 *
 * Some portions of this file was previously release using the BSD License:
 */

// Copyright (c) 1996-2009 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.argouml.application.api;

import javax.swing.JPanel;

/**
 * An interface which must be implemented as the UI for
 * tabs used on the settings panel.<p>
 *
 * Tabs will only need to load data during {@link #handleSettingsTabRefresh}
 * and should only save data during {@link #handleSettingsTabSave}.
 * Changes can be made during editing of the tabs, but the tab must
 * be able to undo any change if requested
 * through {@link #handleSettingsTabCancel}.<p>
 * 
 * Warning: Do not access the ProjectManager in the constructor 
 * of classes that implement this interface! This because the
 * SettingsTabs are created before an initial Project is created.
 *
 * @author Thierry Lach
 * @since 0.9.4
 * @author Linus Tolke (moved this into the GUI subsystem)
 * @since 0.21.3 (it is part of the GUI subsystem)
 */
public interface GUISettingsTabInterface {

    /**
     * Save any fields changed.
     */
    void handleSettingsTabSave();

    /**
     * Cancel any changes.
     */
    void handleSettingsTabCancel();

    /**
     * Load or reload field settings.
     */
    void handleSettingsTabRefresh();
    
    /**
     * Reset the settings shown to the same settings with a broader scope.
     * I.e. copy settings from wider scope to narrow scope. <p>
     * 
     * Remark:
     * This shall only adapt the displayed value! 
     * You need a save to make the actual change.
     */
    void handleResetToDefault();
    
    /**
     * Gets the unlocalized settings tab name.
     *
     * @return the unlocalized settings tab name
     */
    String getTabKey();

    /**
     * Gets the JPanel which implements the tab.
     *
     * @return the JPanel which implements the tab
     */
    JPanel getTabPanel();

} /* End interface GUISettingsTabInterface */