Layout of WebSphere portal page

Theme policy is used to control how a theme is rendered on a page. A policy is created and stored using the XML configuration interface. Once stored, it can be applied to a page either through the XML configuration interface using the page metadata attribute com.ibm.portal.ThemePolicy or the Properties portlet. Theme policy is inherited so it only needs to be set on a page which requires a different policy than its parent.

Theme policy attributes

A theme policy is made up of several attributes. Each attribute controls one aspect of the theme. For example, the Boolean renderBreadCrumb attribute controls whether the bread crumb will be displayed while the breadCrumbMaxLevels attribute controls the number of steps listed in the bread crumb when it is displayed.

Provided theme policies

WebSphere Portal provides ten policies that may be used without alteration. The following information provides lists of each policy along with the corresponding attributes, values, and types.

Custom theme attributes

In addition to the attributes in each policy above, you can add an attribute to the theme policies and then use it in your JSP or JSPF. The following code samples show how the custom attribute renderTestAttribute is added to theme policy and how it is accessed in a JSP or JSPF.

<policyValue

      Name="renderTestAttribute"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

</policyValue>

<policyValue

      Name="renderTestAttributeLock"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>false</value>

</policyValue>

The policy value sets consisting of attributes and their values can be nested. Child attributes can either inherit or override the values from the parent attribute. When you specify the value of a lock attribute corresponding to a policy attribute as true, you lock the policy node. In this case, the child attributes necessarily inherit the values from parent attributes and cannot override these values.

<policyValue

      Name="renderTestAttribute"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>false</value>

</policyValue>

<% boolean isTestAttribute = themePolicy.getValueAsBoolean("renderTestAttribute", false); 

if(isTestAttribute){%>	  

<p> Display this paragrah if renderTestAttribute is true. </p>

<%}%>

In the above example, if the value of renderTestAttribute is true, the paragraph is displayed. themePolicy is defined in the Using theme policy in a JSP section of this topic.

Setting theme policy on a page using the XML configuration interface

Theme Policy can be applied to a page through the XML configuration interface using the page metadata attribute com.ibm.portal.ThemePolicy . The following provides an example of an XML script that sets the page metadata for the theme policy for the page ThemePolicyPageTest :

<request type="update" create-oids="true" 

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 

         xsi:noNamespaceSchemaLocation="PortalConfig_1.4.xsd">

    <portal action="locate">

        <content-node action="update" ordinal="last"

uniquename="ibm.portal.ThemePolicyPageTest" content-parentref="Content.Root"

active="true" allportletsallowed="false" create-type="explicit"

objectid="wp.theme.policytestpage" type="page">

		    <supported-markup markup="html" update="set"/>

		 <!--@LocaleData_1@-->

		   <parameter name="com.ibm.portal.ThemePolicy" type="string"

update="set">theme/SingleTopNavMinimal</parameter>

        </content-node>



    </portal>

</request>

Using theme policy in a JSP

You can also use a theme policy directly in a JSP. Use the following code to do this:

<themepolicy:initthemepolicy/>

<jsp:useBean id="themePolicy"

class="com.ibm.portal.theme.policy.ThemePolicyBean" scope="page"/>

<% themePolicy.setValuesMap(portalThemePolicyMap);%>

In this code example, the theme bean is initialized which wrappers the theme policy attributes.

To use an attribute in the JSP, reference it with the following syntax: ${themePolicy.attribute) where the attribute would be, for example, renderSideNavigation . The following code tests renderSideNavigation . If it is TRUE, the following code is executed:

<c-rt:if test = "${themePolicy.renderSideNavigation}">

<!-- following code -->

<….>

<….>

</c-rt:if>

The following code example sets startLevel to the value of the theme policy attribute sideNavigationStartLevel :

<portal:navigation  startLevel="${themePolicy.sideNavigationStartLevel}"

Creating your own theme policy

The following code example addThemePolicyNode.xml provides an example of how to create and add a new theme policy. This XML file would then be updated to reflect the location and name of the file which contains the theme policy XML definition.

<?xml version="1.0" encoding="UTF-8"?>

<request xsi:noNamespaceSchemaLocation="PortalConfig_1.4.xsd"

 create-oids="true" type="update" 

 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">



    <portal action="locate">

        <policy-node action="update" label="WebPage" type="" path="">

             <url>file:///c:/temp/addTestThemePolicyNode.xml</url>

        </policy-node>

    </portal>

</request>

<?xml version="1.0" encoding="UTF-8"?>

<!--



    Licensed Materials - Property of IBM, 5724-E76, 5655-R17, 

    (C) Copyright IBM Corp. 2006 - All Rights reserved.



-->

<policyList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 

xsi:noNamespaceSchemaLocation="Policy.xsd">

