com.plumtree.portaluiinfrastructure.tags.displaytree
Class HeadPreprocessor

java.lang.Object
  com.plumtree.portaluiinfrastructure.tags.displaytree.HeadPreprocessor

All Implemented Interfaces:

IHeadPreprocessor

public class HeadPreprocessor
extends java.lang.Object
implements IHeadPreprocessor

This class is used to preprocess the main page to make sure that it has a place where the JavaScript can go.

Field Summary

static java.lang.String	CLOSE_HEAD_TAG This constant is used to insert a head tag around the head includes.
static java.lang.String	COMMON_LIBRARY This is the name of the common library.
static java.lang.String	HEAD_INCLUDES_TAG_FULL_NAME The fully qualified name of the head includes tag in the common library.
static java.lang.String	HEAD_INCLUDES_TAG_NAME This is the name of the Head Includes tag in the common library.
static java.lang.String	JS_INCLUDE_LOCALE_ATTR The name of the include tag attribute used to specify the locale.
static java.lang.String	JS_INCLUDE_TAG_FULL_NAME The full name of the ptui include tag.
static java.lang.String	JS_INCLUDE_TAG_NAME_ATTR The name of the include tag attribute used to specify the JSComponent.
static java.lang.String	OPEN_HEAD_TAG This constant is used to insert a head tag around the head includes.

Constructor Summary

HeadPreprocessor()

Method Summary

protected IMarkupFragment	GetHeadIncludesTag()
protected IMarkupFragment	GetJSIncludesTag(java.lang.String _strLocale)
java.lang.Object[][]	PreprocessHead(java.lang.Object[][] _objArrMarkup, ISessionManager _Session, IEnvironment _Environment, boolean _bForceHead) This function pre-processes the head element of this HTML document to make sure it is in the proper format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPEN_HEAD_TAG

public static final java.lang.String OPEN_HEAD_TAG

This constant is used to insert a head tag around the head includes.

See Also:

Constant Field Values

CLOSE_HEAD_TAG

public static final java.lang.String CLOSE_HEAD_TAG

This constant is used to insert a head tag around the head includes.

See Also:

Constant Field Values

COMMON_LIBRARY

public static final java.lang.String COMMON_LIBRARY

This is the name of the common library.

See Also:

Constant Field Values

HEAD_INCLUDES_TAG_NAME

public static final java.lang.String HEAD_INCLUDES_TAG_NAME

This is the name of the Head Includes tag in the common library.

See Also:

Constant Field Values

HEAD_INCLUDES_TAG_FULL_NAME

public static final java.lang.String HEAD_INCLUDES_TAG_FULL_NAME

The fully qualified name of the head includes tag in the common library.

See Also:

Constant Field Values

JS_INCLUDE_TAG_FULL_NAME

public static final java.lang.String JS_INCLUDE_TAG_FULL_NAME

The full name of the ptui include tag.

See Also:

Constant Field Values

JS_INCLUDE_TAG_NAME_ATTR

public static final java.lang.String JS_INCLUDE_TAG_NAME_ATTR

The name of the include tag attribute used to specify the JSComponent.

See Also:

Constant Field Values

JS_INCLUDE_LOCALE_ATTR

public static final java.lang.String JS_INCLUDE_LOCALE_ATTR

The name of the include tag attribute used to specify the locale.

See Also:

Constant Field Values

Constructor Detail

HeadPreprocessor

public HeadPreprocessor()

Method Detail

PreprocessHead

public java.lang.Object[][] PreprocessHead(java.lang.Object[][] _objArrMarkup,
                                           ISessionManager _Session,
                                           IEnvironment _Environment,
                                           boolean _bForceHead)

Description copied from interface: IHeadPreprocessor

This function pre-processes the head element of this HTML document to make sure it is in the proper format. If necessary, this will add the HeadIncludes tag as well as create the HEAD element if it does not exist. This should only be called for main pages. NOTE: PreprocessHead needs to be called at least once per request, otherwise the shared JavaScript will not be added to the page. Otherwise, the GetSharedJavaScriptForMultipleMarkupAsElement method needs to be called or the shared JavaScript will not be displayed.

Specified by:

PreprocessHead in interface IHeadPreprocessor

Returns:

Object[][] objArrMarkup the new Object[][] markup.

See Also:

IHeadPreprocessor.PreprocessHead(Object[][], ISessionManager, IEnvironment, boolean)

GetHeadIncludesTag

protected IMarkupFragment GetHeadIncludesTag()

Returns:

The markup fragment containing the head includes singleton tag.

GetJSIncludesTag

protected IMarkupFragment GetJSIncludesTag(java.lang.String _strLocale)

Returns:

The markup fragment containing the JS includes singleton tag.