Overview    Library   Tag   Help 
 FRAMES   NO FRAMES 

jahiaHtml

Provides a tag library for generating HTML for Jahia content objects and GUIs (doc version 0.2 - 10/11/2008)

Tag Library Information
Display NameNone
Version1.0
Short NamejahiaHtml
URINone
 

Tag Summary
treeDisplays and handles an HTML tree control.

This HTML-specific tag handles the display AND handling of a tree control. It includes all the logic for session-handling, looping, selection. It should be generic enough to be used in any kind of application, for any kind of user objects.

Example 1 :

<content:category key="root" id="rootCategory" subTreeID="categoryTree" />
<jahiaHtml:tree treeName="categoryTree" userObjectID="userObject" actionURL="<%=actionURL%>"
     nodeIndexID="nodeIndex" selectionParamName="selectednode" selectedNodeIndexID="selectedNodeIndex"
     selectionURLID="selectionURL" selectedUserObjectID="selectedUserObject">
   <%
     Object nodeInfo = pageContext.findAttribute("userObject");
     Integer nodeIndexInt = (Integer) pageContext.findAttribute("nodeIndex");
     int nodeIndex = nodeIndexInt.intValue();
     String selectionURL = (String) pageContext.findAttribute("selectionURL");
     Integer selectedNodeIndexInt = (Integer) pageContext.findAttribute("selectedNodeIndex");
     int selectedNodeIndex = selectedNodeIndexInt.intValue();
     Category curCategory = (Category) nodeInfo;
     String catDisplay = curCategory.getTitle(jData.params().getLocale());
     if (catDisplay == null) {
        catDisplay = "(key=" + curCategory.getKey() + ")";
     }
     if (nodeIndex == selectedNodeIndex) { %>
       <b><%= catDisplay %></b>
     <% } else { %>
       <a href="<%=selectionURL %>"><%= catDisplay %></a>
   <% }
   %>
</jahiaHtml:tree>

Example 2 :

<content:category key="root" id="rootCategory" subTreeID="categoryTree" />
<jahiaHtml:tree treeName="categoryTree" userObjectID="userObject" actionURL="<%=actionURL%>"
     nodeIndexID="nodeIndex" selectionParamName="selectednode" selectedNodeIndexID="selectedNodeIndex"
     selectionURLID="selectionURL" selectedUserObjectID="selectedUserObject">
   <%
     Object nodeInfo = pageContext.findAttribute("userObject");
     Integer nodeIndexInt = (Integer) pageContext.findAttribute("nodeIndex");
     int nodeIndex = nodeIndexInt.intValue();
     String selectionURL = (String) pageContext.findAttribute("selectionURL");
     Integer selectedNodeIndexInt = (Integer) pageContext.findAttribute("selectedNodeIndex");
     int selectedNodeIndex = selectedNodeIndexInt.intValue();
     Category curCategory = (Category) nodeInfo;
     String catDisplay = curCategory.getTitle(jData.params().getLocale());
     if (catDisplay == null) {
       catDisplay = "(key=" + curCategory.getKey() + ")";
     }
     if (nodeIndex == selectedNodeIndex) { %>
       <b><%= catDisplay %></b>
     <% } else { %>
       <a href="<%=selectionURL %>"><%= catDisplay %></a>
     <% }
   %>
</jahiaHtml:tree>

windowStatesDisplays the GUI interface for window state changes, as well as the currently selected state.

Use this tag to display the associated portlet menu to enable various operations such as Maximizing, Minimizing or Closing a portlet (supported operations are dependant on each the portlet). It will also highlight the icon/label which represents the current selected state.

This tag is typically used in conjunction with jahiaHtml:PortletModes.

Example : Displays all the webapps in webappsContainerList along with their associated menus.

