org.apache.jetspeed.desktop
Interface JetspeedDesktop


public interface JetspeedDesktop

Jetspeed Desktop

Version:
$Id: $
Author:
David Sean Taylor

Field Summary
static String DEFAULT_DESKTOP_ACTION_PIPELINE_PATH
           
static String DEFAULT_DESKTOP_CONFIGURE_PIPELINE_PATH
           
static String DEFAULT_DESKTOP_PIPELINE_PATH
           
static String DEFAULT_DESKTOP_RENDER_PIPELINE_PATH
           
static String DESKTOP_AJAX_REQUEST_PARAMETER
           
static String DESKTOP_ENABLED_REQUEST_ATTRIBUTE
           
static String DESKTOP_ENCODER_REQUEST_PARAMETER
           
static String DESKTOP_ENCODER_REQUEST_PARAMETER_VALUE
           
static String DESKTOP_REQUEST_NOT_AJAX_PARAMETER
           
 
Method Summary
 String getDesktopServletPath()
          Desktop servlet path ( e.g.
 HeaderResourceFactory getHeaderResourceFactory()
          Retrieve the header resource factory
 String getPortalBaseUrl(RequestContext requestContext)
          Portal base url ( e.g.
 String getPortalBaseUrl(RequestContext requestContext, boolean encode)
          Portal base url ( e.g.
 String getPortalResourceUrl(RequestContext requestContext, String relativePath)
          Portal base url with relativePath argument appended ( e.g.
 String getPortalResourceUrl(RequestContext requestContext, String relativePath, boolean encode)
          Portal base url with relativePath argument appended ( e.g.
 String getPortalUrl(RequestContext requestContext)
          Portal base servlet url ( e.g.
 String getPortalUrl(RequestContext requestContext, boolean encode)
          Portal base servlet url ( e.g.
 String getPortalUrl(RequestContext requestContext, String relativePath)
          Portal base servlet url with relativePath argument appended ( e.g.
 String getPortalUrl(RequestContext requestContext, String relativePath, boolean encode)
          Portal base servlet url with relativePath argument appended ( e.g.
 boolean isDesktopEnabled(RequestContext requestContext)
          Indicates whether /desktop is enabled for the current portal request.
 void render(RequestContext request)
          Render a desktop theme.
 

Field Detail

DESKTOP_ENABLED_REQUEST_ATTRIBUTE

static final String DESKTOP_ENABLED_REQUEST_ATTRIBUTE
See Also:
Constant Field Values

DESKTOP_ENCODER_REQUEST_PARAMETER

static final String DESKTOP_ENCODER_REQUEST_PARAMETER
See Also:
Constant Field Values

DESKTOP_ENCODER_REQUEST_PARAMETER_VALUE

static final String DESKTOP_ENCODER_REQUEST_PARAMETER_VALUE
See Also:
Constant Field Values

DESKTOP_AJAX_REQUEST_PARAMETER

static final String DESKTOP_AJAX_REQUEST_PARAMETER
See Also:
Constant Field Values

DESKTOP_REQUEST_NOT_AJAX_PARAMETER

static final String DESKTOP_REQUEST_NOT_AJAX_PARAMETER
See Also:
Constant Field Values

DEFAULT_DESKTOP_PIPELINE_PATH

static final String DEFAULT_DESKTOP_PIPELINE_PATH
See Also:
Constant Field Values

DEFAULT_DESKTOP_ACTION_PIPELINE_PATH

static final String DEFAULT_DESKTOP_ACTION_PIPELINE_PATH
See Also:
Constant Field Values

DEFAULT_DESKTOP_RENDER_PIPELINE_PATH

static final String DEFAULT_DESKTOP_RENDER_PIPELINE_PATH
See Also:
Constant Field Values

DEFAULT_DESKTOP_CONFIGURE_PIPELINE_PATH

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

render

void render(RequestContext request)
Render a desktop theme.

Parameters:
request -

isDesktopEnabled

boolean isDesktopEnabled(RequestContext requestContext)
Indicates whether /desktop is enabled for the current portal request. Located here due to range of jetspeed components which need this information and already have a DecorationFactory reference.

Parameters:
requestContext - current portal request.
Returns:
true if /desktop is enabled for the current portal request, otherwise false

getHeaderResourceFactory

HeaderResourceFactory getHeaderResourceFactory()
Retrieve the header resource factory

Returns:
header resource factory

getDesktopServletPath

String getDesktopServletPath()
Desktop servlet path ( e.g. /desktop )

Returns:
portal base url

getPortalBaseUrl

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

Returns:
portal base url

getPortalBaseUrl

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

Returns:
portal base url

getPortalResourceUrl

String getPortalResourceUrl(RequestContext requestContext,
                            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(RequestContext requestContext,
                            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(RequestContext requestContext)
Portal base servlet url ( e.g. http://localhost:8080/jetspeed/desktop/ )

Returns:
portal base servlet url

getPortalUrl

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

Returns:
portal base servlet url

getPortalUrl

String getPortalUrl(RequestContext requestContext,
                    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(RequestContext requestContext,
                    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


Copyright © 1999-2007 Apache Software Foundation. All Rights Reserved.