Changeset 4870

Timestamp:

Apr 1, 2009, 1:38:59 PM (13 years ago)

Author:

Nicklas Nordborg

Message:

References #1271: Add extension points to all toolbars

Infrastructure is in place. I have used experiment list page as a prototype. Changes include:

• Renderer and renderer factory for toolbar buttons
• Add support for WrappingRenderer? to allow an extension point to add HTML around what is generated by a parent renderer.
  • Make it possible to programmatically register extension points
  • The table.Button taglib also uses the ToolbarButtonRenderer?

Location:

trunk

Files:

• src/clients/web/net/sf/basedb/clients/web/extensions/ExtensionsControl.java (modified) (3 diffs)
• src/clients/web/net/sf/basedb/clients/web/extensions/renderer (added)
• src/clients/web/net/sf/basedb/clients/web/extensions/renderer/PrefixSuffixRenderer.java (added)
• src/clients/web/net/sf/basedb/clients/web/extensions/toolbar/ToolbarButtonRenderer.java (added)
• src/clients/web/net/sf/basedb/clients/web/extensions/toolbar/ToolbarButtonRendererFactory.java (added)
• src/clients/web/net/sf/basedb/clients/web/extensions/toolbar/ToolbarUtil.java (added)
• src/clients/web/net/sf/basedb/clients/web/taglib/extensions/Render.java (modified) (7 diffs)
• src/clients/web/net/sf/basedb/clients/web/taglib/table/Button.java (modified) (6 diffs)
• src/core/net/sf/basedb/util/extensions/ExtensionsInvoker.java (modified) (4 diffs)
• src/core/net/sf/basedb/util/extensions/Registry.java (modified) (1 diff)
• src/core/net/sf/basedb/util/extensions/WrappingRenderer.java (added)
• www/WEB-INF/extensions.tld (modified) (1 diff)
• www/WEB-INF/extensions/core-extensions.xml (modified) (2 diffs)
• www/admin/extensions/details.jsp (modified) (2 diffs)
• www/admin/extensions/tree.jsp (modified) (2 diffs)
• www/include/styles/table.css (modified) (1 diff)
• www/include/styles/toolbar.css (modified) (2 diffs)
• www/views/experiments/list_experiments.jsp (modified) (4 diffs)

trunk/src/clients/web/net/sf/basedb/clients/web/extensions/ExtensionsControl.java

@@ -32 +32 @@
 
 import net.sf.basedb.clients.web.extensions.service.Services;
+import net.sf.basedb.clients.web.extensions.toolbar.ToolbarUtil;
 import net.sf.basedb.clients.web.servlet.ExtensionsServlet;
 import net.sf.basedb.core.AccessControlled;
@@ -135 +136 @@
     registry = new Registry();
     
+    // Toolbar extensions are added programmatically
+    // must be done before scanning files otherwise it is not
+    // possible to register extension for the toolbars
+    ToolbarUtil.registerExtensionPoints(registry);
+    
     // Load settings
     File settingsFile = new File(directory.getExtensionDirectory(), "settings.xml");
@@ -143 +149 @@
     lastScanResults = extensionsDir.installAndUpdateExtensions(registry, 
       servletContext, false, false);
+
     initAutoInstaller();
     initialised = true;

trunk/src/clients/web/net/sf/basedb/clients/web/taglib/extensions/Render.java

@@ -23 +23 @@
 package net.sf.basedb.clients.web.taglib.extensions;
 
+import java.io.IOException;
+
 import javax.servlet.jsp.JspException;
 import javax.servlet.jsp.tagext.TagSupport;
@@ -29 +31 @@
 import net.sf.basedb.util.extensions.ExtensionsInvoker;
 import net.sf.basedb.util.extensions.Renderer;
