Changeset 2129

Timestamp:

Mar 30, 2006, 9:50:56 AM (17 years ago)

Author:

Martin Svensson

Message:

Fixes #161 Add support for showing help texts in the GUI

Location:

trunk

Files:

• src/clients/web/net/sf/basedb/clients/web/taglib/Help.java (modified) (6 diffs)
• src/core/common-queries.xml (modified) (1 diff)
• src/core/net/sf/basedb/core/Client.java (modified) (2 diffs)
• www/WEB-INF/base.tld (modified) (1 diff)
• www/common/help (added)
• www/common/help/view_help.jsp (added)
• www/include/scripts/main.js (modified) (1 diff)

trunk/src/clients/web/net/sf/basedb/clients/web/taglib/Help.java

@@ -38 +38 @@
   <pre>
     &lt;%@ taglib prefix="base" uri="/WEB-INF/base.tld" %&gt;
-    &lt;base:help help_id="required_helpsectionID" /&gt;
+    &lt;base:help help_id="required_helpexternalID" /&gt;
   </pre>
   
@@ -44 +44 @@
   <b>Syntax:</b>
   <pre>
-  &lt;base:icon
-    id=...
+  &lt;base:help
     helpid=...
     clazz=...
@@ -64 +63 @@
     </tr>
     <tr>
-      <td>id</td>
-      <td>-</td>
-      <td>no</td>
-      <td>
-        The ID of the help. The value of this attribute goes
-        directly into the standard <code>id</code> attribute.
-        This means that if you need a reference to the note object in your own
-        JavaScript code, you may for example use the following code:
-        <p>
-        <code>
-          help = document.getElementById('&lt;id&gt;');
-        </code>     
-      </td>
-    </tr>
-    <tr>
       <td>helpid</td>
       <td></td>
@@ -86 +70 @@
         to be identified with.         
       </td>
-    </tr>
+    </tr>   
     <tr>
       <td>clazz</td>
@@ -200 +184 @@
     return this.helpid;
   }
-  
+    
   public void setClazz(String clazz)
   {
@@ -259 +243 @@
   {
     page = (Page)findAncestorWithClass(this, Page.class);
-    if (page == null) throw new JspTagException("Tag <base:icon> must be inside a <base:page> tag");
+    if (page == null) throw new JspTagException("Tag <base:help > must be inside a <base:page> tag");
     if (!isVisible()) return SKIP_BODY;
     
     String theStyle = getStyle();
+    
     if (getOnClick() != null)
     {
       theStyle = Values.getString(theStyle) + "cursor: pointer;"; 
     }
-    
     StringBuilder sb = new StringBuilder();
-    sb.append("<a href=\"javascript:Main.openHelp('").append(getHelpid()).append("')\">");    
-    sb.append("<img border=0");
-    if (getId() != null) sb.append(" id=\"").append(getId()).append("\"");
+    sb.append("<a href=\"javascript:Main.openHelp('").append(pageContext.getRequest().getParameter("ID"));
+    sb.append("' ,'").append(getHelpid()).append("')\">");    
+    sb.append("<img border=0");   
     if (getClazz() != null) sb.append(" class=\"").append(getClazz()).append("\"");
     if (theStyle != null) sb.append(" style=\"").append(theStyle).append("\"");

trunk/src/core/common-queries.xml

@@ -1611 +1611 @@
     </description>
   </query>
+  
+  <query id="GET_HELP_FOR_EXTERNAL_ID" type="HQL">
+    <sql>
+      SELECT hlp
+      FROM HelpData hlp
+      WHERE hlp.externalId = :externalId AND hlp.client = :client
+    </sql>
+    <description>
+      A Hibernate query that loads a help text.
+    </description>
+  </query>
 
 </predefined-queries>

trunk/src/core/net/sf/basedb/core/Client.java

@@ -26 +26 @@
 
 import net.sf.basedb.core.data.ClientData;
+import net.sf.basedb.core.data.HelpData;
 import net.sf.basedb.core.query.Restrictions;
 import net.sf.basedb.core.query.Expressions;
@@ -275 +276 @@
     return Help.getQuery(this);
   }
-
+  
+  /**
+    Get a <code>Help</code> item when you know the external ID.
+  
+    @param dc The <code>DbControl</code> which will be used for
+      permission checking and database access.
+    @param externalId The external id of the item to load
+    @return The <code>Help</code> item
+    @throws ItemNotFoundException If an item with the specified ID is not found
+    @throws PermissionDeniedException If the logged in user doesn't have
+      {@link Permission#READ READ} permission for the item
+    @throws BaseException If there is another error
+  */
+  public Help getHelpByExternalId(DbControl dc, String externalId)
+    throws ItemNotFoundException, PermissionDeniedException, BaseException
+  {
+    org.hibernate.Query query = HibernateUtil.getPredefinedQuery(dc.getHibernateSession(), 
+      "GET_HELP_FOR_EXTERNAL_ID");
+    /*
+      SELECT hlp
+      FROM HelpData hlp
+      WHERE hlp.externalId = :externalId AND hlp.client = :client
+    */
+    query.setString("externalId", externalId);
+    query.setEntity("client", getData());
+    Help h = dc.getItem(Help.class, HibernateUtil.loadData(HelpData.class, query));
+    if (h == null) throw new ItemNotFoundException("Help[externalId="+externalId+"]");
+    return h;
+  }
 }
 

trunk/www/WEB-INF/base.tld

@@ -304 +304 @@
     <tagclass>net.sf.basedb.clients.web.taglib.Help</tagclass>
     <attribute>
-      <name>id</name>
-      <required>false</required>
-      <rtexprvalue>true</rtexprvalue>
-    </attribute>
-    <attribute>
       <name>helpid</name>
       <required>true</required>
       <rtexprvalue>true</rtexprvalue>
-    </attribute>
+    </attribute>    
     <attribute>
       <name>clazz</name>

trunk/www/include/scripts/main.js

@@ -95 +95 @@
     url += '&disabled='+(disabled ? '1' : '0');
     Main.openPopup(url, title.replace(/[^\w]/g, ''), 640, 550);
+  }
+  
+  /*
+      Opens a popupwindow with helptext
+      
+      @param session The ID of the session.
+      @param helpid The id of the helptext to be displayed.
+  */
+  this.openHelp = function(sessionid, helpid) 
+  {
+    var url = getRoot()+'common/help/view_help.jsp?ID='+sessionid+'&external_id='+helpid;
+    Main.openPopup(url, 'Help', 640, 550);
   }