Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.jetspeed.headerresource
Interface HeaderResource

public interface HeaderResource

HeaderResource has tags information to put them into <head> tag.

Version:
$Id: HeaderResource.java 188569 2005-05-13 13:35:18Z weaver $
Author:
Shinsuke Sugaya, Steve Milek

Field Summary
static String DESKTOP_JSON_WINDOW_ACTION_BUTTON_MAX
           
static String DESKTOP_JSON_WINDOW_ACTION_BUTTON_ORDER
           
static String DESKTOP_JSON_WINDOW_ACTION_BUTTON_TOOLTIP
           
static String DESKTOP_JSON_WINDOW_ACTION_MENU_ORDER
           
static String DESKTOP_JSON_WINDOW_ACTION_NOIMAGE
           
static String DESKTOP_JSON_WINDOW_ICON_ENABLED
           
static String DESKTOP_JSON_WINDOW_ICON_PATH
           
static String DESKTOP_JSON_WINDOW_RESIZEBAR_ENABLED
           
static String DESKTOP_JSON_WINDOW_TITLEBAR_ENABLED
           
static String HEADER_CONFIG_DESKTOP
           
static String HEADER_CONFIG_DESKTOP_LAYOUT_DECORATION_DEFAULT
           
static String HEADER_CONFIG_DESKTOP_PAGE_ACTION_BUTTON_TOOLTIP
           
static String HEADER_CONFIG_DESKTOP_PAGE_AJAXNAVIGATION
           
static String HEADER_CONFIG_DESKTOP_PORTLET_DECORATION_DEFAULT
           
static String HEADER_CONFIG_DESKTOP_WINDOW_ACTION_BUTTON_MAX
           
static String HEADER_CONFIG_DESKTOP_WINDOW_ACTION_BUTTON_ORDER
           
static String HEADER_CONFIG_DESKTOP_WINDOW_ACTION_BUTTON_TOOLTIP
           
static String HEADER_CONFIG_DESKTOP_WINDOW_ACTION_MENU_ORDER
           
static String HEADER_CONFIG_DESKTOP_WINDOW_ACTION_NOIMAGE
           
static String HEADER_CONFIG_DESKTOP_WINDOW_HEIGHT
           
static String HEADER_CONFIG_DESKTOP_WINDOW_HEIGHT_EXPAND
           
static String HEADER_CONFIG_DESKTOP_WINDOW_ICON_ENABLED
           
static String HEADER_CONFIG_DESKTOP_WINDOW_ICON_PATH
           
static String HEADER_CONFIG_DESKTOP_WINDOW_RESIZEBAR_ENABLED
           
static String HEADER_CONFIG_DESKTOP_WINDOW_TILING
           
static String HEADER_CONFIG_DESKTOP_WINDOW_TITLEBAR_ENABLED
           
static String HEADER_CONFIG_DESKTOP_WINDOW_WIDTH
           
static String HEADER_CONFIG_DOJO
           
static String HEADER_CONFIG_DOJO_ENABLE
           
static String HEADER_CONFIG_DOJO_MODULES_NAMESPACE
           
static String HEADER_CONFIG_DOJO_MODULES_PATH
           
static String HEADER_CONFIG_DOJO_PARAM_DEBUGALLCOSTS
           
static String HEADER_CONFIG_DOJO_PARAM_ISDEBUG
           
static String HEADER_CONFIG_DOJO_PARAM_PREVENT_BACKBUTTON_FIX
           
static String HEADER_CONFIG_DOJO_PARAMS
           
static String HEADER_CONFIG_DOJO_PATH
           
static String HEADER_CONFIG_DOJO_REQUIRES_CORE
           
static String HEADER_CONFIG_DOJO_REQUIRES_MODULES
           
static String HEADER_CONFIG_ORDER
           
static String HEADER_CONFIG_REQUIREDFLAG
           
static String HEADER_CONFIG_TYPES
           
