org.apache.jetspeed.desktop
Interface JetspeedDesktopContext

public interface JetspeedDesktopContext

Jetspeed Desktop

Version:

$Id: JetspeedDesktopContext.java $

Author:

David Sean Taylor, Steve Milek

Field Summary

static java.lang.String	DESKTOP_COMPONENT_MANAGER_ATTRIBUTE
static java.lang.String	DESKTOP_CONTEXT_ATTRIBUTE
static java.lang.String	DESKTOP_REQUEST_CONTEXT_ATTRIBUTE
static java.lang.String	LAYOUT_DESKTOP_TEMPLATE_EXTENSION_PROP
static java.lang.String	LAYOUT_PORTALUSER_TEMPLATE_ID_PROP
static java.lang.String	LAYOUT_PRINT_TEMPLATE_ID_PROP
static java.lang.String	LAYOUT_TEMPLATE_EXTENSION_PROP
static java.lang.String	LAYOUT_TEMPLATE_ID_DEFAULT
static java.lang.String	LAYOUT_TEMPLATE_ID_PROP

Method Summary

HeaderResource	getHeaderResource()
java.lang.String	getLayoutBasePath() Returns the base path for the layout decoration.
java.lang.String	getLayoutBasePath(java.lang.String relativePath) Returns the base path for the layout decoration with the relativePath argument added.
java.lang.String	getLayoutBaseUrl() Returns the base url for the layout decoration.
java.lang.String	getLayoutBaseUrl(java.lang.String relativePath) Returns the base url for the layout decoration with the relativePath argument added.
java.lang.String	getLayoutDecorationName() Gets the layout decoration name
java.util.ResourceBundle	getLayoutResourceBundle(java.util.Locale locale)
java.lang.String	getLayoutTemplatePath() Get the path to the layout decoration desktop template file.
java.lang.String	getLayoutTemplatePath(java.lang.String layoutTemplateIdPropertyName) Get the path to the layout decoration desktop template file.
java.lang.String	getPortalBaseUrl() Portal base url ( e.g.
java.lang.String	getPortalBaseUrl(boolean encode) Portal base url ( e.g.
java.lang.String	getPortalResourceUrl(java.lang.String relativePath) Portal base url with relativePath argument appended ( e.g.
java.lang.String	getPortalResourceUrl(java.lang.String relativePath, boolean encode) Portal base url with relativePath argument appended ( e.g.
java.lang.String	getPortalUrl() Portal base servlet url ( e.g.
java.lang.String	getPortalUrl(boolean encode) Portal base servlet url ( e.g.
java.lang.String	getPortalUrl(java.lang.String relativePath) Portal base servlet url with relativePath argument appended ( e.g.
java.lang.String	getPortalUrl(java.lang.String relativePath, boolean encode) Portal base servlet url with relativePath argument appended ( e.g.

Field Detail

DESKTOP_CONTEXT_ATTRIBUTE

static final java.lang.String DESKTOP_CONTEXT_ATTRIBUTE

See Also:

Constant Field Values

DESKTOP_REQUEST_CONTEXT_ATTRIBUTE

static final java.lang.String DESKTOP_REQUEST_CONTEXT_ATTRIBUTE

See Also:

Constant Field Values

DESKTOP_COMPONENT_MANAGER_ATTRIBUTE

static final java.lang.String DESKTOP_COMPONENT_MANAGER_ATTRIBUTE

See Also:

Constant Field Values

LAYOUT_TEMPLATE_EXTENSION_PROP

static final java.lang.String LAYOUT_TEMPLATE_EXTENSION_PROP

See Also:

Constant Field Values

LAYOUT_DESKTOP_TEMPLATE_EXTENSION_PROP

static final java.lang.String LAYOUT_DESKTOP_TEMPLATE_EXTENSION_PROP

See Also:

Constant Field Values

LAYOUT_TEMPLATE_ID_PROP

static final java.lang.String LAYOUT_TEMPLATE_ID_PROP

See Also:

Constant Field Values

LAYOUT_PRINT_TEMPLATE_ID_PROP

static final java.lang.String LAYOUT_PRINT_TEMPLATE_ID_PROP

See Also:

Constant Field Values

LAYOUT_PORTALUSER_TEMPLATE_ID_PROP

static final java.lang.String LAYOUT_PORTALUSER_TEMPLATE_ID_PROP

See Also:

Constant Field Values

LAYOUT_TEMPLATE_ID_DEFAULT

static final java.lang.String LAYOUT_TEMPLATE_ID_DEFAULT

See Also:

Constant Field Values

Method Detail

getPortalBaseUrl

java.lang.String getPortalBaseUrl()

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

Returns:

portal base url

getPortalBaseUrl

java.lang.String getPortalBaseUrl(boolean encode)

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

Returns:

portal base url

getPortalResourceUrl

java.lang.String getPortalResourceUrl(java.lang.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

java.lang.String getPortalResourceUrl(java.lang.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

java.lang.String getPortalUrl()

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

Returns:

portal base servlet url

getPortalUrl

java.lang.String getPortalUrl(boolean encode)

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

Returns:

portal base servlet url

getPortalUrl

java.lang.String getPortalUrl(java.lang.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

java.lang.String getPortalUrl(java.lang.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

getLayoutDecorationName

java.lang.String getLayoutDecorationName()

Gets the layout decoration name

Returns:

getLayoutTemplatePath

java.lang.String getLayoutTemplatePath()

Get the path to the layout decoration desktop template file.

Returns:

the desktop template file path.

getLayoutTemplatePath

java.lang.String getLayoutTemplatePath(java.lang.String layoutTemplateIdPropertyName)

Get the path to the layout decoration desktop template file. The property name parameter is provided to allow for an alternate property value to be used as the filename (without extension) of the desktop template file.

Returns:

the desktop template file path.

getLayoutBasePath

java.lang.String getLayoutBasePath()

Returns the base path for the layout decoration.

Returns:

the base path for the layout decoration.

getLayoutBasePath

java.lang.String getLayoutBasePath(java.lang.String relativePath)

Returns the base path for the layout decoration with the relativePath argument added.

Parameters:

relativePath -

Returns:

the base path for the layout decoration with the relativePath argument added.

getLayoutBaseUrl

java.lang.String getLayoutBaseUrl()

Returns the base url for the layout decoration.

Returns:

the base url for the layout decoration.

getLayoutBaseUrl

java.lang.String getLayoutBaseUrl(java.lang.String relativePath)

Returns the base url for the layout decoration with the relativePath argument added.

Parameters:

relativePath -

Returns:

the base url for the layout decoration with the relativePath argument added.

getLayoutResourceBundle

java.util.ResourceBundle getLayoutResourceBundle(java.util.Locale locale)

Returns:

the layout decoration resource bundle for the given Locale.

getHeaderResource

HeaderResource getHeaderResource()

Returns:

the HeaderResource component.