Changeset 5372

Timestamp:

Jun 24, 2010, 2:28:06 PM (12 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #1462: Select plugin+configuration in a single list

Location:

trunk

Files:

• doc/src/docbook/figures/select_autodetect_file.png (modified) (previous)
• doc/src/docbook/figures/select_import_plugin.png (modified) (previous)
• doc/src/docbook/userdoc/export_data.xml (modified) (1 diff)
• doc/src/docbook/userdoc/import_data.xml (modified) (8 diffs)
• www/common/import/select_file.jsp (modified) (4 diffs)
• www/common/import/select_plugin.jsp (modified) (6 diffs)
• www/common/plugin/select_plugin.jsp (modified) (6 diffs)
• www/include/scripts/plugin.js (modified) (4 diffs)
• www/include/styles/main.css (modified) (1 diff)

trunk/doc/src/docbook/userdoc/export_data.xml

@@ -117 +117 @@
           <varlistentry>
             <term>
-              <guilabel>Plugin</guilabel>
+              <guilabel>Plugin + configuration</guilabel>
             </term>
             <listitem>
               <para>
-                Select the plug-in to use. Only plug-ins that supports the current
-                context and that the logged in user has permission to use are
-                available in the list.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term>
-              <guilabel>Configuration</guilabel>
-            </term>
-            <listitem>
-              <para>
-                Select the configuration that should be used together with the plug-in.
-                Not all plug-ins supports configuration and this option is only visible
-                if the selected plug-in has this support.
+                Select the plug-in and configuration to use. The list only
+                shows combinations that the logged in user has permission 
+                to use.
               </para>
             </listitem>

trunk/doc/src/docbook/userdoc/import_data.xml

@@ -158 +158 @@
         <variablelist>
           <varlistentry>
-            <term><guilabel>Plugin</guilabel></term>
-            <listitem>
-              <para>
-                A list of all plug-ins that are available in the
-                current context. The list only includes plug-ins that
+            <term><guilabel>Plugin + file format</guilabel></term>
+            <listitem>
+              <para>
+                This is a combined list of plug-ins and their 
+                respective file format configurations. The list only 
+                includes combinations that
                 the logged in user has permission to use. If you select
-                a plug-in a short description of about it is displayed
+                an entry a short description of about the plug-in and configuration
+                is displayed
                 below the lists. More information about the plug-ins can
-                be found under the menu choice
+                be found under the menu choices
                 <menuchoice>
                   <guimenu>Administrate</guimenu>
@@ -172 +174 @@
                   <guisubmenu>Definitions</guisubmenu>
                 </menuchoice>
-              </para>
-            </listitem>
-          </varlistentry>
-          
-          <varlistentry>
-            <term><guilabel>File format</guilabel></term>
-            <listitem>
-              <para>
-                A list of different file formats configurations
-                supported by the selected plug-in.
+                and 
                 <menuchoice>
                   <guimenu>Administrate</guimenu>
@@ -188 +181 @@
                 </menuchoice>.
               </para>
-              
               <note>
                 <title>File format vs. Configuration</title>
@@ -199 +191 @@
                 </simpara>
               </note>
-              
             </listitem>
           </varlistentry>
-        
         </variablelist>
 
@@ -225 +215 @@
           The auto detect function lets you select a file and have
           BASE try to find a suitable plug-in and file format. This option is
-          selected by default in both the plug-in and file format lists when there is
+          selected by default in the combined plug-in and file format list when there is
           at least one plug-in that supports auto detection.
         </para>
@@ -237 +227 @@
         
         <para>
-          Select the auto detect option either for both plug-ins and 
-          file formats or only for file formats to use this feature. 
-          Continue to the next step by clicking on the &gbNext;
-          button.
+          Select the <guilabel>auto detect (all)</guilabel> option to search for a file format
+          in all plug-ins that supports the feature, or select the <guilabel>auto detect (plugin)</guilabel>
+          option to only search the file formats for a specific plug-in.
+          Continue to the next step by clicking on the &gbNext; button.
         </para>
         
@@ -268 +258 @@
           <variablelist>
             <varlistentry>
+              <term><guilabel>Plugin</guilabel></term>
+              <listitem>
+                <para>
+                  Displayes the selected plug-in or <guilabel>all</guilabel> if the 
+                  auto-detection is used on all supporting plug-ins.
+                </para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
               <term><guilabel>File</guilabel></term>
               <listitem>
@@ -280 +279 @@
               </listitem>
             </varlistentry>
-            
+            <varlistentry>
+              <term><guilabel>Character set</guilabel></term>
+              <listitem>
+                <para>
+                  The character set used in text files. If the selected file has been configured
+                  with a character set the correct option is automatically selected. In all 
+                  cases, you have the option to override the default selection. Most files,
+                  typically use one of the UTF-8 or ISO-8859-1 character sets.
+                </para>
+              </listitem>
+            </varlistentry>
             <varlistentry>
               <term><guilabel>Recently used</guilabel></term>

trunk/www/common/import/select_file.jsp

@@ -31 +31 @@
   import="net.sf.basedb.core.ItemContext"
   import="net.sf.basedb.core.File"
+  import="net.sf.basedb.core.PluginDefinition"
   import="net.sf.basedb.core.PluginConfiguration"
   import="net.sf.basedb.core.PluginType"
@@ -66 +67 @@
 final String title = request.getParameter("title");
 final DbControl dc = sc.newDbControl();
+final int pluginId = Values.getInt(request.getParameter("plugindefinition_id"));
+PluginDefinition plugin = null;
+if (pluginId > 0)
+{
+  plugin = PluginDefinition.getById(dc, pluginId);
+}
 
 try
@@ -176 +183 @@
     <input type="hidden" name="file_id" value="">
     
-    <h3 class="docked"><%=title%> <base:help helpid="import.autodetect.selectfile" /></h3>
+    <h3 class="docked"><%=title%> (auto-detect file format) <base:help helpid="import.autodetect.selectfile" /></h3>
     <div class="boxed">
       <div class="helpmessage">
@@ -182 +189 @@
       </div>
       <table class="form" width="100%">
+      <tr valign="top">
+        <td class="prompt">Plugin</td>
+        <td><%=plugin != null ? HTML.encodeTags(plugin.getName()) : "<i>- all -</i>"%></td>
+      </tr>
       <tr valign="top">
         <td class="prompt">File</td>

trunk/www/common/import/select_plugin.jsp

@@ -95 +95 @@
     
     var lastSelectedPlugin;
+    var lastSelectedConfig;
     function pluginOnChange()
     {
       var frm = document.forms['import'];
-      var pluginList = frm.plugindefinition_id;
-      var configurationList = frm.pluginconfiguration_id;
+      var pluginList = frm.plugins;
       var plugin = pluginList[pluginList.selectedIndex].plugin;
-      Plugins.updateConfigurationsList(plugin, configurationList);
-      if (configurationList.length == 0)
-      {
-        Main.hide('configurations');
+      var config = pluginList[pluginList.selectedIndex].configuration;
+      var selectedValue = pluginList[pluginList.selectedIndex].value;
+      
+      if (lastSelectedPlugin)
+      {
+        Main.hide('description.'+lastSelectedPlugin.id);
+      }
+      if (lastSelectedConfig)
+      {
+        Main.hide('description.config.'+lastSelectedConfig.id);
+      }
+      Main.showHide('descriptions', plugin);
+      if (plugin)
+      {
+        Main.show('description.'+plugin.id);
+        frm.plugindefinition_id.value = plugin.id;
+        frm.pluginconfiguration_id.value = selectedValue == -1 ? -1 : 0;
       }
       else
       {
-        Main.show('configurations');
-      }
-      if (lastSelectedPlugin)
-      {
-        Main.hide('description.'+lastSelectedPlugin.id);
-      }
-      else
-      {
-        Main.show('descriptions');
-      }
-      if (lastSelectedConfig)
-      {
-        Main.hide('description.config.'+lastSelectedConfig.id);
-      }
-      if (plugin)
-      {
-        Main.show('description.'+plugin.id);
-      }
-      else
-      {
-        Main.hide('descriptions');
-      }
-      lastSelectedConfig = null;
+        frm.plugindefinition_id.value = selectedValue;
+      }
+      if (config)
+      {
+        Main.show('description.config.'+config.id);
+        frm.pluginconfiguration_id.value = config.id;
+      }
+      lastSelectedConfig = config;
       lastSelectedPlugin = plugin;
     }
-    
-    var lastSelectedConfig;
-    function configOnChange()
+
+    function init()
     {
       var frm = document.forms['import'];
-      var configurationList = frm.pluginconfiguration_id;
-      var config = configurationList[configurationList.selectedIndex].configuration;
-      if (lastSelectedConfig)
-      {
-        Main.hide('description.config.'+lastSelectedConfig.id);
-      }
-      else
-      {
-        Main.show('descriptions');
-      }
-      if (config)
-      {
-        Main.show('description.config.'+config.id);
-      }
-      else
-      {
-        Main.hide('descriptions');
-      }
-      lastSelectedConfig = config;
-    }
-    
-    function init()
-    {
-      var frm = document.forms['import'];
-      var pluginList = frm.plugindefinition_id;
-      var configurationList = frm.pluginconfiguration_id;
+      var pluginList = frm.plugins;
+      
       <%
       PluginDefinition lastPlugin = null;
@@ -198 +171 @@
       }
       %>      
-      Plugins.populateLists(pluginList, configurationList);
-      if (configurationList.length == 0)
-      {
-        Main.hide('configurations');
-      }
-      else
-      {
-        Main.show('configurations');
-      }
+      Plugins.populateLists(pluginList);
       pluginOnChange();
     }
