source: trunk/www/biomaterials/bioplates/list_bioplates.jsp @ 4882

Last change on this file since 4882 was 4882, checked in by Nicklas Nordborg, 13 years ago

References #1271: Add extension points to all toolbars

Added code for displaying extensions to all biomaterial pages.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 18.7 KB
Line 
1<%-- $Id: list_bioplates.jsp 4882 2009-04-03 10:53:42Z nicklas $
2  ------------------------------------------------------------------
3  Copyright (C) 2006 Jari Hakkinen, Nicklas Nordborg, Martin Svensson
4  Copyright (C) 2007 Johan Enell, Martin Svensson
5
6  This file is part of BASE - BioArray Software Environment.
7  Available at http://base.thep.lu.se/
8
9  BASE is free software; you can redistribute it and/or
10  modify it under the terms of the GNU General Public License
11  as published by the Free Software Foundation; either version 3
12  of the License, or (at your option) any later version.
13
14  BASE is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  GNU General Public License for more details.
18
19  You should have received a copy of the GNU General Public License
20  along with BASE. If not, see <http://www.gnu.org/licenses/>.
21  ------------------------------------------------------------------
22
23  @author Nicklas
24  @version 2.0
25--%>
26<%@ page session="false"
27  import="net.sf.basedb.core.SessionControl"
28  import="net.sf.basedb.core.DbControl"
29  import="net.sf.basedb.core.Item"
30  import="net.sf.basedb.core.AnnotationType"
31  import="net.sf.basedb.core.AnnotationSet"
32  import="net.sf.basedb.core.Annotation"
33  import="net.sf.basedb.core.BioPlate"
34  import="net.sf.basedb.core.PlateGeometry"
35  import="net.sf.basedb.core.ItemQuery"
36  import="net.sf.basedb.core.Include"
37  import="net.sf.basedb.core.Type"
38  import="net.sf.basedb.core.ItemResultIterator"
39  import="net.sf.basedb.core.ItemResultList"
40  import="net.sf.basedb.core.ItemContext"
41  import="net.sf.basedb.core.Nameable"
42  import="net.sf.basedb.core.Permission"
43  import="net.sf.basedb.core.PluginDefinition"
44  import="net.sf.basedb.core.query.Hql"
45  import="net.sf.basedb.core.query.Restrictions"
46  import="net.sf.basedb.core.query.Expressions"
47  import="net.sf.basedb.core.plugin.GuiContext"
48  import="net.sf.basedb.core.plugin.Plugin"
49  import="net.sf.basedb.core.query.Orders"
50  import="net.sf.basedb.core.query.Hql"
51  import="net.sf.basedb.util.Enumeration"
52  import="net.sf.basedb.util.ShareableUtil"
53  import="net.sf.basedb.clients.web.Base"
54  import="net.sf.basedb.clients.web.ModeInfo"
55  import="net.sf.basedb.clients.web.PermissionUtil"
56  import="net.sf.basedb.clients.web.util.HTML"
57  import="net.sf.basedb.util.formatter.Formatter"
58  import="net.sf.basedb.clients.web.formatter.FormatterFactory"
59  import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
60  import="net.sf.basedb.clients.web.extensions.JspContext"
61  import="net.sf.basedb.clients.web.extensions.renderer.PrefixSuffixRenderer"
62  import="net.sf.basedb.clients.web.extensions.toolbar.ToolbarUtil"
63  import="net.sf.basedb.util.extensions.ExtensionsInvoker"
64  import="net.sf.basedb.util.Values"
65  import="java.util.Iterator"
66  import="java.util.List"
67  import="java.util.Map"
68%>
69<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
70<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
71<%@ taglib prefix="ext" uri="/WEB-INF/extensions.tld" %>
72<%!
73  private static final Item itemType = Item.BIOPLATE;
74  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.LIST);
75%>
76<%
77final SessionControl sc = Base.getExistingSessionControl(pageContext, Permission.DENIED, itemType);
78final String ID = sc.getId();
79final boolean createPermission = sc.hasPermission(Permission.CREATE, itemType);
80final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
81
82final ModeInfo mode = ModeInfo.get(request.getParameter("mode"));
83final String callback = request.getParameter("callback");
84final String title = mode.generateTitle("bioplate", "bioplates");
85final DbControl dc = sc.newDbControl();
86ItemResultIterator<BioPlate> bioplates = null;
87ItemResultList<AnnotationType> annotationTypes = null;
88try
89{
90  final ItemQuery<AnnotationType> annotationTypeQuery = Base.getAnnotationTypesQuery(itemType);
91 
92  final ItemQuery<PlateGeometry> geometryQuery = PlateGeometry.getQuery();
93  geometryQuery.order(Orders.asc(Hql.property("name")));
94  geometryQuery.setCacheResult(true);
95 
96  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
97  annotationTypes = annotationTypeQuery.list(dc);
98  try
99  {
100    final ItemQuery<BioPlate> query = Base.getConfiguredQuery(dc, cc, true, BioPlate.getQuery(), mode);
101    bioplates = query.iterate(dc);
102  }
103  catch (Throwable t)
104  {
105    cc.setMessage(t.getMessage());
106    t.printStackTrace();
107  }
108  int numListed = 0;
109  JspContext jspContext = ExtensionsControl.createContext(dc, pageContext, guiContext, null);
110  ExtensionsInvoker invoker = ToolbarUtil.useExtensions(jspContext);
111  %>
112  <base:page title="<%=title==null ? "Bioplates" : title%>" type="<%=mode.getPageType()%>">
113  <base:head scripts="menu.js,table.js" styles="menu.css,table.css">
114    <ext:scripts context="<%=jspContext%>" />
115    <ext:stylesheets context="<%=jspContext%>" />
116    <script language="JavaScript">
117    var submitPage = 'index.jsp';
118    var formId = 'bioplates';
119    function newItem()
120    {
121      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', 0, true);
122    }
123    function editItem(itemId)
124    {
125      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, true);
126    }
127    function viewItem(itemId)
128    {
129      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, false);
130    }
131    function itemOnClick(evt, itemId)
132    {
133      Table.itemOnClick(formId, evt, itemId, '<%=mode.getName()%>', viewItem, editItem, returnSelected);
134    }
135    function deleteItems()
136    {
137      var frm = document.forms[formId];
138      if (Forms.numChecked(frm) == 0)
139      {
140        alert('Please select at least one item in the list');
141        return;
142      }
143      frm.action = submitPage;
144      frm.cmd.value = 'DeleteItems';
145      frm.submit();
146    }
147    function restoreItems()
148    {
149      var frm = document.forms[formId];
150      if (Forms.numChecked(frm) == 0)
151      {
152        alert('Please select at least one item in the list');
153        return;
154      }
155      frm.action = submitPage;
156      frm.cmd.value = 'RestoreItems';
157      frm.submit();
158    }
159    function deleteItemPermanently(itemId)
160    {
161      Main.deleteItemPermanently('<%=ID%>', true, '<%=itemType.name()%>', itemId);
162    }
163    function setOwner()
164    {
165      Table.setOwnerOfItems(submitPage, '<%=ID%>', formId, '<%=itemType.name()%>', 'SetOwnerOfItems');
166    }
167    function shareItem(itemId)
168    {
169      Main.openPopup('index.jsp?ID=<%=ID%>&cmd=ShareItem&item_id='+itemId, 'ShareBioPlates', 600, 400);
170    }
171    function shareItems()
172    {
173      Table.shareItems(submitPage, '<%=ID%>', formId, '<%=itemType.name()%>', 'ShareItems');
174    }
175    function configureColumns()
176    {
177      Table.configureColumns('<%=ID%>', formId, '<%=itemType.name()%>', '<%=(String)cc.getObject("defaultColumns")%>');
178    }
179    function runPlugin(cmd)
180    {
181      Table.submitToPopup(formId, cmd, 740, 540);
182    }
183    function returnSelected()
184    {
185      Table.returnSelected(formId, <%=callback != null ? "window.opener."+callback : "null" %>);
186      window.close();
187    }
188    function presetOnChange()
189    {
190      Table.presetOnChange('<%=ID%>', formId, '<%=itemType.name()%>', '<%=(String)cc.getObject("defaultColumns")%>');
191    }
192    </script>
193  </base:head> 
194  <base:body>
195    <%
196    if (cc.getMessage() != null)
197    {
198      %>
199      <div class="error"><%=cc.getMessage()%></div>
200      <%
201      cc.setMessage(null);
202    }
203    %>
204    <tbl:table 
205      id="bioplates" 
206      clazz="itemlist" 
207      columns="<%=cc.getSetting("columns")%>"
208      sortby="<%=cc.getSortProperty()%>" 
209      direction="<%=cc.getSortDirection()%>"
210      title="<%=title%>"
211      action="index.jsp"
212      sc="<%=sc%>"
213      item="<%=itemType%>"
214      >
215      <tbl:hidden 
216        name="mode" 
217        value="<%=mode.getName()%>" 
218      />
219      <tbl:hidden 
220        name="callback" 
221        value="<%=callback%>" 
222        skip="<%=callback == null%>" 
223      />
224      <tbl:columndef 
225        id="name"
226        property="name"
227        datatype="string"
228        title="Name"
229        sortable="true" 
230        filterable="true"
231        exportable="true"
232        show="always" 
233      />
234      <tbl:columndef 
235        id="id"
236        clazz="uniquecol"
237        property="id"
238        datatype="int"
239        title="ID"
240        sortable="true"
241        filterable="true"
242        exportable="true"
243      />
244      <tbl:columndef 
245        id="barcode"
246        property="barcode"
247        datatype="string"
248        title="Barcode"
249        sortable="true" 
250        filterable="true"
251        exportable="true"
252      />
253     
254      <%
255      Enumeration<String, String> geometries = new Enumeration<String, String>();
256      ItemResultList<PlateGeometry> plateGeometries = geometryQuery.list(dc);
257      for (PlateGeometry pg : plateGeometries)
258      {
259        geometries.add(Integer.toString(pg.getId()), HTML.encodeTags(pg.getName()));
260      }
261      %>
262      <tbl:columndef 
263        id="plateGeometry"
264        property="plateType.plateGeometry"
265        sortproperty="plateType.plateGeometry.name"
266        exportproperty="plateType.plateGeometry.name"
267        datatype="int"
268        enumeration="<%=geometries%>"
269        title="Geometry"
270        sortable="true" 
271        filterable="true"
272        exportable="true"
273      />
274      <tbl:columndef 
275        id="freezer"
276        property="freezer.name"
277        datatype="string"
278        title="Freezer"
279        sortable="true" 
280        filterable="true"
281        exportable="true"
282      />
283      <tbl:columndef 
284        id="owner"
285        property="owner.name"
286        datatype="string"
287        title="Owner"
288        sortable="true" 
289        filterable="true"
290        exportable="true"
291      />
292      <tbl:columndef 
293        id="description"
294        property="description"
295        datatype="string"
296        title="Description" 
297        sortable="true" 
298        filterable="true" 
299        exportable="true"
300      />     
301      <%
302      for (AnnotationType at : annotationTypes)
303      {
304        Formatter formatter = FormatterFactory.getTypeFormatter(sc, at.getValueType());
305        Enumeration<String, String> annotationEnum = null;
306        if (at.isEnumeration())
307        {
308          annotationEnum = new Enumeration<String, String>();
309          List<?> values = at.getValues();
310          for (Object value : values)
311          {
312            String encoded = formatter.format(value);
313            annotationEnum.add(encoded, encoded);
314          }
315        }
316        %>
317        <tbl:columndef 
318          id="<%="at"+at.getId()%>"
319          title="<%=HTML.encodeTags(at.getName())+" [A]"%>" 
320          property="<%="#"+at.getId()%>"
321          annotation="true"
322          datatype="<%=at.getValueType().getStringValue()%>"
323          enumeration="<%=annotationEnum%>"
324          sortable="false" 
325          filterable="true" 
326          exportable="true"
327          formatter="<%=formatter%>"
328          unit="<%=at.getDefaultUnit()%>"
329        />
330        <%
331      }
332      %>
333      <tbl:columndef
334        id="permission"
335        title="Permission"
336      />
337      <tbl:columndef 
338        id="sharedTo" 
339        title="Shared to" 
340      />
341      <tbl:toolbar
342        visible="<%=mode.hasToolbar()%>"
343        >
344        <tbl:button 
345          disabled="<%=createPermission ? false : true%>" 
346          image="<%=createPermission ? "new.gif" : "new_disabled.gif"%>" 
347          onclick="newItem()" 
348          title="New&hellip;" 
349          tooltip="<%=createPermission ? "Create new bioplate" : "You do not have permission to create bioplate"%>" 
350        />
351        <tbl:button 
352          image="delete.gif"
353          onclick="deleteItems()" 
354          title="Delete" 
355          tooltip="Delete the selected items" 
356        />
357        <tbl:button 
358          image="restore.gif"
359          onclick="restoreItems()" 
360          title="Restore" 
361          tooltip="Restore the selected (deleted) items"
362        />
363        <tbl:button 
364          image="share.gif"
365          onclick="shareItems()" 
366          title="Share&hellip;" 
367          tooltip="Share the selected items"
368        />
369        <tbl:button 
370          image="take_ownership.png"
371          onclick="setOwner()" 
372          title="Set owner&hellip;"
373          tooltip="Change owner of the selected items"
374        />
375        <tbl:button 
376          image="columns.gif" 
377          onclick="configureColumns()" 
378          title="Columns&hellip;" 
379          tooltip="Show, hide and re-order columns" 
380        />
381        <tbl:button 
382          image="import.gif" 
383          onclick="runPlugin('ImportItems')" 
384          title="Import&hellip;" 
385          tooltip="Import data" 
386          visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
387        />
388        <tbl:button 
389          image="export.gif" 
390          onclick="runPlugin('ExportItems')" 
391          title="Export&hellip;" 
392          tooltip="Export data" 
393          visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
394        />
395        <tbl:button 
396          image="runplugin.gif" 
397          onclick="runPlugin('RunListPlugin')" 
398          title="Run plugin&hellip;" 
399          tooltip="Run a plugin" 
400          visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
401        />
402        <ext:render extensions="<%=invoker%>" context="<%=jspContext%>" 
403          wrapper="<%=new PrefixSuffixRenderer(jspContext, "<td>", "</td>") %>"/>
404      </tbl:toolbar>
405      <tbl:navigator
406        page="<%=cc.getPage()%>" 
407        rowsperpage="<%=cc.getRowsPerPage()%>" 
408        totalrows="<%=bioplates == null ? 0 : bioplates.getTotalCount()%>" 
409        visible="<%=mode.hasNavigator()%>"
410      />
411      <tbl:data>
412        <tbl:columns>
413        <tbl:presetselector 
414          clazz="columnheader"
415          colspan="3"
416          onchange="presetOnChange()"
417        />
418        </tbl:columns>
419
420        <tr>
421          <tbl:header 
422            clazz="index"
423            >&nbsp;</tbl:header>
424          <tbl:header 
425            clazz="check" 
426            visible="<%=mode.hasCheck()%>"
427            ><base:icon 
428              image="check_uncheck.gif" 
429              tooltip="Check/uncheck all" 
430              onclick="Forms.checkUncheck(document.forms[formId])" style="align: left;"
431            /></tbl:header>
432          <tbl:header 
433            clazz="check" 
434            visible="<%=mode.hasRadio()%>"
435            >&nbsp;</tbl:header>
436          <tbl:header 
437            clazz="icons" 
438            visible="<%=mode.hasIcons()%>"
439            >&nbsp;</tbl:header>
440          <tbl:propertyfilter />
441        </tr>
442         
443          <tbl:rows>
444          <%
445          int index = cc.getPage()*cc.getRowsPerPage();
446          int selectedItemId = cc.getId();
447          if (bioplates != null)
448          {
449            while (bioplates.hasNext())
450            {
451              BioPlate item = bioplates.next();
452              int itemId = item.getId();
453              String openSharePopup = "shareItem("+itemId+")";
454              String deletePermanently = "deleteItemPermanently("+itemId+")";
455              boolean deletePermission = item.hasPermission(Permission.DELETE);
456              boolean sharePermission = item.hasPermission(Permission.SET_PERMISSION);
457              boolean writePermission = item.hasPermission(Permission.WRITE);
458              String tooltip = mode.isSelectionMode() ? 
459                  "Select this item" : "View this item" + (writePermission ? " (use CTRL, ALT or SHIFT to edit)" : "");
460              String name = HTML.encodeTags(item.getName());
461              index++;
462              numListed++;
463              %>
464              <tbl:row>
465                <tbl:header 
466                  clazz="index"
467                  ><%=index%></tbl:header>
468                <tbl:header 
469                  clazz="check" 
470                  visible="<%=mode.hasCheck()%>"
471                  ><input 
472                    type="checkbox" 
473                    name="<%=itemId%>" 
474                    value="<%=itemId%>" 
475                    title="<%=name%>" 
476                    <%=cc.getSelected().contains(itemId) ? "checked" : ""%> 
477                  ></tbl:header>
478                <tbl:header 
479                  clazz="check" 
480                  visible="<%=mode.hasRadio()%>"
481                  ><input 
482                    type="radio" 
483                    name="item_id" 
484                    value="<%=itemId%>" 
485                    title="<%=name%>" 
486                    <%=selectedItemId == itemId ? "checked" : ""%>
487                  ></tbl:header>
488                <tbl:header 
489                  clazz="icons" 
490                  visible="<%=mode.hasIcons()%>"
491                  ><base:icon 
492                    image="<%=deletePermission ? "deleted.gif" : "deleted_disabled.gif"%>"
493                    onclick="<%=deletePermission ? deletePermanently : null%>"
494                    tooltip="This item has been scheduled for deletion" 
495                    visible="<%=item.isRemoved()%>"
496                  /><base:icon 
497                    image="<%=sharePermission ? "shared.gif" : "shared_disabled.gif"%>" 
498                    onclick="<%=sharePermission ? openSharePopup : null%>"
499                    tooltip="This item is shared to other users, groups and/or projects" 
500                    visible="<%=item.isShared()%>"
501                  />&nbsp;</tbl:header>
502                <tbl:cell column="name"><div class="link" 
503                  onclick="itemOnClick(<%=writePermission ? "event" : null%>, <%=itemId%>)" 
504                  title="<%=tooltip%>"><%=name%></div></tbl:cell>
505                <tbl:cell column="id"><%=item.getId()%></tbl:cell>
506                <tbl:cell column="barcode"><%=HTML.encodeTags(item.getBarcode())%></tbl:cell>
507                <tbl:cell column="owner"
508                  ><base:propertyvalue 
509                    item="<%=item%>" 
510                    property="owner"
511                    enableEditLink="<%=mode.hasEditLink()%>" 
512                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
513                  /></tbl:cell>
514                <tbl:cell column="plateGeometry"
515                  ><base:propertyvalue 
516                    item="<%=item%>" 
517                    property="plateGeometry"
518                    enableEditLink="<%=mode.hasEditLink()%>" 
519                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
520                  /></tbl:cell>
521                <tbl:cell column="freezer">
522                  <base:propertyvalue 
523                    item="<%=item%>" 
524                    property="freezer"
525                    enableEditLink="<%=mode.hasEditLink()%>" 
526                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
527                  />
528                </tbl:cell>
529                <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>               
530                <%
531                AnnotationSet as = item.isAnnotated() ? item.getAnnotationSet() : null;
532                if (as != null)
533                {
534                  for (AnnotationType at : annotationTypes)
535                  {
536                    if (as.hasAnnotation(at))
537                    {
538                      Annotation a = as.getAnnotation(at);
539                      String suffix = a.getUnitSymbol(null);
540                      if (suffix != null) suffix = "&nbsp;" + suffix;
541                      %>
542                      <tbl:cell 
543                        column="<%="at"+at.getId()%>"
544                        ><tbl:cellvalue 
545                          list="<%=a.getValues(null)%>"
546                          suffix="<%=suffix%>"
547                      /></tbl:cell>
548                      <%
549                    }
550                  }
551                }
552                %>
553                <tbl:cell column="permission"><%=PermissionUtil.getShortPermissions(item)%></tbl:cell>
554                <tbl:cell column="sharedTo">
555                  <%
556                  Iterator<Nameable> sharees = ShareableUtil.getSharedTo(dc, item).iterator();
557                  while(sharees.hasNext())
558                  {
559                    Nameable n = sharees.next();
560                    if (mode.hasPropertyLink())
561                    {
562                      out.write(Base.getLinkedName(ID, n, false, mode.hasEditLink()));
563                    }
564                    else
565                    {
566                      out.write(HTML.encodeTags(n.getName()));
567                    }
568                    out.write(sharees.hasNext() ? ", " : "");
569                  }
570                  %>
571                </tbl:cell>
572              </tbl:row>
573              <%
574              }
575            }
576          %>
577          </tbl:rows>
578      </tbl:data>
579      <%
580      if (numListed == 0)
581      {
582        %>
583        <tbl:panel><%=bioplates == null || bioplates.getTotalCount() == 0 ? "No plates were found" : "No plates on this page. Please select another page!" %></tbl:panel>
584        <%
585      }
586      else
587      {
588        %>
589        <tbl:navigator
590          page="<%=cc.getPage()%>" 
591          rowsperpage="<%=cc.getRowsPerPage()%>" 
592          totalrows="<%=bioplates == null ? 0 : bioplates.getTotalCount()%>" 
593          visible="<%=mode.hasNavigator()%>"
594          locked="true"
595        />
596        <%
597      }
598      %>
599    </tbl:table>
600    <base:buttongroup align="center" clazz="fixedatbottom">
601      <base:button onclick="returnSelected();" title="Ok" visible="<%=mode.hasOkButton()%>" />
602      <base:button onclick="window.close();" title="Cancel" visible="<%=mode.hasCancelButton()%>" />
603      <base:button onclick="window.close();" title="Close" visible="<%=mode.hasCloseButton()%>" />
604    </base:buttongroup>
605    <br><br><br>
606  </base:body>
607  </base:page>
608  <%
609}
610finally
611{
612  if (bioplates != null) bioplates.close();
613  if (dc != null) dc.close();
614}
615%>
Note: See TracBrowser for help on using the repository browser.