Coverage Report

Coverage Report - org.argouml.application.api.GUISettingsTabInterface

Classes in this File

 /* $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 */

1		/* $Id: GUISettingsTabInterface.java 17749 2010-01-11 18:49:17Z linus $
2		*******************************************************************************
3		* Copyright (c) 2009 Contributors - see below
4		* All rights reserved. This program and the accompanying materials
5		* are made available under the terms of the Eclipse Public License v1.0
6		* which accompanies this distribution, and is available at
7		* http://www.eclipse.org/legal/epl-v10.html
8		*
9		* Contributors:
10		* mvw
11		*******************************************************************************
12		*
13		* Some portions of this file was previously release using the BSD License:
14		*/
15
16		// Copyright (c) 1996-2009 The Regents of the University of California. All
17		// Rights Reserved. Permission to use, copy, modify, and distribute this
18		// software and its documentation without fee, and without a written
19		// agreement is hereby granted, provided that the above copyright notice
20		// and this paragraph appear in all copies. This software program and
21		// documentation are copyrighted by The Regents of the University of
22		// California. The software program and documentation are supplied "AS
23		// IS", without any accompanying services from The Regents. The Regents
24		// does not warrant that the operation of the program will be
25		// uninterrupted or error-free. The end-user understands that the program
26		// was developed for research purposes and is advised not to rely
27		// exclusively on the program for any reason. IN NO EVENT SHALL THE
28		// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
29		// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
30		// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
31		// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
32		// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
33		// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
34		// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
35		// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
36		// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
37		// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
38
39		package org.argouml.application.api;
40
41		import javax.swing.JPanel;
42
43		/**
44		* An interface which must be implemented as the UI for
45		* tabs used on the settings panel.<p>
46		*
47		* Tabs will only need to load data during {@link #handleSettingsTabRefresh}
48		* and should only save data during {@link #handleSettingsTabSave}.
49		* Changes can be made during editing of the tabs, but the tab must
50		* be able to undo any change if requested
51		* through {@link #handleSettingsTabCancel}.<p>
52		*
53		* Warning: Do not access the ProjectManager in the constructor
54		* of classes that implement this interface! This because the
55		* SettingsTabs are created before an initial Project is created.
56		*
57		* @author Thierry Lach
58		* @since 0.9.4
59		* @author Linus Tolke (moved this into the GUI subsystem)
60		* @since 0.21.3 (it is part of the GUI subsystem)
61		*/
62		public interface GUISettingsTabInterface {
63
64		/**
65		* Save any fields changed.
66		*/
67		void handleSettingsTabSave();
68
69		/**
70		* Cancel any changes.
71		*/
72		void handleSettingsTabCancel();
73
74		/**
75		* Load or reload field settings.
76		*/
77		void handleSettingsTabRefresh();
78
79		/**
80		* Reset the settings shown to the same settings with a broader scope.
81		* I.e. copy settings from wider scope to narrow scope. <p>
82		*
83		* Remark:
84		* This shall only adapt the displayed value!
85		* You need a save to make the actual change.
86		*/
87		void handleResetToDefault();
88
89		/**
90		* Gets the unlocalized settings tab name.
91		*
92		* @return the unlocalized settings tab name
93		*/
94		String getTabKey();
95
96		/**
97		* Gets the JPanel which implements the tab.
98		*
99		* @return the JPanel which implements the tab
100		*/
101		JPanel getTabPanel();
102
103		} /* End interface GUISettingsTabInterface */