+import net.sf.basedb.util.extensions.WrappingRenderer;
 
 /**
@@ -41 +44 @@
       item=...
       renderer=...
+      wrapper=...
   />
 </pre>
@@ -82 +86 @@
     <td>no</td>
     <td>
-      The renderer to use. If not null, the 
-      {@link ExtensionsInvoker#render(net.sf.basedb.util.extensions.Renderer)}
-      method is used, otherwise {@link ExtensionsInvoker#renderDefault()}.
+      The {@link Renderer} to use. If not null, the 
+      {@link ExtensionsInvoker#render(Renderer)}
+      method is used, otherwise {@link ExtensionsInvoker#renderDefault()} 
+      or {@link ExtensionsInvoker#renderDefault(WrappingRenderer)}.
+    </td>
+  </tr>
+  <tr>
+    <td>wrapper</td>
+    <td>-</td>
+    <td>no</td>
+    <td>
+      The {@link WrappingRenderer} to use. If not null and no renderer
+      has been given, the {@link ExtensionsInvoker#renderDefault(WrappingRenderer)}
+      method is used.
     </td>
   </tr>
@@ -110 +125 @@
   private Renderer renderer = null;
   
+  // An optional wrapper 
+  private WrappingRenderer wrapper = null;
+  
   public void setExtensions(ExtensionsInvoker extensions)
   {
@@ -130 +148 @@
   }
 
+  public void setWrapper(WrappingRenderer wrapper)
+  {
+    this.wrapper = wrapper;
+  }
+  
   @SuppressWarnings("unchecked")
   public int doStartTag() 
@@ -135 +158 @@
   {
     if (item != null && context != null) context.setCurrentItem(item);
-    if (renderer == null)
+    try
     {
-      extensions.renderDefault();
+      if (renderer == null)
+      {
+        extensions.renderDefault(wrapper);
+      }
+      else if (wrapper != null)
+      {
+        wrapper.setParent(renderer);
+        extensions.render(wrapper);
+      }
+      else
+      {
+        extensions.render(renderer);
+      }
+      pageContext.getOut().print("</td>");
     }
-    else
+    catch (IOException ex)
     {
-      extensions.render(renderer);
+      throw new JspException(ex);
     }
     return SKIP_BODY;

trunk/src/clients/web/net/sf/basedb/clients/web/taglib/table/Button.java

@@ -23 +23 @@
 package net.sf.basedb.clients.web.taglib.table;
 
+import net.sf.basedb.clients.web.extensions.toolbar.ButtonAction;
+import net.sf.basedb.clients.web.extensions.toolbar.ToolbarButtonRenderer;
 import net.sf.basedb.clients.web.taglib.Page;
 
+import javax.servlet.http.HttpServletRequest;
 import javax.servlet.jsp.JspException;
 import javax.servlet.jsp.JspTagException;
+import javax.servlet.jsp.JspWriter;
 import javax.servlet.jsp.tagext.TagSupport;
 
@@ -42 +46 @@
       style=...
       image=...
-      imagealign=left|right
+      imagealign=left|right (no longer supported)
       onclick=...
       title=...
@@ -109 +113 @@
     <td>
       If the image should be aligned to the left or right of the text.
+      No longer supported.
     </td>
   </tr>
@@ -162 +167 @@
 public class Button
   extends TagSupport
+  implements ButtonAction
 {
 
@@ -308 +314 @@
   }
 
+  @Override
+  public String getIcon()
+  {
+    return ((HttpServletRequest)pageContext.getRequest()).getContextPath()+"/images/" + getImage();
+  }
+  @Override
+  public String getOnClick()
+  {
+    return getOnclick();
+  }
+  @Override
+  public boolean isEnabled()
+  {
+    return !isDisabled();
+  }
+  
   /*
     Display methods
@@ -319 +341 @@
     table = toolbar.getTable();
     Page page = table != null ? table.getPage() : (Page)findAncestorWithClass(this, Page.class);
-
     boolean displayImage = getImage() != null && toolbar.hasImages();
     boolean displayText = toolbar.hasText() || !displayImage;
-    
-    StringBuilder sb = new StringBuilder();
-    sb.append("<td");
-    if (getId() != null) sb.append(" id=\"").append(getId()).append("\"");
-    if (getClazz() != null)
-    {
-      sb.append(" class=\"").append(getClazz()).append(isDisabled() ? "_disabled" : "").append("\"");
-      if (!isDisabled())
-      {
-        sb.append(" onmouseover=\"this.className='").append(getClazz()).append("_hover';\"");
-        sb.append(" onmouseout=\"this.className='").append(getClazz()).append("';\"");
-      }
-    }
-    if (getOnclick() != null && !isDisabled()) sb.append(" onclick=\"").append(getOnclick()).append("\"");
-    if (getStyle() != null) sb.append(" style=\"").append(getStyle()).append("\"");
-    String tooltip = getTooltip();
-    if (!displayText && tooltip == null) tooltip = getTitle();
-    if (tooltip != null) sb.append(" title=\"").append(tooltip).append("\"");
-    sb.append(">");
-    if (displayImage)
-    {
-      sb.append("<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\"><tr>");
-      if ("left".equalsIgnoreCase(getImagealign()))
-      {
-        sb.append("<td><img src=\"").append(page.getRoot()).append("images/").append(getImage()).append("\"");
-        sb.append(" border=\"0\"></td>");
-      }
-      sb.append("<td>");
-    }
-    if (displayText && getTitle() != null) sb.append("&nbsp;").append(getTitle()).append("&nbsp;");
-    if (displayImage)
-    {
-      sb.append("</td>");
-      if (!"left".equalsIgnoreCase(getImagealign()))
-      {
-        sb.append("<td><img src=\"").append(page.getRoot()).append("images/").append(getImage()).append("\"");
-        sb.append(" border=\"0\"></td>");
-      }
-      sb.append("</tr></table>");
-    }
-    sb.append("</td>\n");
+  
+    String html = new ToolbarButtonRenderer().getHTML(this, displayText, displayImage);
     try
     {
-      pageContext.getOut().print(sb.toString());
+      JspWriter out = pageContext.getOut();
+      out.print("<td>" + html + "</td>");
     }
     catch (Exception ex)

trunk/src/core/net/sf/basedb/util/extensions/ExtensionsInvoker.java

@@ -93 +93 @@
   /**
     Render all actions using the renderers created by the
-    default renderer factory as specified by the registered 
+    default renderer factories as specified by the registered 
     extension points and/or extensions.
     @see ExtensionPoint#getRendererFactory()
@@ -99 +99 @@
   */
   public void renderDefault()
