JetspeedDesktopContext (Jetspeed-2 Core API 2.3.1 API)

```
public interface JetspeedDesktopContext
```
Jetspeed Desktop

Version:

$Id: JetspeedDesktopContext.java $

Author:

David Sean Taylor, Steve Milek

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DESKTOP_COMPONENT_MANAGER_ATTRIBUTE`
`static String`	`DESKTOP_CONTEXT_ATTRIBUTE`
`static String`	`DESKTOP_REQUEST_CONTEXT_ATTRIBUTE`
`static String`	`LAYOUT_DESKTOP_TEMPLATE_EXTENSION_PROP`
`static String`	`LAYOUT_PORTALUSER_TEMPLATE_ID_PROP`
`static String`	`LAYOUT_PRINT_TEMPLATE_ID_PROP`
`static String`	`LAYOUT_TEMPLATE_EXTENSION_PROP`
`static String`	`LAYOUT_TEMPLATE_ID_DEFAULT`
`static String`	`LAYOUT_TEMPLATE_ID_PROP`

Method Summary

Methods
Modifier and Type	Method and Description
`HeaderResource`	`getHeaderResource()`
`String`	`getLayoutBasePath()` Returns the base path for the layout decoration.
`String`	`getLayoutBasePath(String relativePath)` Returns the base path for the layout decoration with the relativePath argument added.
`String`	`getLayoutBaseUrl()` Returns the base url for the layout decoration.
`String`	`getLayoutBaseUrl(String relativePath)` Returns the base url for the layout decoration with the relativePath argument added.
`String`	`getLayoutDecorationName()` Gets the layout decoration name
`ResourceBundle`	`getLayoutResourceBundle(Locale locale)`
`String`	`getLayoutTemplatePath()` Get the path to the layout decoration desktop template file.
`String`	`getLayoutTemplatePath(String layoutTemplateIdPropertyName)` Get the path to the layout decoration desktop template file.
`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.

- Field Detail
  - DESKTOP_CONTEXT_ATTRIBUTE
```
static final String DESKTOP_CONTEXT_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - DESKTOP_REQUEST_CONTEXT_ATTRIBUTE
```
static final String DESKTOP_REQUEST_CONTEXT_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - DESKTOP_COMPONENT_MANAGER_ATTRIBUTE
```
static final String DESKTOP_COMPONENT_MANAGER_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - LAYOUT_TEMPLATE_EXTENSION_PROP
```
static final String LAYOUT_TEMPLATE_EXTENSION_PROP
```
    See Also:
    Constant Field Values
  - LAYOUT_DESKTOP_TEMPLATE_EXTENSION_PROP
```
static final String LAYOUT_DESKTOP_TEMPLATE_EXTENSION_PROP
```
    See Also:
    Constant Field Values
  - LAYOUT_TEMPLATE_ID_PROP
```
static final String LAYOUT_TEMPLATE_ID_PROP
```
    See Also:
    Constant Field Values
  - LAYOUT_PRINT_TEMPLATE_ID_PROP
```
static final String LAYOUT_PRINT_TEMPLATE_ID_PROP
```
    See Also:
    Constant Field Values
  - LAYOUT_PORTALUSER_TEMPLATE_ID_PROP
```
static final String LAYOUT_PORTALUSER_TEMPLATE_ID_PROP
```
    See Also:
    Constant Field Values
  - LAYOUT_TEMPLATE_ID_DEFAULT
```
static final String LAYOUT_TEMPLATE_ID_DEFAULT
```
    See Also:
    Constant Field Values
- Method Detail
  - 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
  - getLayoutDecorationName
```
String getLayoutDecorationName()
```
    Gets the layout decoration name
    
    Returns:
  - getLayoutTemplatePath
```
String getLayoutTemplatePath()
```
    Get the path to the layout decoration desktop template file.
    
    Returns:
    the desktop template file path.
  - getLayoutTemplatePath
```
String getLayoutTemplatePath(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
```
String getLayoutBasePath()
```
    Returns the base path for the layout decoration.
    
    Returns:
    the base path for the layout decoration.
  - getLayoutBasePath
```
String getLayoutBasePath(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
```
String getLayoutBaseUrl()
```
    Returns the base url for the layout decoration.
    
    Returns:
    the base url for the layout decoration.
  - getLayoutBaseUrl
```
String getLayoutBaseUrl(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
```
ResourceBundle getLayoutResourceBundle(Locale locale)
```
    Returns:
    the layout decoration resource bundle for the given Locale.
  - getHeaderResource
```
HeaderResource getHeaderResource()
```
    Returns:
    the HeaderResource component.

Interface JetspeedDesktopContext

Field Summary

Method Summary

Field Detail

DESKTOP_CONTEXT_ATTRIBUTE

DESKTOP_REQUEST_CONTEXT_ATTRIBUTE

DESKTOP_COMPONENT_MANAGER_ATTRIBUTE

LAYOUT_TEMPLATE_EXTENSION_PROP

LAYOUT_DESKTOP_TEMPLATE_EXTENSION_PROP

LAYOUT_TEMPLATE_ID_PROP

LAYOUT_PRINT_TEMPLATE_ID_PROP

LAYOUT_PORTALUSER_TEMPLATE_ID_PROP

LAYOUT_TEMPLATE_ID_DEFAULT

Method Detail

getPortalBaseUrl

getPortalBaseUrl

getPortalResourceUrl

getPortalResourceUrl

getPortalUrl

getPortalUrl

getPortalUrl

getPortalUrl

getLayoutDecorationName

getLayoutTemplatePath

getLayoutTemplatePath

getLayoutBasePath

getLayoutBasePath

getLayoutBaseUrl

getLayoutBaseUrl

getLayoutResourceBundle

getHeaderResource