<content:containerList name='<%="webappsContainer" + id%>' id="webappsContainerList" parentContainerName="boxContainer">
   <content:container>
     <content:applicationField name='<%="webapp" + id%>' id="webapp" display="false" />
     <bean:define id="portletWindowBean" name="webapp" property="object" />
     <jahia-htmlwindowStates name="portletWindowBean" />
     <jahia-htmlportletModes name="portletWindowBean" />
     <br/>
<bean:write name="webapp" property="value" filter="false" />
     <content:updateContainerURL id="updateWebappsContainerURL" display="false"/>
     <content:deleteContainerURL id="deleteWebappsContainerURL" display="false"/>
     <logic:present name="updateWebappsContainerURL">
       <a href="<bean:write name='updateWebappsContainerURL'/>"><%=updateButton%></a>
       <a href="<bean:write name='deleteWebappsContainerURL'/>"><%=deleteButton%></a>
     </logic:present>
   </content:container>
   <logic:equal name="webappsContainerList" property="size" value="0">
     <content:addContainerURL id="addWebappsContainerURL" display="false"/>
     <logic:present name="addWebappsContainerURL">
        <br/><a href="<bean:write name='addWebappsContainerURL'/>"><%=addButton%> <jahia:resourceBundle
resourceBundle="jahiatemplates.Corporate_portal_templates"
        resourceName="addWebapps"/></a>
     </logic:present>
   </logic:equal>
</content:containerList>

Introduced as from Jahia version 4.5

sessionViewerDebugging tool that displays the content of the current HTTP session attributes.

Typical output:

Name
Type
Value
2_1_contentContainermain_1_sort_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerSorterBean

op
java.lang.String
edit
AddContainer
java.lang.String
true
org.jahia.services.multilang.currentlocale
java.util.Locale
en
5_1_siteSettings_search_handler_[workflowState=1 versionID=0 languages=shared,en]
org.jahia.services.search.ContainerSearcher
Query=
2_1_contentContainermain_1_search_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.services.search.ContainerSearcher
Query=
2_1_contentContainermain_1_filter_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerFilters
Container filters:[]
3_1_topMenu_search_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.services.search.ContainerSearcher
Query=
3_1_topMenu_search_handler_[workflowState=1 versionID=0 languages=shared,en]
org.jahia.services.search.ContainerSearcher
Query=
5_1_siteSettings_filter_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerFilters
Container filters:[]
4_1_quickLinkContainer_search_handler_[workflowState=1 versionID=0 languages=shared,en]
org.jahia.services.search.ContainerSearcher
Query=
5_1_siteSettings_sort_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerSorterBean

