Changeset 5631 in josm for trunk/src/org/openstreetmap/josm/gui/preferences/TabPreferenceSetting.java

Timestamp:

2012-12-25T23:43:22+01:00 (13 years ago)

Author:

Don-vip

Message:

Allow to access directly to validator preferences from validator dialog with a small preferences button left to pin button.
Generic approach in order to be reused by plugins using dialogs.
This leads to some changes in preferences settings system, but without any break in compatibility.
The only impact is the deprecation of some public JTabbedPane fields, that will be removed mid-2013.

File:

• trunk/src/org/openstreetmap/josm/gui/preferences/TabPreferenceSetting.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/gui/preferences/TabPreferenceSetting.java

@@ -1 +1 @@
 // License: GPL. Copyright 2007 by Immanuel Scholz and others
 package org.openstreetmap.josm.gui.preferences;
+
+import java.awt.Component;
 
 /**
@@ -29 +31 @@
     /**
      * Called during preferences tab initialization to display a description in one sentence for this tab. 
-     * Will be displayedin italic under the title.
+     * Will be displayed in italic under the title.
      * @return The description of this preferences tab.
      */
     public String getDescription();
+
+    /**
+     * Adds a new sub preference settings tab with the given title and component.
+     * @param sub The new sub preference settings.
+     * @param title The tab title.
+     * @param component The tab component.
+     * @since 5631
+     */
+    public void addSubTab(SubPreferenceSetting sub, String title, Component component);
+    
+    /**
+     * Adds a new sub preference settings tab with the given title, component and tooltip.
+     * @param sub The new sub preference settings.
+     * @param title The tab title.
+     * @param component The tab component.
+     * @param tip The tab tooltip.
+     * @since 5631
+     */
+    public void addSubTab(SubPreferenceSetting sub, String title, Component component, String tip);
+
+    /**
+     * Registers a sub preference settings to an existing tab component.
+     * @param sub The new sub preference settings.
+     * @param component The component for which a tab already exists.
+     * @since 5631
+     */
+    public void registerSubTab(SubPreferenceSetting sub, Component component);
+    
+    /**
+     * Returns the tab component related to the specified sub preference settings
+     * @param sub The requested sub preference settings.
+     * @return The component related to the specified sub preference settings, or null.
+     * @since 5631
+     */
+    public Component getSubTab(SubPreferenceSetting sub);
+
+    /**
+     * Selects the specified sub preference settings, if applicable. Not all Tab preference settings need to implement this.
+     * @param subPref The sub preference settings to be selected.
+     * @return true if the specified preference settings have been selected, false otherwise.
+     * @since 5631
+     */
+    public boolean selectSubTab(SubPreferenceSetting subPref);
 }