org.apache.jetspeed.portlet
Interface HeaderPhaseSupportConstants

public interface HeaderPhaseSupportConstants

This interface defines some constants for attribute name or value of contributed head elements. This constant values are used by Jetspeed portal to optimize the head elements aggregation.

Jetspeed can look up 'id' attribute value not to include redundant head element. Also, Jetspeed can look up 'org.apache.portals.portal.page.head.element.contribution.merge.hint' attribute value to merge all the text content of elements containing 'org.apache.portals.portal.page.head.element.contribution.merge.hint' attribute with same value.

For example, if the following elements are contributed by a portlet,

<script id="header.dojo.library.include" language="JavaScript" src="/script/dojo/dojo.js"></script> <script language="JavaScript" org.apache.portals.portal.page.head.element.contribution.merge.hint="header.dojo.requires"> dojo.require("dojo.io.*"); </script> and, if the following elements are contributed by another portlet, <script id="header.dojo.library.include" language="JavaScript" src="/script/dojo/dojo.js"></script> <script language="JavaScript" org.apache.portals.portal.page.head.element.contribution.merge.hint="header.dojo.requires"> dojo.require("dojo.lang.*"); </script> then, the result aggregated elements are to be like the following: <script id="header.dojo.library.include" language="JavaScript" src="/script/dojo/dojo.js"></script> <script language="JavaScript" org.apache.portals.portal.page.head.element.contribution.merge.hint="header.dojo.requires"> dojo.require("dojo.io.*"); dojo.require("dojo.lang.*"); </script>

Version:

$Id: HeaderPhaseSupportConstants.java 881415 2009-11-17 18:07:00Z woonsan $

Field Summary

static java.util.Set<java.lang.String>	CONTAINER_HEAD_ELEMENT_CONTRIBUTION_ELEMENT_ID_SET ID attribute values set for script libraries included by the container.
static java.lang.String	HEAD_ELEMENT_CONTRIBUTION_ELEMENT_ID_DOJO_LIBRARY_INCLUDE An ID attribute value for dojo library inclusion which can be used in head elements merging by portal.
static java.lang.String	HEAD_ELEMENT_CONTRIBUTION_ELEMENT_ID_YUI_LIBRARY_INCLUDE An ID attribute value for YUI library inclusion which can be used in head elements merging by portal.
static java.lang.String	HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_ATTRIBUTE An attribute name of head element contributed to the portal page aggregation by a portlet.
static java.lang.String	HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_KEY_DOJO_CONFIG An attribute value for key hint to aggregate dojo configuration which can be used in head elements merging by portal.
static java.lang.String	HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_KEY_DOJO_REQUIRES An attribute value for key hint to aggregate dojo require statements which can be used in head elements merging by portal.

Field Detail

HEAD_ELEMENT_CONTRIBUTION_ELEMENT_ID_DOJO_LIBRARY_INCLUDE

static final java.lang.String HEAD_ELEMENT_CONTRIBUTION_ELEMENT_ID_DOJO_LIBRARY_INCLUDE

An ID attribute value for dojo library inclusion which can be used in head elements merging by portal.

See Also:

Constant Field Values

HEAD_ELEMENT_CONTRIBUTION_ELEMENT_ID_YUI_LIBRARY_INCLUDE

static final java.lang.String HEAD_ELEMENT_CONTRIBUTION_ELEMENT_ID_YUI_LIBRARY_INCLUDE

An ID attribute value for YUI library inclusion which can be used in head elements merging by portal.

See Also:

Constant Field Values

CONTAINER_HEAD_ELEMENT_CONTRIBUTION_ELEMENT_ID_SET

static final java.util.Set<java.lang.String> CONTAINER_HEAD_ELEMENT_CONTRIBUTION_ELEMENT_ID_SET

ID attribute values set for script libraries included by the container.

HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_ATTRIBUTE

static final java.lang.String HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_ATTRIBUTE

An attribute name of head element contributed to the portal page aggregation by a portlet. The value of this attribute can be used by portal to merge contents of each contributed head element into centralized element(s).
For example, if a contributed head element has an attribute value, 'dojo.require', with text content, 'dojo.lang.*' and another contributed element has the same attribute value, 'dojo.require', with text content, 'dojo.event.*', then a portal can merge those contents into a single script element for optimization.

See Also:

Constant Field Values

HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_KEY_DOJO_CONFIG

static final java.lang.String HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_KEY_DOJO_CONFIG

An attribute value for key hint to aggregate dojo configuration which can be used in head elements merging by portal.

See Also:

Constant Field Values

HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_KEY_DOJO_REQUIRES

static final java.lang.String HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_KEY_DOJO_REQUIRES

An attribute value for key hint to aggregate dojo require statements which can be used in head elements merging by portal.

See Also:

Constant Field Values