source: trunk/src/clients/web/web-extensions.xml @ 5614

<?xml version="1.0" encoding="UTF-8" ?>
<!--
  $Id: web-extensions.xml 5609 2011-04-15 09:15:13Z nicklas $

  Copyright (C) Nicklas Nordborg

  This file is part of BASE - BioArray Software Environment.
  Available at http://base.thep.lu.se/

  BASE is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 3
  of the License, or (at your option) any later version.

  BASE is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with BASE. If not, see <http://www.gnu.org/licenses/>.
-->
<extensions
  xmlns="http://base.thep.lu.se/extensions.xsd"
  id-base="net.sf.basedb.clients.web."
  >
  <about>
    <version></version>
    <name>Web client extensions points and extensions</name>
    <description>
      This file defines extension points and extensions for
      the web client. The extensions are only loaded when BASE 
      starts up as a web server.
    </description>
    <copyright>BASE development team</copyright>
    <email>basedb-users@lists.sourceforge.net</email>
    <url>http://base.thep.lu.se/</url>
  </about>
  
  <extension-point
    id="menu.extensions"
    >
    <action-class>net.sf.basedb.clients.web.extensions.menu.MenuItemAction</action-class>
    <name>Menu: extensions</name>
    <description>
      Extension point for adding extensions to the 'Extensions' menu.
      Extensions should provide MenuItemAction instances. The rendering
      is internal and extensions can't use their own rendering factories.
      The context will only include information about the currently logged
      in user, not information about the current page that is displayed.
      The reason for this is that the rendered menu is cached as a string
      in the user session. The menu is not updated on every page request.
      This extension point doesn't support custom stylesheets or javascripts.
    </description>
  </extension-point>
  
  <extension-point 
    id="bioassayset.list.tools"
    >
    <action-class>net.sf.basedb.clients.web.extensions.toolbar.ButtonAction</action-class>
    <renderer-factory override="true">
      <factory-class>net.sf.basedb.clients.web.extensions.toolbar.CompactButtonRendererFactory</factory-class>
    </renderer-factory>
    <name>Bioassay set: Tools</name>
    <description>
      Extension point for the Tools column in the bioassayset tree
      view of an experiment. Extensions should provide ActionButton
      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
      ExtraValue. The JspContext.getItem() can return any one of those
      types.
    </description>
  </extension-point>

  <extension-point 
    id="bioassayset.overviewplots"
    >
    <action-class>net.sf.basedb.clients.web.extensions.plot.OverviewPlotAction</action-class>
    <name>Bioassay set: Overview plots</name>
    <description>
      Extension point for overview plots for a bioassay set. The overview
      plots are usually one pre-defined plot per bioassay. For example,
      MA plots for 2-channel data. Extensions should provide OverviewPlotAction
      instances. The rendering is internal and generates one &lt;img&gt; tag
      for each plot. An extension is supposed to generate the image URL that
      leads to a servlet that creates the actual image. We recommend that
      images are cached. See the core plot servlet for details.
    </description>
  </extension-point>
  
  <extension-point
    id="services"
    >
    <action-class>net.sf.basedb.clients.web.extensions.service.ServiceControllerAction</action-class>
    <name>Services</name>
    <description>
      Extension point for services. A service is a piece of code that
      is loaded when the BASE web server starts up. The service is then running
      as long as the BASE web server is running. It is also possible to
      manually stop and start services. This extension point is different from 
      most others in that it doesn't affects the visible interface. Since 
      services are loaded at startup time, this also means that the
      context passed to ActionFactory methods will not have any ClientContext
      associated with it (eg. the InvokationContext.getClientContext() 
      always return null). There is also no meaning for extensions to specify 
      a RendererFactory.
    </description>
    <error-handler-factory>
      <factory-class>net.sf.basedb.util.extensions.LoggingErrorHandlerFactory</factory-class>
      <parameters>
        <rememberLast>true</rememberLast>
      </parameters>
    </error-handler-factory>
  </extension-point>

  <!-- 
    More extension points: 
    In addition to the extension points in this file, the web
    client also defines a lot of other extension points that are
    registered programmatically. For more information see 
    Extensions -> Installed extensions in the web client interface.
    
     * Toolbar extension points: Adds buttons to toolbars in
       list and single-item view pages.
     * Edit dialog: Adds extra tabs to edit dialogs
     * OnSave: Add callback functionality when saving from an edit dialog
  -->
  
  <extension
    id="bioassayset.overviewplots.maplot"
    extends="net.sf.basedb.clients.web.bioassayset.overviewplots"
    >
    <index>1</index>
    <about>
      <name>MA/Correction factor plots</name>
      <description>
        Generates MA and correction factor plots for
        2-channel data.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.plot.MAPlotFactory
      </factory-class>
      <parameters>
        <width>400</width>
        <height>300</height>
        <plotServlet>/views/experiments/plotter/plot</plotServlet>
      </parameters>
    </action-factory>
  </extension>
  
</extensions>