@@ -220 +185 @@
     <input type="hidden" name="title" value="<%=title%>">
     <input type="hidden" name="warnIfOpen" value="1">
+    <input type="hidden" name="plugindefinition_id" value="">
+    <input type="hidden" name="pluginconfiguration_id" value="">
 
     <h3 class="docked"><%=title%> <base:help helpid="import.selectplugin" /></h3>
@@ -242 +209 @@
       <table class="form" width="100%">
       <tr valign="top">
-        <td class="prompt">Plugin</td>
+        <td class="prompt">Plugin + file format</td>
         <td>
-          <select name="plugindefinition_id" class="required" onchange="pluginOnChange()">
+          <select name="plugins" class="required" onchange="pluginOnChange()">
           </select>
           <%
@@ -254 +221 @@
           }
           %>
-        </td>
-      </tr>
-      <tr valign="top" id="configurations">
-        <td class="prompt">File format</td>
-        <td>
-          <select name="pluginconfiguration_id" onchange="configOnChange()">
-          </select>
         </td>
       </tr>
@@ -288 +248 @@
       <div align=right>&nbsp;<i><base:icon image="required.gif" /> = required information</i></div>
       <div id="descriptions" class="helpmessage" 
-        style="height: <%=(int)(scale*270)%>px; overflow: auto; display: none;">
+        style="height: <%=(int)(scale*270)%>px; overflow: auto;">
       <%=descriptions.toString()%>
       </div>