+  {
+    renderDefault(null);
+  }
+  
+  /**
+    Render all actions by wrapping the default renderers by the
+    given wrapping renderer. 
+    @param wrapper A wrapping renderer, or null to not wrap
+      the default renderers
+    @since 2.12
+  */
+  public void renderDefault(WrappingRenderer<A> wrapper)
   {
     ActionIterator<A> it = iterate();
@@ -114 +126 @@
           throw new NullPointerException("No renderer for extension: " + it.getExtension());
         }
+        if (wrapper != null)
+        {
+          wrapper.setParent(renderer);
+          renderer = wrapper;
+        }
         renderer.render(action);
       }
@@ -124 +141 @@
     }
   }
+
   
   /**

trunk/src/core/net/sf/basedb/util/extensions/Registry.java

@@ -518 +518 @@
     for (String id : extensionPointIds)
     {
+      if (id == null) continue;
+      
       // Find a registered extension point for each ID
       RegisteredExtensionPoint<Action> rep = 

trunk/www/WEB-INF/extensions.tld

@@ -85 +85 @@
       <rtexprvalue>true</rtexprvalue>
     </attribute>
+    <attribute>
+      <name>wrapper</name>
+      <required>false</required>
+      <rtexprvalue>true</rtexprvalue>
+    </attribute>
   </tag>
-
-
 </taglib>

trunk/www/WEB-INF/extensions/core-extensions.xml

@@ -53 +53 @@
       Extension point for the Tools column in the bioassayset tree
       view of an experiment. Extensions should provide ActionButton
-      instances. The default renderer factory is ActionButtonRendererFactory,
+      instances. The default renderer factory is CompactButtonRendererFactory,
       but this can be overridden by the extensions. Note that the tree 
       contains items of more than one type: BioAssaySet, Transformation and
@@ -79 +79 @@
     </description>
   </extension-point>
+  <!-- 
+    Toolbar extension points: 
+    In addition to the extension points in this file, the web
+    client also defines a lot of toolbar extension points for the
+    list and single-item view pages. Those extension points are registered
+    programmatically. For more information see Extensions -> Installed extensions
+    in the web client interface.
+  -->
   
 </extensions>

trunk/www/admin/extensions/details.jsp

@@ -60 +60 @@
   }
   String text = factory.getClass().getName();
-  String parameters = file.getFactoryParameters(factory);
+  String parameters = file == null ? null : file.getFactoryParameters(factory);
   if (parameters != null)
   {
@@ -396 +396 @@
           <td class="prompt">File</td>
           <td>
-            <a href="javascript:showFile('<%=HTML.javaScriptEncode(epFile.getName())%>')"
-            ><%=epFile.getName()%></a> 
-            (<%=epFile.isModified() ? "Modified" : "Up to date" %>;
-            <%=epFile.hasError() ? "Error" : "Ok" %>)
+            <%
+            if (epFile != null)
+            {
+              %>
+              <a href="javascript:showFile('<%=HTML.javaScriptEncode(epFile.getName())%>')"
+              ><%=epFile.getName()%></a> 
+              (<%=epFile.isModified() ? "Modified" : "Up to date" %>;
+              <%=epFile.hasError() ? "Error" : "Ok" %>)
+              <%
+            }
+            %>
           </td>
         </tr>

trunk/www/admin/extensions/tree.jsp

@@ -49 +49 @@
   String icon = ec.isEnabled(ep) ? "ExtensionPoint" : "ExtensionPointDisabled";
   ExtensionsFile f = ec.getFileByExtensionId(id);
-  if (f == null || f.hasError() || ec.getLastExtensionPointError(id) != null) 
+  if ((f != null && f.hasError()) || ec.getLastExtensionPointError(id) != null) 
   {
     icon = "ExtensionPointError";
@@ -65 +65 @@
   String icon = ec.isEnabled(ext) ? "Extension" : "ExtensionDisabled";
   ExtensionsFile f = ec.getFileByExtensionId(id);
-  if (f == null || f.hasError() || ec.getLastExtensionError(id) != null)
+  if ((f != null && f.hasError()) || ec.getLastExtensionError(id) != null)
   {
     icon = "ExtensionError";

trunk/www/include/styles/table.css

@@ -59 +59 @@
 }
 
-.itemlist .toolbar .button_hover {
+.itemlist .toolbar .button:hover {
   background: #F0F0F0;
-  border-top: 1px solid #FFFFFF;
-  border-left: 1px solid #FFFFFF;
-  border-bottom: 0px solid #999999;
-  border-right: 1px solid #999999;
-  padding: 3px;
-  cursor: pointer; 
 }
 

trunk/www/include/styles/toolbar.css

@@ -49 +49 @@
 }
 
+.toolbar .button:hover {
+  background: #F0F0F0;
+}
+
 .toolbar .label {
   font-weight: bold;
@@ -56 +60 @@
   border-right: 2px solid #999999;
   padding: 3px;
-}
-
-.toolbar .button_hover {
-  background: #F0F0F0;
-  border-top: 1px solid #FFFFFF;
-  border-left: 1px solid #FFFFFF;
-  border-bottom: 0px solid #999999;
-  border-right: 1px solid #999999;
-  padding: 3px;
-  cursor: pointer; 
 }
 

trunk/www/views/experiments/list_experiments.jsp

@@ -56 +56 @@
   import="net.sf.basedb.util.formatter.Formatter"
   import="net.sf.basedb.clients.web.formatter.FormatterFactory"
+  import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
+  import="net.sf.basedb.clients.web.extensions.JspContext"
+  import="net.sf.basedb.clients.web.extensions.renderer.PrefixSuffixRenderer"
+  import="net.sf.basedb.clients.web.extensions.toolbar.ToolbarUtil"
+  import="net.sf.basedb.util.extensions.ExtensionsInvoker"
   import="java.util.Iterator"
   import="java.util.List"
@@ -63 +68 @@
 <%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
 <%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
+<%@ taglib prefix="ext" uri="/WEB-INF/extensions.tld" %>
 <%!
   private static final Item itemType = Item.EXPERIMENT;
@@ -93 +99 @@
   int numListed = 0;
   Formatter<Date> dateFormatter = FormatterFactory.getDateFormatter(sc);
+  JspContext jspContext = ExtensionsControl.createContext(dc, pageContext);
+  ExtensionsInvoker invoker = ToolbarUtil.useExtensions(jspContext, guiContext);
   %>
   <base:page title="<%=title==null ? "Experiments" : title%>" type="<%=mode.getPageType()%>">
   <base:head scripts="menu.js,table.js" styles="menu.css,table.css">
+    <ext:scripts context="<%=jspContext%>" />
+    <ext:stylesheets context="<%=jspContext%>" />
     <script language="JavaScript">
     var submitPage = 'index.jsp';
@@ -445 +455 @@
           visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
         />
+        <ext:render extensions="<%=invoker%>" context="<%=jspContext%>" 
+          wrapper="<%=new PrefixSuffixRenderer(jspContext, "<td>", "</td>") %>"/>
       </tbl:toolbar>
       <tbl:navigator