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