trunk/www/common/plugin/select_plugin.jsp

@@ -91 +91 @@
     
     var lastSelectedPlugin;
+    var lastSelectedConfig;
     function pluginOnChange()
     {
       var frm = document.forms['plugin'];
-      var pluginList = frm.plugindefinition_id;
-      var configurationList = frm.pluginconfiguration_id;
+      var pluginList = frm.plugins;
       var plugin = pluginList[pluginList.selectedIndex].plugin;
-      Plugins.updateConfigurationsList(plugin, configurationList);
-      if (configurationList.length == 0)
-      {
-        Main.hide('configurations');
-      }
-      else
-      {
-        Main.show('configurations');
-      }
+      var config = pluginList[pluginList.selectedIndex].configuration;
+
       if (lastSelectedPlugin)
       {
         Main.hide('description.'+lastSelectedPlugin.id);
       }
-      else
-      {
-        Main.show('descriptions');
-      }
       if (lastSelectedConfig)
       {
         Main.hide('description.config.'+lastSelectedConfig.id);
       }
-      Main.show('description.'+plugin.id);
+      if (plugin)
+      {
+        Main.show('description.'+plugin.id);
+        frm.plugindefinition_id.value = plugin.id;
+        frm.pluginconfiguration_id.value = 0;
+      }
+      if (config)
+      {
+        Main.show('description.config.'+config.id);
+        frm.pluginconfiguration_id.value = config.id;
+      }
+      lastSelectedConfig = config;
       lastSelectedPlugin = plugin;
-      lastSelectedConfig = null;
-      configOnChange();
-    }
-    
-    var lastSelectedConfig;
-    function configOnChange()
-    {
-      var frm = document.forms['plugin'];
-      var configurationList = frm.pluginconfiguration_id;
-      if (configurationList.selectedIndex < 0) return;  
-      var config = configurationList[configurationList.selectedIndex].configuration;
-      if (lastSelectedConfig)
-      {
-        Main.hide('description.config.'+lastSelectedConfig.id);
-      }
-      else
-      {
-        Main.show('descriptions');
-      }
-      if (config)
-      {
-        Main.show('description.config.'+config.id);
-      }
-      else
-      {
-        Main.hide('descriptions');
-      }
-      lastSelectedConfig = config;
     }
     
