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

Last change on this file since 6604 was 6604, checked in by Nicklas Nordborg, 8 years ago

References #1890: Improve skinnability of BASE

Updated table listings with some new css classes to make it easier to modify background color.

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