source: trunk/www/admin/clients/help/list_help.jsp @ 3312

Last change on this file since 3312 was 3312, checked in by Nicklas Nordborg, 14 years ago

Added column to help list that displays help as html.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 12.5 KB
Line 
1<%-- $Id: list_help.jsp 3312 2007-05-09 11:03:58Z nicklas $
2  ------------------------------------------------------------------
3  Copyright (C) Authors contributing to this file.
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
9  modify it under the terms of the GNU General Public License
10  as published by the Free Software Foundation; either version 2
11  of the License, or (at your option) any later version.
12
13  BASE is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  GNU General Public License for more details.
17
18  You should have received a copy of the GNU General Public License
19  along with this program; if not, write to the Free Software
20  Foundation, Inc., 59 Temple Place - Suite 330,
21  Boston, MA  02111-1307, USA.
22  ------------------------------------------------------------------
23
24  @author Nicklas
25  @version 2.0
26--%>
27<%@ page session="false"
28  import="net.sf.basedb.core.SessionControl"
29  import="net.sf.basedb.core.DbControl"
30  import="net.sf.basedb.core.Item"
31  import="net.sf.basedb.core.ItemContext"
32  import="net.sf.basedb.core.Client"
33  import="net.sf.basedb.core.Help"
34  import="net.sf.basedb.core.ItemQuery"
35  import="net.sf.basedb.core.ItemResultIterator"
36  import="net.sf.basedb.core.Permission"
37  import="net.sf.basedb.core.PluginDefinition"
38  import="net.sf.basedb.core.PermissionDeniedException"
39  import="net.sf.basedb.core.query.Restrictions"
40  import="net.sf.basedb.core.query.Expressions"
41  import="net.sf.basedb.core.query.Orders"
42  import="net.sf.basedb.core.query.Hql"
43  import="net.sf.basedb.core.plugin.GuiContext"
44  import="net.sf.basedb.core.plugin.Plugin"
45  import="net.sf.basedb.clients.web.Base"
46  import="net.sf.basedb.clients.web.PermissionUtil"
47  import="net.sf.basedb.clients.web.ModeInfo"
48  import="net.sf.basedb.clients.web.util.HTML"
49  import="net.sf.basedb.util.Values"
50  import="java.util.List"
51  import="java.util.Map"
52%>
53<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
54<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
55<%@ taglib prefix="t" uri="/WEB-INF/tab.tld" %>
56<%@ taglib prefix="p" uri="/WEB-INF/path.tld" %>
57<%!
58  private static final Item itemType = Item.HELP;
59  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.LIST);
60%>
61<%
62final int clientId = Values.getInt(request.getParameter("client_id"));
63final SessionControl sc = Base.getExistingSessionControl(pageContext, Permission.DENIED, itemType);
64final String ID = sc.getId();
65final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
66
67final ModeInfo mode = ModeInfo.get(request.getParameter("mode"));
68final String callback = request.getParameter("callback");
69final String title = mode.generateTitle("help", "help");
70final DbControl dc = sc.newDbControl();
71ItemResultIterator<Help> help = null;
72try
73{
74  final Client client = Client.getById(dc, clientId);
75  final boolean createPermission = client.hasPermission(Permission.WRITE);
76  final boolean deletePermission = createPermission;
77
78
79  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
80  try
81  {
82    final ItemQuery<Help> query = Base.getConfiguredQuery(cc, true, client.getHelp(), mode);
83    help = query.iterate(dc);
84  }
85  catch (Throwable t)
86  {
87    cc.setMessage(t.getMessage());
88  }
89  int numListed = 0;
90  %>
91  <base:page title="<%=title%>" type="<%=mode.getPageType()%>">
92  <base:head scripts="table.js,tabcontrol.js" styles="table.css,headertabcontrol.css,path.css,help.css">
93    <script language="JavaScript">
94    var submitPage = 'index.jsp';
95    var formId = 'help';
96    function newItem()
97    {
98      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', 0, true, '&client_id=<%=clientId%>');
99//      Main.openPopup('index.jsp?ID=<%=ID%>&cmd=NewItem&client_id=<%=clientId%>', 'NewHelp', 600, 400);
100    }
101    function editItem(itemId)
102    {
103      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, true);
104    }
105    function viewItem(itemId)
106    {
107      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, false);
108    }
109    function itemOnClick(evt, itemId)
110    {
111      Table.itemOnClick(formId, evt, itemId, '<%=mode.getName()%>', viewItem, editItem, returnSelected);
112    }
113    function deleteItems()
114    {
115      var frm = document.forms[formId];
116      var numChecked = Forms.numChecked(frm);
117      if (numChecked == 0)
118      {
119        alert('Please select at least one item in the list');
120        return;
121      }
122      else
123      {
124        var rep = numChecked == 1 ? 'help text' : 'help texts';
125        if (!confirm('You are about to delete '+numChecked+' '+rep+'. This can\'t be undone. Continue?'))
126        {
127          return;
128        }
129      }
130      frm.action = submitPage;
131      frm.cmd.value = 'DeleteItems';
132      frm.submit();
133    }
134    function configureColumns()
135    {
136      Table.configureColumns('<%=ID%>', formId, '<%=itemType.name()%>', '<%=(String)cc.getObject("defaultColumns")%>');
137    }
138    function runPlugin(cmd)
139    {
140      Table.submitToPopup(formId, cmd, 740, 540);
141    }
142    function returnSelected()
143    {
144      Table.returnSelected(formId, <%=callback != null ? "window.opener."+callback : "null" %>);
145      window.close();
146    }
147    function presetOnChange()
148    {
149      Table.presetOnChange('<%=ID%>', formId, '<%=itemType.name()%>', '<%=(String)cc.getObject("defaultColumns")%>');
150    }
151    function switchTab(tabControlId, tabId)
152    {
153      if (tabId == 'properties')
154      {
155        location.href = '../index.jsp?ID=<%=ID%>&cmd=ViewItem&item_id=<%=clientId%>';
156      }
157      else
158      {
159        TabControl.setActiveTab(tabControlId, tabId);
160      }
161    }
162    </script>
163  </base:head>
164 
165  <base:body>
166    <p>
167    <p:path>
168      <p:pathelement title="Client applications" href="<%="../index.jsp?ID="+ID%>" />
169      <p:pathelement title="<%=HTML.encodeTags(client.getName())%>" />
170    </p:path>
171
172    <t:tabcontrol id="main" active="help" switch="switchTab">
173    <t:tab id="properties" title="Properties" />
174   
175    <t:tab id="help" title="Help texts">
176   
177    <%
178    if (cc.getMessage() != null)
179    {
180      %>
181      <div class="error"><%=cc.getMessage()%></div>
182      <%
183      cc.setMessage(null);
184    }
185    %>
186    <tbl:table 
187      id="help" 
188      clazz="itemlist" 
189      columns="<%=cc.getSetting("columns")%>"
190      sortby="<%=cc.getSortProperty()%>" 
191      direction="<%=cc.getSortDirection()%>"
192      title="<%=title%>"
193      action="index.jsp"
194      sc="<%=sc%>"
195      item="<%=itemType%>"
196      >
197      <tbl:hidden 
198        name="mode" 
199        value="<%=mode.getName()%>" 
200      />
201      <tbl:hidden 
202        name="client_id" 
203        value="<%=String.valueOf(clientId)%>" 
204      />
205      <tbl:hidden 
206        name="callback" 
207        value="<%=callback%>" 
208        skip="<%=callback == null%>" 
209      />
210      <tbl:columndef 
211        id="name"
212        property="name"
213        datatype="string"
214        title="Title"
215        sortable="true" 
216        filterable="true"
217        exportable="true"
218        show="always" 
219      />
220      <tbl:columndef 
221        id="externalId"
222        property="externalId"
223        datatype="string"
224        title="External ID"
225        sortable="true" 
226        filterable="true"
227        exportable="true"
228      />
229      <tbl:columndef 
230        id="description"
231        property="description"
232        datatype="string"
233        title="Help text" 
234        sortable="true" 
235        filterable="true" 
236        exportable="true"
237      />
238      <tbl:columndef 
239        id="description.html"
240        property="description"
241        datatype="string"
242        title="Help text (as HTML)" 
243        sortable="false" 
244        filterable="false" 
245        exportable="false"
246      />
247      <tbl:toolbar
248        visible="<%=mode.hasToolbar()%>"
249        >
250        <tbl:button 
251          disabled="<%=createPermission ? false : true%>" 
252          image="<%=createPermission ? "new.gif" : "new_disabled.gif"%>" 
253          onclick="newItem()" 
254          title="New&hellip;" 
255          tooltip="<%=createPermission ? "Create new help" : "You do not have permission to create help"%>" 
256        />
257        <tbl:button 
258          disabled="<%=deletePermission ? false : true%>" 
259          image="<%=deletePermission ? "delete.gif" : "delete_disabled.gif"%>" 
260          title="Delete&hellip;"
261          onclick="deleteItems()" 
262          tooltip="<%=deletePermission ? "Delete the selected help" : "You do not have permission to delete help"%>" 
263        />
264        <tbl:button 
265          image="columns.gif" 
266          onclick="configureColumns()" 
267          title="Columns&hellip;" 
268          tooltip="Show, hide and re-order columns" 
269        />
270        <tbl:button 
271          image="import.gif" 
272          onclick="runPlugin('ImportItems')" 
273          title="Import&hellip;" 
274          tooltip="Import data" 
275          visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
276        />
277        <tbl:button 
278          image="export.gif" 
279          onclick="runPlugin('ExportItems')" 
280          title="Export&hellip;" 
281          tooltip="Export data" 
282          visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
283        />
284        <tbl:button 
285          image="runplugin.gif" 
286          onclick="runPlugin('RunListPlugin')" 
287          title="Run plugin&hellip;" 
288          tooltip="Run a plugin" 
289          visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
290        />
291      </tbl:toolbar>
292      <tbl:navigator
293        page="<%=cc.getPage()%>" 
294        rowsperpage="<%=cc.getRowsPerPage()%>" 
295        totalrows="<%=help == null ? 0 : help.getTotalCount()%>" 
296        visible="<%=mode.hasNavigator()%>"
297      />
298      <tbl:data>
299        <tbl:columns>
300        <tbl:presetselector 
301          clazz="columnheader"
302          colspan="3"
303          onchange="presetOnChange()"
304        />
305        </tbl:columns>
306         
307        <tr>
308          <tbl:header 
309            clazz="index"
310            >&nbsp;</tbl:header>
311          <tbl:header 
312            clazz="check" 
313            visible="<%=mode.hasCheck()%>"
314            ><base:icon 
315              image="check_uncheck.gif" 
316              tooltip="Check/uncheck all" 
317              onclick="Forms.checkUncheck(document.forms[formId])" style="align: left;"
318            /></tbl:header>
319          <tbl:header 
320            clazz="check" 
321            visible="<%=mode.hasRadio()%>"
322            />
323          <tbl:header 
324            clazz="icons" 
325            visible="<%=mode.hasIcons()%>"
326            >&nbsp;</tbl:header>
327          <tbl:propertyfilter />
328        </tr>
329   
330          <tbl:rows>
331          <%
332          int index = cc.getPage()*cc.getRowsPerPage();
333          int selectedItemId = cc.getId();
334          if (help != null)
335          {           
336            while (help.hasNext())
337            {
338              Help item = help.next();
339              int itemId = item.getId();
340              boolean writePermission = item.hasPermission(Permission.WRITE);
341              String name = HTML.encodeTags(item.getName());
342              String tooltip = mode.isSelectionMode() ? 
343                  "Select this item" : "View this item" + (writePermission ? "(use CTRL, ALT or SHIFT to edit)" : "");
344              index++;
345              numListed++;
346              %>
347              <tbl:row>
348                <tbl:header 
349                  clazz="index"
350                  ><%=index%></tbl:header>
351                <tbl:header 
352                  clazz="check" 
353                  visible="<%=mode.hasCheck()%>"
354                  ><input 
355                      type="checkbox" 
356                      name="<%=itemId%>" 
357                      value="<%=itemId%>" 
358                      title="TODO" 
359                      <%=cc.getSelected().contains(itemId) ? "checked" : ""%>
360                    ></tbl:header>
361                <tbl:header 
362                  clazz="check" 
363                  visible="<%=mode.hasRadio()%>"
364                  ><input 
365                      type="radio" 
366                      name="item_id" 
367                      value="<%=itemId%>" 
368                      title="TODO" 
369                      <%=selectedItemId == itemId ? "checked" : ""%>
370                    ></tbl:header>
371                <tbl:header 
372                  clazz="icons" 
373                  visible="<%=mode.hasIcons()%>"
374                  ><base:help helpid="<%=item.getExternalId()%>" tooltip="Preview this help text"
375                  />&nbsp;</tbl:header>
376                <tbl:cell column="name"><div class="link" 
377                  onclick="itemOnClick(<%=writePermission ? "event" : null%>, <%=itemId%>)"
378                  title="<%=tooltip%>"><%=name%></div></tbl:cell>
379                <tbl:cell column="externalId"><%=HTML.encodeTags(item.getExternalId())%></tbl:cell>
380                <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>
381                <tbl:cell column="description.html"><div class="helptext"><%=item.getDescription()%></div></tbl:cell>
382              </tbl:row>
383              <%
384            }
385          }
386          %>
387          </tbl:rows>
388        </tbl:data>
389      <%
390      if (numListed == 0)
391      {
392        %>
393        <tbl:panel><%=help == null || help.getTotalCount() == 0 ? "No help were found" : "No help on this page. Please select another page!" %></tbl:panel>
394        <%
395      }
396      else
397      {
398        %>
399        <tbl:navigator
400          page="<%=cc.getPage()%>" 
401          rowsperpage="<%=cc.getRowsPerPage()%>" 
402          totalrows="<%=help == null ? 0 : help.getTotalCount()%>" 
403          visible="<%=mode.hasNavigator()%>"
404          locked="true"
405        />
406        <%
407      }
408      %>
409    </tbl:table>
410    <base:buttongroup align="center">
411      <base:button onclick="returnSelected();" title="Ok" visible="<%=mode.hasOkButton()%>" />
412      <base:button onclick="window.close();" title="Cancel" visible="<%=mode.hasCancelButton()%>" />
413      <base:button onclick="window.close();" title="Close" visible="<%=mode.hasCloseButton()%>" />
414    </base:buttongroup>
415 
416    </t:tab>
417    </t:tabcontrol>
418
419  </base:body>
420  </base:page>
421  <%
422}
423finally
424{
425  if (help != null) help.close();
426  if (dc != null) dc.close();
427}
428%>
Note: See TracBrowser for help on using the repository browser.