<policy>

    <policyValue 

      Name="Path"

      Factory="com.ibm.wps.policy.parse.StringFactory">

      <value></value>

    </policyValue>

    <policyValue 

      Name="Type"

      Factory="com.ibm.wps.policy.parse.StringFactory">

      <value>theme</value>

    </policyValue>

    <policyValue 

      Name="Description"

      Factory="com.ibm.wps.policy.parse.StringFactory">

      <value>Test Theme Policy</value>

    </policyValue>

    <policyValue 

      Name="Title"

      Factory="com.ibm.wps.policy.parse.StringFactory">

      <value>TestThemePolicy</value>

    </policyValue>

    <policyValue 

      Name="Editor"

      Factory="com.ibm.wps.policy.parse.StringFactory">

      <value></value>

    </policyValue>

    <policyValue 

      Name="NameResKey"

      Factory="com.ibm.wps.policy.parse.StringFactory">

      <value></value>

    </policyValue>

    <policyValue 

      Name="PznRule"

      Factory="com.ibm.wps.policy.parse.StringFactory">

      <value></value>

    </policyValue>

    <policyValue 

      Name="PznType"

      Factory="com.ibm.wps.policy.parse.StringFactory">

      <value>TestThemePolicy</value>

    </policyValue>

    <policyValue 

      Name="Remote"

      Factory="com.ibm.wps.policy.parse.StringFactory">

      <value></value>

    </policyValue>

    <policyValue 

      Name="PathType"

      Factory="com.ibm.wps.policy.parse.StringFactory">

      <value>/theme</value>

    </policyValue>

    <policyValue

      Name="renderMainMenu"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderTopNavigation"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderMainMenuActions"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderSelfCare"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderBreadCrumbTrail"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>false</value>

    </policyValue>

    <policyValue

      Name="renderSearch"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderToolBar"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderContentPalette"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderPeoplePalette"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderContextMenus"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderSideNavigation"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderTaskBar"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderFavorites"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderExtensions"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderBannerTitleGraphic"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderBannerTitle"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

    </policyValue>

    <policyValue

      Name="renderPortletFragmentIDAnchor"

      Factory="com.ibm.wps.policy.parse.BooleanFactory">

      <value>true</value>

		</policyValue>

		<policyValue

      Name="breadCrumbMaxLevels"

      Factory="com.ibm.wps.policy.parse.IntegerFactory">

      <value>5</value>

    </policyValue>

    <policyValue

      Name="breadCrumbStartLevel"

      Factory="com.ibm.wps.policy.parse.IntegerFactory">

      <value>1</value>

    </policyValue>

    <policyValue

      Name="rootNavigationStartLevel"

      Factory="com.ibm.wps.policy.parse.IntegerFactory">

      <value>1</value>

    </policyValue>

    <policyValue

      Name="rootNavigationStopLevel"

      Factory="com.ibm.wps.policy.parse.IntegerFactory">

      <value>1</value>

    </policyValue>

    <policyValue

      Name="topNavigationNumRows"

      Factory="com.ibm.wps.policy.parse.IntegerFactory">

      <value>1</value>

    </policyValue>

    <policyValue

      Name="topNavigationStartLevel"

      Factory="com.ibm.wps.policy.parse.IntegerFactory">

      <value>2</value>

    </policyValue>

    <policyValue

      Name="topNavigationStopLevel"

      Factory="com.ibm.wps.policy.parse.IntegerFactory">

      <value>2</value>

    </policyValue>

    <policyValue

      Name="sideNavigationStartLevel"

      Factory="com.ibm.wps.policy.parse.IntegerFactory">

      <value>3</value>

    </policyValue>

    <policyValue 

      Name="Version"

      Factory="com.ibm.wps.policy.parse.StringFactory">

      <value>1.0</value>

    </policyValue>

  </policy>

 </policyList>

Updating a theme policy

Extending and updating a theme policy

Exporting a theme policy

Use the following code example exportThemePolicyNode.xml to export a theme policy. The file specified is the location to where the exported information is written. The following example exports all theme policies.

<?xml version="1.0" encoding="UTF-8"?>

<request xsi:noNamespaceSchemaLocation="PortalConfig_1.4.xsd"

 create-oids="true" type="export" 

 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">



    <portal action="locate">

        <policy-node action="export" label="WebPage" 

                type="theme" path="">

             <url>file:///c:/temp/exportThemePolicies.xml</url>

        </policy-node>

    </portal>

</request>

The following example exports only the TestThemePolicy theme policy:

<?xml version="1.0" encoding="UTF-8"?>

<request xsi:noNamespaceSchemaLocation="PortalConfig_1.4.xsd"

 create-oids="true" type="export" 

 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <portal action="locate">

        <policy-node action="export" label="WebPage" 

                type="theme" path="TestThemePolicy">

             <url>file:///c:/temp/exportTestThemePolicy.xml</url>

        </policy-node>

    </portal>

</request>

Deleting a theme policy

<request xsi:noNamespaceSchemaLocation="PortalConfig_1.4.xsd"

 create-oids="true" type="update" 

 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">



    <portal action="locate">

        <policy-node action="delete" label="WebPage" 

                type="theme" path="TestThemePolicy">

        </policy-node>

    </portal>

</request>