static String HEADER_DEBUG_REQUIRES
           
static String HEADER_INTERNAL_CONFIG_DESKTOP_WINDOW_ACTION
           
static String HEADER_INTERNAL_DOJO_CONFIG_JETSPEED_VAR_NAME
           
static String HEADER_INTERNAL_DOJO_CONFIG_JETSPEED_VAR_NAME_SCOPE
           
static String HEADER_INTERNAL_INCLUDED_NAMES
           
static String HEADER_INTERNAL_JETSPEED_VAR_NAME
           
static String HEADER_SECTION_BASE_TAG
           
static String HEADER_SECTION_DESKTOP_INIT
           
static String HEADER_SECTION_DESKTOP_STYLE_LAYOUT
           
static String HEADER_SECTION_DOJO_CONFIG
           
static String HEADER_SECTION_DOJO_INIT
           
static String HEADER_SECTION_DOJO_MODULES_NAMESPACE
           
static String HEADER_SECTION_DOJO_MODULES_PATH
           
static String HEADER_SECTION_DOJO_PARAMETERS
           
static String HEADER_SECTION_DOJO_PREINIT
           
static String HEADER_SECTION_DOJO_REQUIRES_CORE
           
static String HEADER_SECTION_DOJO_REQUIRES_MODULES
           
static String HEADER_SECTION_DOJO_STYLE_BODYEXPAND
           
static String HEADER_SECTION_DOJO_STYLE_BODYEXPAND_NOSCROLL
           
static String HEADER_SECTION_DOJO_WRITEINCLUDES
           
static String HEADER_SECTION_NAME_PREFIX_DOJO
           
static String HEADER_TYPE_BASE_TAG
           
static int HEADER_TYPE_ID_BASE_TAG
           
static int HEADER_TYPE_ID_LINK_TAG
           
static int HEADER_TYPE_ID_SCRIPT_BLOCK
           
static int HEADER_TYPE_ID_SCRIPT_BLOCK_END
           
static int HEADER_TYPE_ID_SCRIPT_BLOCK_START
           
static int HEADER_TYPE_ID_SCRIPT_TAG
           
static int HEADER_TYPE_ID_STYLE_BLOCK
           
static String HEADER_TYPE_LINK_TAG
           
static String HEADER_TYPE_SCRIPT_BLOCK
           
static String HEADER_TYPE_SCRIPT_BLOCK_END
           
static String HEADER_TYPE_SCRIPT_BLOCK_START
           
static String HEADER_TYPE_SCRIPT_TAG
           