4_1_quickLinkContainer_filter_handler_[workflowState=1 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerFilters
Container filters:[]
4_1_quickLinkContainer_sort_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerSorterBean

jahia_session_engineMap
java.util.HashMap
Key
Key type
Value type
Value
javaScriptPath
java.lang.String
java.lang.String
/jahia/jsp/jahia/javascript/jahia.js
containerParentID
java.lang.String
java.lang.Integer
0
engineUrl
java.lang.String
java.lang.String
/jahia/Jahia/engineName/addcontainer/op/edit/pid/1?clistid=0&cdefid=20&cpid=1&cparentid=0
enableContentDefinition
java.lang.String
java.lang.Boolean
true
screen
java.lang.String
java.lang.String
categories
addcontainer.fieldIDs
java.lang.String
java.util.Vector
[-1, -2, -3, -4]
jspSource
java.lang.String
java.lang.String
add_container
UpdateContainer_Engine.JahiaContentContainerFacade
java.lang.String
org.jahia.data.containers.JahiaContentContainerFacade
org.jahia.data.containers.JahiaContentContainerFacade&#64;6a16d4
theContainer
java.lang.String
org.jahia.data.containers.JahiaContainer
org.jahia.data.containers.JahiaContainer&#64;100e398
flatCategoryList
java.lang.String
java.util.ArrayList
[org.jahia.services.categories.Category&#64;1814dd0]
ManageCategories.fieldForm
java.lang.String
java.lang.String
&nbsp; Please select the categories this object should be associated with.
&nbsp;
&nbsp; &quot;&quot; (key=root) &nbsp;&nbsp;&nbsp;&nbsp;

addcontainer.fieldForms
java.lang.String
java.util.Hashtable
addcontainer.theField
java.lang.String
org.jahia.data.fields.JahiaSmallTextSharedLangField
org.jahia.data.fields.JahiaSmallTextSharedLangField&#64;15e10ab
theField
java.lang.String
org.jahia.data.fields.JahiaSmallTextSharedLangField
org.jahia.data.fields.JahiaSmallTextSharedLangField&#64;15e10ab
fieldsEditCallingEngineName
java.lang.String
java.lang.String
ManageCategories
categoryTree
java.lang.String
javax.swing.JTree
javax.swing.JTree[,0,0,0x0,invalid,alignmentX=null,alignmentY=null,border=,flags=360,maximumSize=,minimumSize=,preferredSize=,editable=false,invokesStopCellEditing=false,largeModel=false,rootVisible=true,rowHeight=0,scrollsOnExpand=true,showsRootHandles=false,toggleClickCount=2,visibleRowCount=20]
addcontainer.org.jahia.data.fields.FieldsEditHelper.ContextID
java.lang.String
org.jahia.data.fields.ContainerFieldsEditHelper
org.jahia.data.fields.ContainerFieldsEditHelper&#64;987c7d
engineOutputFile
java.lang.String
java.lang.String
/jsp/jahia/engines/engine.jsp
enableCategories
java.lang.String
java.lang.Boolean
true
selectedCategories
java.lang.String
java.util.ArrayList
[]
imagesPath
java.lang.String
java.lang.String
/jsp/jahia/engines/engines/images/
addcontainer.theContainer
java.lang.String
org.jahia.data.containers.JahiaContainer
org.jahia.data.containers.JahiaContainer&#64;100e398
renderType
java.lang.String
java.lang.Integer
2
org.jahia.engines.JahiaEngine.engineLanguageHelper
java.lang.String
org.jahia.engines.EngineLanguageHelper
org.jahia.engines.EngineLanguageHelper&#64;115272a
org.jahia.engines.JahiaEngine.processingLocale
java.lang.String
java.util.Locale
en
addcontainer.fieldForm
java.lang.String
java.lang.String
&quot;>
jahiaBuild
java.lang.String
java.lang.Integer
7018
noApply
java.lang.String
java.lang.String

addcontainer.isSelectedField
java.lang.String
java.lang.Boolean
false
addcontainer.fieldID
java.lang.String
java.lang.Integer
-1
dataSourceConnectUrl
java.lang.String
java.lang.String
/jahia/Jahia/engineName/selectdatasource/op/edit/pid/1?mode=displaywindow&fid=-4
adminAccess
java.lang.String
java.lang.Boolean
true
dataSourceIDUrl
java.lang.String
java.lang.String
/jahia/Jahia/engineName/viewdatasourceid/op/edit/pid/1?mode=displayid&fid=-4
engineName
java.lang.String
java.lang.String
addcontainer
localSwitchUrl
java.lang.String
java.lang.String
ReloadEngine(&apos;localswitch***yes&apos;)
writeAccess
java.lang.String
java.lang.Boolean
true
3_1_topMenu_filter_handler_[workflowState=1 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerFilters
Container filters:[]
2_1_contentContainermain_1_filter_handler_[workflowState=1 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerFilters
Container filters:[]
org.jahia.usermanager.jahiauser
org.jahia.services.usermanager.JahiaDBUser
Detail of user [root] - ID [0] - password [M6SFyxRuEVPGm1iMZxq0dPLluAA=] - properties : email -> [] lastname -> [Super Administrator] firstname -> [Jahia]
5_1_siteSettings_sort_handler_[workflowState=1 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerSorterBean

5_1_siteSettings_search_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.services.search.ContainerSearcher
Query=
3_1_topMenu_sort_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerSorterBean

4_1_quickLinkContainer_search_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.services.search.ContainerSearcher
Query=
org.jahia.services.sites.jahiasite
org.jahia.services.sites.JahiaSite
org.jahia.services.sites.JahiaSite@e7a94c
2_1_contentContainermain_1_sort_handler_[workflowState=1 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerSorterBean

3_1_topMenu_filter_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerFilters
Container filters:[]
javax.servlet.jsp.jstl.fmt.locale.session
java.util.Locale
en
4_1_quickLinkContainer_filter_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerFilters
Container filters:[]
org.jahia.params.lastrequestedpageid
java.lang.Integer
1
6_1_linkContainer_filter_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerFilters
Container filters:[]
3_1_topMenu_sort_handler_[workflowState=1 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerSorterBean

6_1_linkContainer_search_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.services.search.ContainerSearcher
Query=
2_1_contentContainermain_1_search_handler_[workflowState=1 versionID=0 languages=shared,en]
org.jahia.services.search.ContainerSearcher
Query=
5_1_siteSettings_filter_handler_[workflowState=1 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerFilters
Container filters:[]
6_1_linkContainer_sort_handler_[workflowState=2 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerSorterBean

org.jahia.engines.lastenginename
java.lang.String
core
4_1_quickLinkContainer_sort_handler_[workflowState=1 versionID=0 languages=shared,en]
org.jahia.data.containers.ContainerSorterBean

org.apache.struts.action.LOCALE
java.util.Locale
en
initDynButtonInitialize a rollover button manager.

This tag is associated with the <jahiaHtml:dynButton> tag (read for more details) which should be only be used after calling this tag to initialize the button manager.

Usage example ( [] = optional attribute):

Synopsis :
   <jahiaHtml:initDynButton buttonFile="WEB-INF/etc/button/button.xml"
       [flush="false | false"]
    />

NOT CURRENTLY USED IN JAHIA

iconButtonDraw a graphic rollover button defined by three parameters.

NOTE: SAME CODE AS jahiaButtonTag.java ...

Example :

<jahiaHtml:iconButton img="cancel" href="javascript:sendFormCancel();" altBundle="engine" altKey="org.jahia.altCloseWithoutSave.label" />

portletModesRenders list of portlet modes.

Use this tag to display the portlet's supported modes which are dependant on each portlet. Examples include Edit, View, Preview etc...

This tag is typically used in conjunction with jahiaHtml:windowStates.

Example : Go to jahiaHtml:windowStates.

Introduced as from Jahia version 4.5

boxTag that generates an HTML Box.

this tag is for the moment not very generic but it is here to help template developers to include easily a box with a title. It's also possible to define a css class for the title and the content cell, and to fix the table width.

Example :

[To Be Completed]

dynButtonDisplays a rollover button which is automatically generated if it doesn't exists.

The button consists of a set of images generated using a rollover button manager. The button manager reads the button properties (e.g. color, width, font, borders, background, image format to generate e.g. png etc...) from an external XML file. The advantage is that button images can be generated dynamically instead of using static images created by hand. CSS classes provide much the same functionality; the most notable advantage here is that local fonts are used to generate the buttons, whereas with CSS classes, one cannot guarantee the client's browser supports all required fonts.

The associated <jahiaHtml:initDynButton> must to be declared before using this tag.

Usage example ( [] = optional attribute):

Synopsis :
    <jahiaHtml:dynButton textKey="org.jahia.button.ok"
       buttonName="engineRed"
       href="javascript:sendFormSave();"
       [onclick="<%=workInProgressLauncher%>"]
       [alt="Apply modifications and close window (Ctrl+enter)"]
       [altKey="org.jahia.altApplyAndClose.label"]
       [bundleCode="engine"]
       [regenerate="false"]
    />

NOT CURRENTLY USED IN JAHIA

 

 Overview    Library   Tag   Help 
 FRAMES   NO FRAMES 
Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-3 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.