source: branches/3.18-stable/www/admin/clients/help/list_help.jsp @ 7939

Last change on this file since 7939 was 7939, checked in by Nicklas Nordborg, 6 months ago

References #2246: Sticky table headers

It should now be implemented on all list pages.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 13.2 KB
Line 
1<%-- $Id: list_help.jsp 7939 2021-05-04 07:30:31Z nicklas $
2  ------------------------------------------------------------------
3  Copyright (C) 2006 Jari Häkkinen, Nicklas Nordborg, Martin Svensson
4  Copyright (C) 2007 Johan Enell, Nicklas Nordborg
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 pageEncoding="UTF-8" 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.ItemContext"
31  import="net.sf.basedb.core.Client"
32  import="net.sf.basedb.core.Help"
33  import="net.sf.basedb.core.ItemQuery"
34  import="net.sf.basedb.core.ItemResultIterator"
35  import="net.sf.basedb.core.Permission"
36  import="net.sf.basedb.core.PluginDefinition"
37  import="net.sf.basedb.core.PermissionDeniedException"
38  import="net.sf.basedb.core.query.Restrictions"
39  import="net.sf.basedb.core.query.Expressions"
40  import="net.sf.basedb.core.query.Orders"
41  import="net.sf.basedb.core.query.Hql"
42  import="net.sf.basedb.core.plugin.GuiContext"
43  import="net.sf.basedb.core.plugin.Plugin"
44  import="net.sf.basedb.clients.web.Base"
45  import="net.sf.basedb.clients.web.PermissionUtil"
46  import="net.sf.basedb.clients.web.ModeInfo"
47  import="net.sf.basedb.clients.web.util.HTML"
48  import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
49  import="net.sf.basedb.clients.web.extensions.JspContext"
50  import="net.sf.basedb.clients.web.extensions.renderer.PrefixSuffixRenderer"
51  import="net.sf.basedb.clients.web.extensions.toolbar.ButtonAction" 
52  import="net.sf.basedb.clients.web.extensions.toolbar.ToolbarUtil"
53  import="net.sf.basedb.clients.web.extensions.list.ListColumnAction"
54  import="net.sf.basedb.clients.web.extensions.list.ListColumnUtil"
55  import="net.sf.basedb.util.extensions.ExtensionsInvoker"
56  import="net.sf.basedb.util.Values"
57  import="java.util.List"
58  import="java.util.Map"
59%>
60<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
61<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
62<%@ taglib prefix="t" uri="/WEB-INF/tab.tld" %>
63<%@ taglib prefix="p" uri="/WEB-INF/path.tld" %>
64<%@ taglib prefix="ext" uri="/WEB-INF/extensions.tld" %>
65<%!
66  private static final Item itemType = Item.HELP;
67  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.LIST);
68%>
69<%
70final int clientId = Values.getInt(request.getParameter("client_id"));
71final SessionControl sc = Base.getExistingSessionControl(pageContext, Permission.DENIED, itemType);
72final String ID = sc.getId();
73final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
74
75final ModeInfo mode = ModeInfo.get(request.getParameter("mode"));
76final String callback = request.getParameter("callback");
77final String title = mode.generateTitle("help", "help");
78final DbControl dc = sc.newDbControl();
79ItemResultIterator<Help> help = null;
80try
81{
82  final Client client = Client.getById(dc, clientId);
83  final boolean createPermission = client.hasPermission(Permission.WRITE);
84  final boolean deletePermission = createPermission;
85
86
87  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
88  JspContext jspContext = ExtensionsControl.createContext(dc, pageContext, guiContext, client);
89  try
90  {
91    final ItemQuery<Help> query = Base.getConfiguredQuery(dc, cc, jspContext, true, client.getHelp(), mode);
92    help = query.iterate(dc);
93  }
94  catch (Throwable t)
95  {
96    cc.setMessage(t.getMessage());
97  }
98  int numListed = 0;
99  ExtensionsInvoker<ButtonAction> invoker = ToolbarUtil.useExtensions(jspContext);
100  ExtensionsInvoker<ListColumnAction<Help,?>> columnsInvoker = ListColumnUtil.useExtensions(jspContext);
101  %>
102  <base:page title="<%=title%>" type="<%=mode.getPageType()%>" id="list-page">
103  <base:head scripts="table.js,tabcontrol-2.js,~help.js" styles="table.css,toolbar.css,headertabcontrol.css,path.css,help.css">
104    <ext:scripts context="<%=jspContext%>" />
105    <ext:stylesheets context="<%=jspContext%>" />
106  </base:head>
107 
108  <base:body>
109    <p:path><p:pathelement 
110      title="Client applications" href="<%="../index.jsp?ID="+ID%>"
111      /><p:pathelement title="<%=HTML.encodeTags(client.getName())%>"
112      /></p:path>
113
114    <t:tabcontrol 
115      id="main" 
116      subclass="content mastertabcontrol"
117      active="help">
118    <t:tab id="properties" title="Properties" />
119   
120    <t:tab id="help" title="Help texts">
121    <tbl:table 
122      id="help" 
123      columns="<%=cc.getSetting("columns")%>"
124      sortby="<%=cc.getSortProperty()%>" 
125      direction="<%=cc.getSortDirection()%>"
126      action="index.jsp"
127      sc="<%=sc%>"
128      item="<%=itemType%>"
129      filterrows="<%=cc.getFilterRows()%>"
130      subclass="fulltable"
131      stickyheaders="name"
132      >
133      <tbl:hidden 
134        name="mode" 
135        value="<%=mode.getName()%>" 
136      />
137      <tbl:hidden 
138        name="client_id" 
139        value="<%=String.valueOf(clientId)%>" 
140      />
141      <tbl:hidden 
142        name="callback" 
143        value="<%=callback%>" 
144        skip="<%=callback == null%>" 
145      />
146      <tbl:columndef 
147        id="name"
148        property="name"
149        datatype="string"
150        title="Title"
151        sortable="true" 
152        filterable="true"
153        exportable="true"
154        show="always" 
155      />
156      <tbl:columndef 
157        id="id"
158        clazz="uniquecol"
159        property="id"
160        datatype="int"
161        title="ID"
162        sortable="true"
163        filterable="true"
164        exportable="true"
165      />
166      <tbl:columndef 
167        id="externalId"
168        clazz="uniquecol"
169        property="externalId"
170        datatype="string"
171        title="External ID"
172        sortable="true" 
173        filterable="true"
174        exportable="true"
175      />
176      <tbl:columndef 
177        id="description"
178        property="description"
179        datatype="string"
180        title="Help text" 
181        sortable="true" 
182        filterable="true" 
183        exportable="true"
184      />
185      <tbl:columndef 
186        id="description.html"
187        property="description"
188        datatype="string"
189        title="Help text (as HTML)" 
190        sortable="false" 
191        filterable="false" 
192        exportable="false"
193      />
194      <tbl:columndef 
195        id="xt-columns" 
196        extensions="<%=columnsInvoker%>" 
197        jspcontext="<%=jspContext%>" 
198      />
199      <div class="panelgroup bg-filled-50 bottomborder">
200        <tbl:toolbar
201          subclass="bottomborder"
202          visible="<%=mode.hasToolbar()%>"
203          >
204          <tbl:button 
205            id="btnNewItem"
206            data-extra-url="<%="&client_id="+clientId%>"
207            disabled="<%=!createPermission%>" 
208            image="new.png" 
209            title="New&hellip;" 
210            tooltip="<%=createPermission ? "Create new help" : "You do not have permission to create help"%>" 
211          />
212          <tbl:button 
213            id="btnDeleteItems"
214            data-confirm="1"
215            disabled="<%=!deletePermission%>" 
216            image="delete.png" 
217            title="Delete&hellip;"
218            tooltip="<%=deletePermission ? "Delete the selected help" : "You do not have permission to delete help"%>" 
219          />
220          <tbl:button 
221            id="btnColumns"
222            image="columns.png" 
223            title="Columns&hellip;" 
224            tooltip="Show, hide and re-order columns" 
225          />
226          <tbl:button 
227            id="btnImport"
228            data-plugin-type="IMPORT"
229            image="import.png" 
230            title="Import&hellip;" 
231            tooltip="Import data" 
232            visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
233          />
234          <tbl:button 
235            id="btnExport"
236            data-plugin-type="EXPORT"
237            image="export.png" 
238            title="Export&hellip;" 
239            tooltip="Export data" 
240            visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
241          />
242          <tbl:button 
243            id="btnRunPlugin"
244            data-plugin-type="OTHER"
245            image="runplugin.png" 
246            title="Run plugin&hellip;" 
247            tooltip="Run a plugin" 
248            visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
249          />
250          <ext:render extensions="<%=invoker%>" context="<%=jspContext%>" 
251            wrapper="<%=new PrefixSuffixRenderer<ButtonAction>(jspContext, "<td>", "</td>") %>"/>
252        </tbl:toolbar>
253        <tbl:panel>
254          <tbl:presetselector />
255          <tbl:navigator
256            page="<%=cc.getPage()%>" 
257            rowsperpage="<%=cc.getRowsPerPage()%>" 
258            totalrows="<%=help == null ? 0 : help.getTotalCount()%>" 
259            visible="<%=mode.hasNavigator()%>"
260          />
261        </tbl:panel>
262      </div>
263      <tbl:data>
264        <tbl:headers>
265          <tbl:headerrow>
266            <tbl:header clazz="row-index bg-filled-100" />
267            <tbl:columnheaders />
268          </tbl:headerrow>
269          <%
270          int numFilters = cc.getNumPropertyFilters();
271          int numRows = cc.getFilterRows();
272          for (int filterNo = 0; filterNo < numRows; filterNo++)
273          {
274            boolean lastRow = filterNo == numRows-1;
275            %>
276            <tbl:headerrow>
277              <tbl:header subclass="row-index bg-filled-100">
278                <div class="index-<%=mode.getName()%>">
279                  <div class="index"></div>
280                  <div class="check">
281                    <base:icon 
282                      subclass="link table-check"
283                      image="check_uncheck.png" 
284                      tooltip="Toggle all (use CTRL, ALT or SHIFT to check/uncheck)" 
285                      visible="<%=lastRow && mode.hasCheck()%>"
286                    />
287                  </div>
288                  <div class="icons">
289                    <base:icon
290                      subclass="link table-filter-row-action"
291                      image="add.png"
292                      tooltip="Add extra filter row"
293                      visible="<%=lastRow%>"
294                    /><base:icon
295                      subclass="link table-filter-row-action"
296                      image="remove.png"
297                      tooltip="Remove this filter row"
298                      visible="<%=numRows > 1 || numFilters > 0 %>"
299                      data-remove-row="<%=filterNo%>"
300                    />
301                  </div>
302                </div>
303              </tbl:header>
304              <tbl:propertyfilter row="<%=filterNo%>" />
305            </tbl:headerrow>
306            <%
307          }
308          %>
309          <tbl:columnsubtitles />
310        </tbl:headers>
311        <tbl:rows>
312          <%
313          if (cc.getMessage() != null)
314          {
315            %>
316            <tbl:panel subclass="bg-filled-50">
317              <div class="messagecontainer error"><%=cc.getMessage()%></div>
318            </tbl:panel>
319            <%
320            cc.setMessage(null);
321          }
322          int index = cc.getPage()*cc.getRowsPerPage();
323          int selectedItemId = cc.getId();
324          if (help != null)
325          {           
326            while (help.hasNext())
327            {
328              Help item = help.next();
329              int itemId = item.getId();
330              boolean writePermission = item.hasPermission(Permission.WRITE);
331              String name = HTML.encodeTags(item.getName());
332              String tooltip = mode.isSelectionMode() ? 
333                  "Select this item" : "View this item" + (writePermission ? "(use CTRL, ALT or SHIFT to edit)" : "");
334              index++;
335              numListed++;
336              %>
337              <tbl:row>
338                <tbl:header clazz="row-index bg-filled-100">
339                  <div class="index-<%=mode.getName()%>">
340                    <div class="index <%=index>999?"index-smaller":""%>"><%=index%></div>
341                    <div class="check">
342                      <base:input
343                        type="checkbox" 
344                        name="<%=itemId%>" 
345                        value="<%=itemId%>" 
346                        title="<%=name%>" 
347                        checked="<%=cc.getSelected().contains(itemId)%>"
348                        visible="<%=mode.hasCheck()%>"
349                      />
350                      <base:input 
351                        type="radio" 
352                        name="item_id" 
353                        value="<%=itemId%>" 
354                        title="<%=name%>" 
355                        checked="<%=selectedItemId == itemId%>"
356                        visible="<%=mode.hasRadio()%>"
357                      />
358                    </div>
359                    <div class="icons">
360                      <base:help helpid="<%=item.getExternalId()%>" tooltip="Preview this help text" />
361                    </div>
362                  </div>
363                </tbl:header>
364                <tbl:cell column="name"><div
365                  class="link table-item"
366                  data-item-id="<%=itemId%>"
367                  data-no-edit="<%=writePermission ? 0 : 1 %>" 
368                  data-extra-url="&client_id=<%=clientId%>"
369                  tabindex="0"
370                  title="<%=tooltip%>"><%=name%></div></tbl:cell>
371                <tbl:cell column="id"><%=item.getId()%></tbl:cell>
372                <tbl:cell column="externalId"><%=HTML.encodeTags(item.getExternalId())%></tbl:cell>
373                <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>
374                <tbl:cell column="description.html"><div class="helptext"><%=item.getDescription()%></div></tbl:cell>
375                <tbl:xt-cells dc="<%=dc%>" item="<%=item%>">
376                  <tbl:cell column="xt-columns" />
377                </tbl:xt-cells>
378              </tbl:row>
379              <%
380            }
381          }
382          if (numListed == 0)
383          {
384            %>
385            <tbl:panel subclass="bg-filled-50">
386              <div class="messagecontainer note">
387              <%=help == null || help.getTotalCount() == 0 ? "No help were found" : "No help on this page. Please select another page!" %>
388              </div>
389            </tbl:panel>
390            <%
391          }
392          %>
393        </tbl:rows>
394      </tbl:data>
395    </tbl:table>
396    <base:buttongroup>
397      <base:button id="btnOk" title="Ok" visible="<%=mode.hasOkButton()%>" />
398      <base:button id="close" title="Cancel" visible="<%=mode.hasCancelButton()%>" />
399      <base:button id="close" title="Close" visible="<%=mode.hasCloseButton()%>" />
400    </base:buttongroup>
401    </t:tab>
402    </t:tabcontrol>
403
404
405  </base:body>
406  </base:page>
407  <%
408}
409finally
410{
411  if (help != null) help.close();
412  if (dc != null) dc.close();
413}
414%>
Note: See TracBrowser for help on using the repository browser.