com.plumtree.portaluiinfrastructure.tags.displaytree
Interface IHeadPreprocessor

All Known Implementing Classes:

HeadPreprocessor

public interface IHeadPreprocessor

This class handles preprocessing the markup list to ensure that the HEAD element is in the proper format. It also adds the HeadIncludes tag to the markup.

Method Summary

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.

Method Detail

PreprocessHead

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. 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.

Parameters:

Object[][] - _objArrMarkup An Object[][] of markup

ISessionManager - _Session

IEnvironment - _Environment

boolean - _bForceHead Whether or not to force the markup array list to include a head element, regardless of other factors.

Returns:

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