Changeset 5536 for trunk/gli/src/org/greenstone/gatherer/gui/OptionsPane.java

Timestamp:

2003-09-26T14:58:33+12:00 (21 years ago)

Author:

mdewsnip

Message:

Many more tooltips and improvements to the Dictionary. Still more to come.

File:

• trunk/gli/src/org/greenstone/gatherer/gui/OptionsPane.java (modified) (14 diffs)

trunk/gli/src/org/greenstone/gatherer/gui/OptionsPane.java

@@ -1 @@
-package org.greenstone.gatherer.gui;
 /**
  *#########################################################################
@@ -36 +35 @@
  *########################################################################
  */
+package org.greenstone.gatherer.gui;
+
 import java.awt.*;
 import java.awt.event.*;
@@ -43 +44 @@
 import javax.swing.event.*;
 import javax.swing.text.*;
+import org.greenstone.gatherer.Dictionary;
 import org.greenstone.gatherer.Gatherer;
 import org.greenstone.gatherer.cdm.Argument;
@@ -53 +55 @@
 import org.greenstone.gatherer.util.AppendLineOnlyFileDocumentOwner;
 import org.greenstone.gatherer.util.Utility;
-//import org.w3c.dom.*;
+
 /** This class serves as the data holder for all subclasses of option panes, such as Import options or All options. It also contains methods for creating each of the option lines as they would appear in the subpane. Futhermore it has a method for considering all the arguments and generating a <strong>String[]</strong> to allow you to pass them to the <strong>GShell</strong>.
  * @author John Thompson, Greenstone Digital Library, University of Waikato
@@ -91 +93 @@
 
 
-     /** The default constructor creates the few session length options, but either retrieves the rest from the current collection, or creates a default set of options. */
+    /** The default constructor creates the few session length options, but either retrieves the rest from the current collection, or creates a default set of options. */
     public OptionsPane(BuildOptions build_options) {
     this.build_options = build_options;
@@ -102 +104 @@
 
     /** This method creates the panel with all the build only options on it.
-      * @return A <strong>JPanel</strong> which can be used to display all the build only options.
-      */
+     * @return A <strong>JPanel</strong> which can be used to display all the build only options.
+     */
     public JPanel buildBuild() {
     JPanel pane = new JPanel();
@@ -122 +124 @@
     }
     /** This method creates the panel with all the import only options on it.
-      * @return A <strong>JPanel</strong> which can be used to display all the import only options.
-      */
+     * @return A <strong>JPanel</strong> which can be used to display all the import only options.
+     */
     public JPanel buildImport() {
     JPanel pane = new JPanel();
@@ -142 +144 @@
     }
     /** This method is used to build a panel based on the message log, which is nothing like any of the other panels.
-      * @return A <strong>JPanel</strong> containing a scrollable text area which represents the shell process message log.
-      */
+     * @return A <strong>JPanel</strong> containing a scrollable text area which represents the shell process message log.
+     */
     public JPanel buildLog() {
     // we now save the log pane
@@ -179 +181 @@
         log_list.addListSelectionListener(new LogListListener());
 
-        JLabel log_history_label = new JLabel(get("OptionsPane.LogHistory"));
+        JLabel log_history_label = new JLabel();
+        Dictionary.registerText(log_history_label, "OptionsPane.LogHistory");
         JPanel log_history_pane = new JPanel();
         log_history_pane.setPreferredSize(new Dimension(600, 100));
@@ -211 +214 @@
     }
 
-    /** This method retrieves a phrase from the dictionary based apon the key.
-      * @param key A <strong>String</strong> used as a reference to the correct phrase.
-      * @return A phrase, matching the key, as a <strong>String</strong>.
-      */
-    private String get(String key) {
-    return get(key, null);
-    }
-    /** This method retrieves a phrase from the dictionary based apon the key and arguments.
-      * @param key A <strong>String</strong> used as a reference to the correct phrase.
-      * @param args A <strong>String[]</strong> whose contents are often substituted into the phrase before it is returned.
-      * @return A phrase, matching the key and constructed using the arguments, as a <strong>String</strong>.
-      * @see org.greenstone.gatherer.Dictionary
-      * @see org.greenstone.gatherer.Gatherer
-      */
-    private String get(String key, String args[]) {
-    if(key.indexOf(".") == -1) {
-        key = "OptionsPane." + key;
-    }
-    return Gatherer.dictionary.get(key, args);
-    }
+
     /** Attempts to discover the latest document count.
      * @return An <strong>int</strong> detailing the number of documents in this collection.
@@ -285 +269 @@
         setLayout(new BorderLayout());
         setPreferredSize(ROW_SIZE);
-
-        /*
-          JPanel inner_pane = new JPanel();
-          inner_pane.setOpaque(false);
-        */
 
         // Try to determine what the value_controls value should be.
@@ -389 +368 @@
         }
 
-                // If the argument is required, then you don't get a choice of whether it is enabled.
+        // If the argument is required, then you don't get a choice of whether it is enabled.
         if(argument.isRequired()) {
         JLabel label = new JLabel(argument.getName());
@@ -460 +439 @@
     }
     /** Any implementation of ActionListener must include this method so that we can be informed when an action has been performed on or registered check box, prompting us to change the state of the other controls as per the users request.
-            * @param event An <strong>ActionEvent</strong> containing information about the click.
-            */
+     * @param event An <strong>ActionEvent</strong> containing information about the click.
+     */
     public void actionPerformed(ActionEvent event) {
         JCheckBox source = (JCheckBox)event.getSource();
@@ -562 +541 @@
         switch (success) {
         case SUCCESSFUL:
-            d.append(get("OptionsPane.Successful"));
+            d.append(Dictionary.newget("OptionsPane.Successful"));
             break;
         case UNSUCCESSFUL:
-            d.append(get("OptionsPane.Unsuccessful"));
+            d.append(Dictionary.newget("OptionsPane.Unsuccessful"));
             break;
         case CANCELLED:
-            d.append(get("OptionsPane.Cancelled"));
+            d.append(Dictionary.newget("OptionsPane.Cancelled"));
             break;
         default:
-            d.append(get("OptionsPane.Unknown"));
+            d.append(Dictionary.newget("OptionsPane.Unknown"));
         }
         display = d.toString();