static String HEADER_TYPE_STYLE_BLOCK
           
 
Method Summary
 void addHeaderInfo(String text)
          Add text as-is to this instance.
 void addHeaderInfo(String elementName, Map attributes, String text)
          Add tag information to this instance.
 void addHeaderSectionFragment(String addToHeaderName, String text)
          Add text argument to the getHeaderSections() content entry with a key that matches addToHeaderName argument
 void addHeaderSectionFragment(String headerFragmentName, String addToHeaderName, String text)
          If no previous call using value of headerFragmentName argument has been added to any getHeaderSections() content entry, add text argument to the getHeaderSections() content entry with a key that matches addToHeaderName argument
 void addJavaScript(String path)
          Convenient method to add <script> tag.
 void addJavaScript(String path, boolean defer)
          Convenient method to add <script> tag with defer option.
 void addStyleSheet(String path)
          Convenient method to add <link> tag.
 void dojoAddBodyExpandStyle(boolean omitWindowScrollbars)
          Assure that header section name for dojo body expand style is included
 void dojoAddCoreLibraryRequire(String dojoRequire)
          If no previous call using value of dojoRequire argument has been added to any getHeaderSections() content entry, add text argument to getHeaderSections() content entry for dojo core require statements
 void dojoAddCoreLibraryRequires(String dojoRequires)
          Split dojoRequires argument using ';' delimiter and for each resulting dojoRequire value, if no previous call using dojoRequire value has been added to any getHeaderSections() content entry, add text argument to getHeaderSections() content entry for dojo core require statements
 void dojoAddModuleLibraryRequire(String dojoRequire)
          If no previous call using value of dojoRequire argument has been added to any getHeaderSections() content entry, add text argument to getHeaderSections() content entry for dojo library module require statements
 void dojoAddModuleLibraryRequires(String dojoRequires)
          Split dojoRequires argument using ';' delimiter and for each resulting dojoRequire value, if no previous call using dojoRequire value has been added to any getHeaderSections() content entry, add text argument to getHeaderSections() content entry for dojo library module require statements
 void dojoEnable()
          Enable dojo by setting appropriate modifiable header configuration setting
 String getContent()
          Output all content (that has not already been output)
 Map getHeaderConfiguration()
          Access complete header configuration settings
 Map getHeaderDynamicConfiguration()
          Access modifiable header configuration settings
 String getHeaderSectionRequiredFlag(String headerName)
          Get the requiredflag of the getHeaderSections() content entry with a key that matches headerName argument
 String getHeaderSectionType(String headerName)
          Get the type of the getHeaderSections() content entry with a key that matches headerName argument
 String getNamedContent()
          Output all getHeaderSections() content (that has not already been output)
 String getNamedContent(String headerName)
          Output the one getHeaderSections() content entry with a key that matches headerName (if it has not already been output)
 String getNamedContentForPrefix(String headerNamePrefix)
          Output getHeaderSections() content entries with key prefixes that match headerNamePrefix (if it has not already been output)
 String getPortalBaseUrl()
          Portal base url ( e.g.
 String getPortalBaseUrl(boolean encode)
          Portal base url ( e.g.
 String getPortalResourceUrl(String relativePath)
          Portal base url with relativePath argument appended ( e.g.
 String getPortalResourceUrl(String relativePath, boolean encode)
          Portal base url with relativePath argument appended ( e.g.
 String getPortalUrl()
          Portal base servlet url ( e.g.
 String getPortalUrl(boolean encode)
          Portal base servlet url ( e.g.
 String getPortalUrl(String relativePath)
          Portal base servlet url with relativePath argument appended ( e.g.
 String getPortalUrl(String relativePath, boolean encode)
          Portal base servlet url with relativePath argument appended ( e.g.
 String getUnnamedContent()
          Output all unnamed content (that has not already been output)
 boolean hasHeaderSectionFragment(String headerFragmentName)
          Indicate whether value of headerFragmentName argument has been used to add to any getHeaderSections() content entry
 boolean isDesktop()
          Is request for /desktop rather than /portal
 boolean isHeaderSectionIncluded(String headerName)
          Indicate whether value of headerName is an included header section
 void setHeaderSectionRequiredFlag(String headerName, String headerReqFlag)
          Set the requiredflag of the getHeaderSections() content entry with a key that matches headerName argument to the value of the headerReqFlag argument
 void setHeaderSectionType(String headerName, String headerType)
          Set the type of the getHeaderSections() content entry with a key that matches headerName argument to the value of the headerType argument
 String toString()
          Output all content (that has not already been output)
 

Field Detail

HEADER_TYPE_SCRIPT_BLOCK_START

static final String HEADER_TYPE_SCRIPT_BLOCK_START
See Also:
Constant Field Values

HEADER_TYPE_ID_SCRIPT_BLOCK_START

static final int HEADER_TYPE_ID_SCRIPT_BLOCK_START
See Also:
Constant Field Values

HEADER_TYPE_SCRIPT_BLOCK

static final String HEADER_TYPE_SCRIPT_BLOCK
See Also:
Constant Field Values

HEADER_TYPE_ID_SCRIPT_BLOCK

static final int HEADER_TYPE_ID_SCRIPT_BLOCK
See Also:
Constant Field Values

HEADER_TYPE_SCRIPT_BLOCK_END

static final String HEADER_TYPE_SCRIPT_BLOCK_END
See Also:
Constant Field Values

HEADER_TYPE_ID_SCRIPT_BLOCK_END

static final int HEADER_TYPE_ID_SCRIPT_BLOCK_END
See Also:
Constant Field Values

HEADER_TYPE_SCRIPT_TAG

static final String HEADER_TYPE_SCRIPT_TAG
See Also:
Constant Field Values

HEADER_TYPE_ID_SCRIPT_TAG

static final int HEADER_TYPE_ID_SCRIPT_TAG
See Also:
Constant Field Values

HEADER_TYPE_STYLE_BLOCK

static final String HEADER_TYPE_STYLE_BLOCK
See Also:
Constant Field Values

HEADER_TYPE_ID_STYLE_BLOCK

static final int HEADER_TYPE_ID_STYLE_BLOCK
See Also:
Constant Field Values

HEADER_TYPE_LINK_TAG

static final String HEADER_TYPE_LINK_TAG
See Also:
Constant Field Values

HEADER_TYPE_ID_LINK_TAG

static final int HEADER_TYPE_ID_LINK_TAG
See Also:
Constant Field Values

HEADER_TYPE_BASE_TAG

static final String HEADER_TYPE_BASE_TAG
See Also:
Constant Field Values

HEADER_TYPE_ID_BASE_TAG

static final int HEADER_TYPE_ID_BASE_TAG
See Also:
Constant Field Values

HEADER_CONFIG_ORDER

static final String HEADER_CONFIG_ORDER
See Also:
Constant Field Values

HEADER_CONFIG_TYPES

static final String HEADER_CONFIG_TYPES
See Also:
Constant Field Values

HEADER_CONFIG_REQUIREDFLAG

static final String HEADER_CONFIG_REQUIREDFLAG
See Also:
Constant Field Values

HEADER_CONFIG_DOJO

static final String HEADER_CONFIG_DOJO
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP

static final String HEADER_CONFIG_DESKTOP
See Also:
Constant Field Values

HEADER_INTERNAL_INCLUDED_NAMES

static final String HEADER_INTERNAL_INCLUDED_NAMES
See Also:
Constant Field Values

HEADER_SECTION_BASE_TAG

static final String HEADER_SECTION_BASE_TAG
See Also:
Constant Field Values

HEADER_SECTION_NAME_PREFIX_DOJO

static final String HEADER_SECTION_NAME_PREFIX_DOJO
See Also:
Constant Field Values

HEADER_SECTION_DOJO_PARAMETERS

static final String HEADER_SECTION_DOJO_PARAMETERS
See Also:
Constant Field Values

HEADER_SECTION_DOJO_PREINIT

static final String HEADER_SECTION_DOJO_PREINIT
See Also:
Constant Field Values

HEADER_SECTION_DOJO_CONFIG

static final String HEADER_SECTION_DOJO_CONFIG
See Also:
Constant Field Values

HEADER_SECTION_DOJO_INIT

static final String HEADER_SECTION_DOJO_INIT
See Also:
Constant Field Values

HEADER_SECTION_DOJO_REQUIRES_CORE

static final String HEADER_SECTION_DOJO_REQUIRES_CORE
See Also:
Constant Field Values

HEADER_SECTION_DOJO_MODULES_PATH

static final String HEADER_SECTION_DOJO_MODULES_PATH
See Also:
Constant Field Values

HEADER_SECTION_DOJO_REQUIRES_MODULES

static final String HEADER_SECTION_DOJO_REQUIRES_MODULES
See Also:
Constant Field Values

HEADER_SECTION_DOJO_WRITEINCLUDES

static final String HEADER_SECTION_DOJO_WRITEINCLUDES
See Also:
Constant Field Values

HEADER_SECTION_DOJO_MODULES_NAMESPACE

static final String HEADER_SECTION_DOJO_MODULES_NAMESPACE
See Also:
Constant Field Values

HEADER_SECTION_DOJO_STYLE_BODYEXPAND

static final String HEADER_SECTION_DOJO_STYLE_BODYEXPAND
See Also:
Constant Field Values

HEADER_SECTION_DOJO_STYLE_BODYEXPAND_NOSCROLL

static final String HEADER_SECTION_DOJO_STYLE_BODYEXPAND_NOSCROLL
See Also:
Constant Field Values

HEADER_SECTION_DESKTOP_STYLE_LAYOUT

static final String HEADER_SECTION_DESKTOP_STYLE_LAYOUT
See Also:
Constant Field Values

HEADER_SECTION_DESKTOP_INIT

static final String HEADER_SECTION_DESKTOP_INIT
See Also:
Constant Field Values

HEADER_INTERNAL_JETSPEED_VAR_NAME

static final String HEADER_INTERNAL_JETSPEED_VAR_NAME
See Also:
Constant Field Values

HEADER_INTERNAL_DOJO_CONFIG_JETSPEED_VAR_NAME

static final String HEADER_INTERNAL_DOJO_CONFIG_JETSPEED_VAR_NAME
See Also:
Constant Field Values

HEADER_INTERNAL_DOJO_CONFIG_JETSPEED_VAR_NAME_SCOPE

static final String HEADER_INTERNAL_DOJO_CONFIG_JETSPEED_VAR_NAME_SCOPE
See Also:
Constant Field Values

HEADER_CONFIG_DOJO_ENABLE

static final String HEADER_CONFIG_DOJO_ENABLE
See Also:
Constant Field Values

HEADER_CONFIG_DOJO_PATH

static final String HEADER_CONFIG_DOJO_PATH
See Also:
Constant Field Values

HEADER_CONFIG_DOJO_PARAM_ISDEBUG

static final String HEADER_CONFIG_DOJO_PARAM_ISDEBUG
See Also:
Constant Field Values

HEADER_CONFIG_DOJO_PARAM_DEBUGALLCOSTS

static final String HEADER_CONFIG_DOJO_PARAM_DEBUGALLCOSTS
See Also:
Constant Field Values

HEADER_CONFIG_DOJO_PARAM_PREVENT_BACKBUTTON_FIX

static final String HEADER_CONFIG_DOJO_PARAM_PREVENT_BACKBUTTON_FIX
See Also:
Constant Field Values

HEADER_CONFIG_DOJO_PARAMS

static final String HEADER_CONFIG_DOJO_PARAMS
See Also:
Constant Field Values

HEADER_CONFIG_DOJO_REQUIRES_CORE

static final String HEADER_CONFIG_DOJO_REQUIRES_CORE
See Also:
Constant Field Values

HEADER_CONFIG_DOJO_MODULES_PATH

static final String HEADER_CONFIG_DOJO_MODULES_PATH
See Also:
Constant Field Values

HEADER_CONFIG_DOJO_MODULES_NAMESPACE

static final String HEADER_CONFIG_DOJO_MODULES_NAMESPACE
See Also:
Constant Field Values

HEADER_CONFIG_DOJO_REQUIRES_MODULES

static final String HEADER_CONFIG_DOJO_REQUIRES_MODULES
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_LAYOUT_DECORATION_DEFAULT

static final String HEADER_CONFIG_DESKTOP_LAYOUT_DECORATION_DEFAULT
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_PORTLET_DECORATION_DEFAULT

static final String HEADER_CONFIG_DESKTOP_PORTLET_DECORATION_DEFAULT
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_PAGE_AJAXNAVIGATION

static final String HEADER_CONFIG_DESKTOP_PAGE_AJAXNAVIGATION
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_PAGE_ACTION_BUTTON_TOOLTIP

static final String HEADER_CONFIG_DESKTOP_PAGE_ACTION_BUTTON_TOOLTIP
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_WINDOW_TILING

static final String HEADER_CONFIG_DESKTOP_WINDOW_TILING
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_WINDOW_HEIGHT_EXPAND

static final String HEADER_CONFIG_DESKTOP_WINDOW_HEIGHT_EXPAND
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_WINDOW_HEIGHT

static final String HEADER_CONFIG_DESKTOP_WINDOW_HEIGHT
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_WINDOW_WIDTH

static final String HEADER_CONFIG_DESKTOP_WINDOW_WIDTH
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_WINDOW_ACTION_BUTTON_ORDER

static final String HEADER_CONFIG_DESKTOP_WINDOW_ACTION_BUTTON_ORDER
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_WINDOW_ACTION_NOIMAGE

static final String HEADER_CONFIG_DESKTOP_WINDOW_ACTION_NOIMAGE
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_WINDOW_ACTION_MENU_ORDER

static final String HEADER_CONFIG_DESKTOP_WINDOW_ACTION_MENU_ORDER
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_WINDOW_ACTION_BUTTON_MAX

static final String HEADER_CONFIG_DESKTOP_WINDOW_ACTION_BUTTON_MAX
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_WINDOW_ACTION_BUTTON_TOOLTIP

static final String HEADER_CONFIG_DESKTOP_WINDOW_ACTION_BUTTON_TOOLTIP
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_WINDOW_ICON_ENABLED

static final String HEADER_CONFIG_DESKTOP_WINDOW_ICON_ENABLED
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_WINDOW_ICON_PATH

static final String HEADER_CONFIG_DESKTOP_WINDOW_ICON_PATH
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_WINDOW_TITLEBAR_ENABLED

static final String HEADER_CONFIG_DESKTOP_WINDOW_TITLEBAR_ENABLED
See Also:
Constant Field Values

HEADER_CONFIG_DESKTOP_WINDOW_RESIZEBAR_ENABLED

static final String HEADER_CONFIG_DESKTOP_WINDOW_RESIZEBAR_ENABLED
See Also:
Constant Field Values

DESKTOP_JSON_WINDOW_ACTION_BUTTON_ORDER

static final String DESKTOP_JSON_WINDOW_ACTION_BUTTON_ORDER
See Also:
Constant Field Values

DESKTOP_JSON_WINDOW_ACTION_NOIMAGE

static final String DESKTOP_JSON_WINDOW_ACTION_NOIMAGE
See Also:
Constant Field Values

DESKTOP_JSON_WINDOW_ACTION_MENU_ORDER

static final String DESKTOP_JSON_WINDOW_ACTION_MENU_ORDER
See Also:
Constant Field Values

DESKTOP_JSON_WINDOW_ACTION_BUTTON_MAX

static final String DESKTOP_JSON_WINDOW_ACTION_BUTTON_MAX
See Also:
Constant Field Values

DESKTOP_JSON_WINDOW_ACTION_BUTTON_TOOLTIP

static final String DESKTOP_JSON_WINDOW_ACTION_BUTTON_TOOLTIP
See Also:
Constant Field Values

DESKTOP_JSON_WINDOW_ICON_ENABLED

static final String DESKTOP_JSON_WINDOW_ICON_ENABLED
See Also:
Constant Field Values

DESKTOP_JSON_WINDOW_ICON_PATH

static final String DESKTOP_JSON_WINDOW_ICON_PATH
See Also:
Constant Field Values

DESKTOP_JSON_WINDOW_TITLEBAR_ENABLED

static final String DESKTOP_JSON_WINDOW_TITLEBAR_ENABLED
See Also:
Constant Field Values

DESKTOP_JSON_WINDOW_RESIZEBAR_ENABLED

static final String DESKTOP_JSON_WINDOW_RESIZEBAR_ENABLED
See Also:
Constant Field Values

HEADER_INTERNAL_CONFIG_DESKTOP_WINDOW_ACTION

static final String HEADER_INTERNAL_CONFIG_DESKTOP_WINDOW_ACTION
See Also:
Constant Field Values

HEADER_DEBUG_REQUIRES

static final String HEADER_DEBUG_REQUIRES
See Also:
Constant Field Values
Method Detail

toString

String toString()
Output all content (that has not already been output)

Overrides:
toString in class Object
Returns:
content string for inclusion in html <head>

getContent

String getContent()
Output all content (that has not already been output)

Returns:
content string for inclusion in html <head>

getUnnamedContent

String getUnnamedContent()
Output all unnamed content (that has not already been output)

Returns:
content string for inclusion in html <head>

getNamedContent

String getNamedContent()
Output all getHeaderSections() content (that has not already been output)

Returns:
content string for inclusion in html <head>

getNamedContent

String getNamedContent(String headerName)
Output the one getHeaderSections() content entry with a key that matches headerName (if it has not already been output)

Returns:
content string for inclusion in html <head>

getNamedContentForPrefix

String getNamedContentForPrefix(String headerNamePrefix)
Output getHeaderSections() content entries with key prefixes that match headerNamePrefix (if it has not already been output)

Returns:
content string for inclusion in html <head>

addHeaderSectionFragment

void addHeaderSectionFragment(String addToHeaderName,
                              String text)
Add text argument to the getHeaderSections() content entry with a key that matches addToHeaderName argument

addHeaderSectionFragment

void addHeaderSectionFragment(String headerFragmentName,
                              String addToHeaderName,
                              String text)
If no previous call using value of headerFragmentName argument has been added to any getHeaderSections() content entry, add text argument to the getHeaderSections() content entry with a key that matches addToHeaderName argument

hasHeaderSectionFragment

boolean hasHeaderSectionFragment(String headerFragmentName)
Indicate whether value of headerFragmentName argument has been used to add to any getHeaderSections() content entry

Returns:
true if headerFragmentName argument has been used to add to any getHeaderSections() content entry

isHeaderSectionIncluded

boolean isHeaderSectionIncluded(String headerName)
Indicate whether value of headerName is an included header section

Returns:
true if headerName argument is an included header section

getHeaderSectionType

String getHeaderSectionType(String headerName)
Get the type of the getHeaderSections() content entry with a key that matches headerName argument

Returns:
type of header section

setHeaderSectionType

void setHeaderSectionType(String headerName,
                          String headerType)
Set the type of the getHeaderSections() content entry with a key that matches headerName argument to the value of the headerType argument

getHeaderSectionRequiredFlag

String getHeaderSectionRequiredFlag(String headerName)
Get the requiredflag of the getHeaderSections() content entry with a key that matches headerName argument

Returns:
requiredflag for header section

setHeaderSectionRequiredFlag

void setHeaderSectionRequiredFlag(String headerName,
                                  String headerReqFlag)
Set the requiredflag of the getHeaderSections() content entry with a key that matches headerName argument to the value of the headerReqFlag argument

getHeaderDynamicConfiguration

Map getHeaderDynamicConfiguration()
Access modifiable header configuration settings

Returns:
Map containing modifiable header configuration settings

getHeaderConfiguration

Map getHeaderConfiguration()
Access complete header configuration settings

Returns:
unmodifiable Map containing complete header configuration settings

isDesktop

boolean isDesktop()
Is request for /desktop rather than /portal

Returns:
true if request is for /desktop, false if request is for /portal

getPortalBaseUrl

String getPortalBaseUrl()
Portal base url ( e.g. http://localhost:8080/jetspeed )

Returns:
portal base url

getPortalBaseUrl

String getPortalBaseUrl(boolean encode)
Portal base url ( e.g. http://localhost:8080/jetspeed )

Returns:
portal base url

getPortalResourceUrl

String getPortalResourceUrl(String relativePath)
Portal base url with relativePath argument appended ( e.g. http://localhost:8080/jetspeed/javascript/dojo/ )

Returns:
portal base url with relativePath argument appended

getPortalResourceUrl

String getPortalResourceUrl(String relativePath,
                            boolean encode)
Portal base url with relativePath argument appended ( e.g. http://localhost:8080/jetspeed/javascript/dojo/ )

Returns:
portal base url with relativePath argument appended

getPortalUrl

String getPortalUrl()
Portal base servlet url ( e.g. http://localhost:8080/jetspeed/desktop/ )

Returns:
portal base servlet url

getPortalUrl

String getPortalUrl(boolean encode)
Portal base servlet url ( e.g. http://localhost:8080/jetspeed/desktop/ )

Returns:
portal base servlet url

getPortalUrl

String getPortalUrl(String relativePath)
Portal base servlet url with relativePath argument appended ( e.g. http://localhost:8080/jetspeed/desktop/default-page.psml )

Returns:
portal base servlet url with relativePath argument appended

getPortalUrl

String getPortalUrl(String relativePath,
                    boolean encode)
Portal base servlet url with relativePath argument appended ( e.g. http://localhost:8080/jetspeed/desktop/default-page.psml )

Returns:
portal base servlet url with relativePath argument appended

dojoAddCoreLibraryRequire

void dojoAddCoreLibraryRequire(String dojoRequire)
If no previous call using value of dojoRequire argument has been added to any getHeaderSections() content entry, add text argument to getHeaderSections() content entry for dojo core require statements

dojoAddCoreLibraryRequires

void dojoAddCoreLibraryRequires(String dojoRequires)
Split dojoRequires argument using ';' delimiter and for each resulting dojoRequire value, if no previous call using dojoRequire value has been added to any getHeaderSections() content entry, add text argument to getHeaderSections() content entry for dojo core require statements

dojoAddModuleLibraryRequire

void dojoAddModuleLibraryRequire(String dojoRequire)
If no previous call using value of dojoRequire argument has been added to any getHeaderSections() content entry, add text argument to getHeaderSections() content entry for dojo library module require statements

dojoAddModuleLibraryRequires

void dojoAddModuleLibraryRequires(String dojoRequires)
Split dojoRequires argument using ';' delimiter and for each resulting dojoRequire value, if no previous call using dojoRequire value has been added to any getHeaderSections() content entry, add text argument to getHeaderSections() content entry for dojo library module require statements

dojoAddBodyExpandStyle

void dojoAddBodyExpandStyle(boolean omitWindowScrollbars)
Assure that header section name for dojo body expand style is included

dojoEnable

void dojoEnable()
Enable dojo by setting appropriate modifiable header configuration setting

addHeaderInfo

void addHeaderInfo(String elementName,
                   Map attributes,
                   String text)
Add tag information to this instance. For example, if you want to add the following tag into <head>, <foo a="1" b="2">FOO FOO</foo> Java code is: HashMap map=new HashMap(); map.put("a","1"); map.put("b","2"); headerResouce.addHeaderInfo("foo",map,"FOO FOO");

Parameters:
elementName - Tag's name
attributes - Tag's attributes
text - Tag's content

addHeaderInfo

void addHeaderInfo(String text)
Add text as-is to this instance.

Parameters:
text - content

addJavaScript

void addJavaScript(String path,
                   boolean defer)
Convenient method to add <script> tag with defer option.

Parameters:
path - Javascript file path
defer - defer attributes for <script> tag.

addJavaScript

void addJavaScript(String path)
Convenient method to add <script> tag.

Parameters:
path - Javascript file path

addStyleSheet

void addStyleSheet(String path)
Convenient method to add <link> tag.

Parameters:
path - CSS file path
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 1999-2007 Apache Software Foundation. All Rights Reserved.