@@ -153 +125 @@
     {
       var frm = document.forms['plugin'];
-      var pluginList = frm.plugindefinition_id;
-      var configurationList = frm.pluginconfiguration_id;
+      var pluginList = frm.plugins;
       <%
       PluginDefinition lastPlugin = null;
@@ -188 +159 @@
       }
       %>
-      Plugins.populateLists(pluginList, configurationList);
+      Plugins.populateLists(pluginList);
       pluginOnChange();
     }
@@ -203 +174 @@
     <input type="hidden" name="title" value="<%=title%>">
     <input type="hidden" name="warnIfOpen" value="1">
+    <input type="hidden" name="plugindefinition_id" value="">
+    <input type="hidden" name="pluginconfiguration_id" value="">
 
     <h3 class="docked"><%=title%> <base:help helpid="runplugin.selectplugin" /></h3>
@@ -225 +198 @@
       <table class="form" width="100%">
       <tr valign="top">
-        <td class="prompt">Plugin</td>
+        <td class="prompt">Plugin + configuration</td>
         <td>
-          <select name="plugindefinition_id" class="required" onchange="pluginOnChange()">
-          </select>
-        </td>
-      </tr>
-      <tr valign="top" id="configurations">
-        <td class="prompt">Configuration</td>
-        <td>
-          <select name="pluginconfiguration_id" onchange="configOnChange()">
+          <select name="plugins" class="required" onchange="pluginOnChange()">
           </select>
         </td>
@@ -263 +229 @@
       <div align=right>&nbsp;<i><base:icon image="required.gif" /> = required information</i></div>
       <div id="descriptions" class="helpmessage" 
-        style="height: <%=(int)(scale*270)%>px; overflow: auto; display: none;">
+        style="height: <%=(int)(scale*270)%>px; overflow: auto;">
       <%=descriptions.toString()%>
       </div>

trunk/www/include/scripts/plugin.js

@@ -33 +33 @@
   this.allPlugins = new Array();
   
-  this.populateLists = function(pluginList, configurationList)
+  this.populateLists = function(pluginList)
   {
-    pluginList[pluginList.length] = new Option('- auto detect -', '-1');
+    var option = new Option('- auto detect (all) -', '-1');
+    pluginList[pluginList.length] = option;
+    option.className = 'selectoptionautodetect';
     var numAutodetecting = 0;
     for (var i = 0; i < this.allPlugins.length; i++)
@@ -48 +50 @@
       pluginList[pluginList.length] = option;
       pluginList[pluginList.length-1].plugin = plugin;
+      option.className = 'selectoptionheader';
+      if (plugin.requiresConfiguration)
+      {
+        option.disabled = true;
+      }
+      
+      if (plugin.supportsConfigurations && plugin.configurations.length > 0)
+      {
+        if (plugin.autodetection)
+        {
+          var option = new Option(' ├ auto detect (' + plugin.name + ') -', '-1');
+          option.className = 'selectoptionautodetect';
+          pluginList[pluginList.length] = option;
+          pluginList[pluginList.length-1].plugin = plugin;
+        }
+        for (var j = 0; j < plugin.configurations.length; j++)
+        {
+          var conf = plugin.configurations[j];
+          var name = conf.name;
+          var prefix = j == plugin.configurations.length-1 ? ' └ ' : ' ├ '
+          var option = new Option(prefix+name, conf.id);
+          pluginList[pluginList.length] = option;
+          pluginList[pluginList.length-1].plugin = plugin;
+          pluginList[pluginList.length-1].configuration = conf;
+        }
+      }
+      
     }
     if (numAutodetecting == 0)
@@ -53 +82 @@
       pluginList[0] = null;
     }
-    this.updateConfigurationsList(pluginList[0].plugin, configurationList);
   }
   
+  /*
   this.updateConfigurationsList = function(plugin, list)
   {
@@ -85 +114 @@
     }
   }
+  */
   
 }

trunk/www/include/styles/main.css

@@ -213 +213 @@
 .selectoptionheader, .defaultheader {
     font-weight: bold;
+}
+
+.selectoptionautodetect {
+  font-style: italic;
 }