org.apache.jetspeed.layout
Interface JetspeedPowerTool

public interface JetspeedPowerTool

JetspeedPowerTool

Version:

$Id: JetspeedPowerTool.java 516448 2007-03-09 16:25:47Z ate $

Author:

David Sean Taylor

Field Summary

static String	DECORATOR_TYPE
static String	FRAGMENT_ATTR
static String	FRAGMENT_PROCESSING_ERROR_PREFIX
static String	GENERIC_TEMPLATE_TYPE
static String	HIDDEN
static String	LAYOUT_ATTR
static String	LAYOUT_TEMPLATE_TYPE

Method Summary

String	decorateAndInclude(ContentFragment f) Decorate and include fragment content.
String	getAbsoluteUrl(String relativePath)
String	getBasePath()
List[]	getColumns()
List	getColumnSizes()
Object	getComponent(String name)
ContentFragment	getCurrentFragment()
ContentFragment	getCurrentLayout()
org.apache.pluto.om.entity.PortletEntity	getCurrentPortletEntity()
TemplateDescriptor	getDecoration(String path, String templateType)
List	getDecoratorActions() Gets the list of decorator actions for a window.
boolean	getLoggedOn()
javax.portlet.PortletMode	getMappedPortletMode() Gets the internal (portal) portlet mode for a current portlet window (fragment)
javax.portlet.WindowState	getMappedWindowState() Gets the internal (portal) window state for the current portlet window (fragment)
Page	getPage()
String	getPageBasePath()
List	getPageDecoratorActions() Gets the list of decorator actions for a page.
org.apache.pluto.om.entity.PortletEntity	getPortletEntity(ContentFragment f)
javax.portlet.PortletMode	getPortletMode() Gets the portlet mode for a current portlet window (fragment)
Subject	getSubject()
TemplateDescriptor	getTemplate(String path, String templateType) Retreives a template using Jetspeed's
String	getTitle(org.apache.pluto.om.entity.PortletEntity entity) getTitle
String	getTitle(org.apache.pluto.om.entity.PortletEntity entity, ContentFragment f) getTitle
javax.portlet.WindowState	getWindowState() Gets the window state for the current portlet window (fragment)
String	includeDecoration(String template, String templateType)
String	includeTemplate(String template, String templateType)
boolean	isHidden(ContentFragment f) Checks the the visibilty of this fragment with respect to the current RenderReqeust.
String	renderPortletEntity(String entityId, String portletId)
void	setCurrentFragment(ContentFragment f)
void	setCurrentLayout()

Field Detail

GENERIC_TEMPLATE_TYPE

static final String GENERIC_TEMPLATE_TYPE

See Also:

Constant Field Values

FRAGMENT_PROCESSING_ERROR_PREFIX

static final String FRAGMENT_PROCESSING_ERROR_PREFIX

See Also:

Constant Field Values

FRAGMENT_ATTR

static final String FRAGMENT_ATTR

See Also:

Constant Field Values

LAYOUT_ATTR

static final String LAYOUT_ATTR

See Also:

Constant Field Values

HIDDEN

static final String HIDDEN

See Also:

Constant Field Values

LAYOUT_TEMPLATE_TYPE

static final String LAYOUT_TEMPLATE_TYPE

See Also:

Constant Field Values

DECORATOR_TYPE

static final String DECORATOR_TYPE

See Also:

Constant Field Values

Method Detail

getWindowState

javax.portlet.WindowState getWindowState()
                                         throws Exception

Gets the window state for the current portlet window (fragment)

Returns:

The window state for the current window

Throws:

Exception

getMappedWindowState

javax.portlet.WindowState getMappedWindowState()
                                               throws Exception

Gets the internal (portal) window state for the current portlet window (fragment)

Returns:

The window state for the current window

Throws:

Exception

getPortletMode

javax.portlet.PortletMode getPortletMode()
                                         throws Exception

Gets the portlet mode for a current portlet window (fragment)

Returns:

The portlet mode of the current window

Throws:

Exception

getMappedPortletMode

javax.portlet.PortletMode getMappedPortletMode()
                                               throws Exception

Gets the internal (portal) portlet mode for a current portlet window (fragment)

Returns:

The portlet mode of the current window

Throws:

Exception

getCurrentFragment

ContentFragment getCurrentFragment()

Returns:

setCurrentFragment

void setCurrentFragment(ContentFragment f)

Parameters:

f -

setCurrentLayout

void setCurrentLayout()

getCurrentLayout

ContentFragment getCurrentLayout()

Returns:

getPage

Page getPage()

Returns:

getColumns

List[] getColumns()

Returns:

getColumnSizes

List getColumnSizes()

getCurrentPortletEntity

org.apache.pluto.om.entity.PortletEntity getCurrentPortletEntity()
                                                                 throws Exception

Returns:

Throws:

Exception

getPortletEntity

org.apache.pluto.om.entity.PortletEntity getPortletEntity(ContentFragment f)
                                                          throws Exception

Parameters:

f - Fragment whose PortletEntity we want to retreive.

Returns:

The PortletEntity represented by the current fragment.

Throws:

Exception

isHidden

boolean isHidden(ContentFragment f)

Checks the the visibilty of this fragment with respect to the current RenderReqeust.

Parameters:

f - Fragment

Returns:

whether or not the Fragment in question should be considered visible during rendering.

getTemplate

TemplateDescriptor getTemplate(String path,
                               String templateType)
                               throws TemplateLocatorException

Retreives a template using Jetspeed's

Parameters:

path - Expected to the template. This may actually be changed by the TL service based the capability and localization information provided by the client.

templateType - Type off template we are interested in.

Returns:

Template object containng the pertinent information required to inlcude the request template path in the current response

Throws:

TemplateLocatorException - if the path does not exist.

See Also:

TemplateLocator

getDecoration

TemplateDescriptor getDecoration(String path,
                                 String templateType)
                                 throws TemplateLocatorException

Throws:

TemplateLocatorException

includeTemplate

String includeTemplate(String template,
                       String templateType)
                       throws IOException

Throws:

IOException

includeDecoration

String includeDecoration(String template,
                         String templateType)
                         throws IOException

Throws:

IOException

decorateAndInclude

String decorateAndInclude(ContentFragment f)
                          throws Exception

Decorate and include fragment content.

Parameters:

f - Fragment to include and decorate

Returns:

String path to the decorator.

Throws:

Exception

getDecoratorActions

List getDecoratorActions()

Gets the list of decorator actions for a window. Each window (on each page) has its own collection of actionAccess flags associated with it.

Returns:

A list of actions available to the current window, filtered by securty access and current state.

Throws:

Exception

getPageDecoratorActions

List getPageDecoratorActions()
                             throws Exception

Gets the list of decorator actions for a page. Each layout fragment on a page has its own collection of actionAccess flags associated with it.

Returns:

A list of actions available to the current window, filtered by securty access and current state.

Throws:

Exception

getTitle

String getTitle(org.apache.pluto.om.entity.PortletEntity entity,
                ContentFragment f)

getTitle

Returns the appropriate for the title based on locale prferences

Parameters:

entity -

Returns:

getTitle

String getTitle(org.apache.pluto.om.entity.PortletEntity entity)

getTitle

Returns the appropriate for the title based on locale prferences

Parameters:

entity -

Returns:

getComponent

Object getComponent(String name)

getAbsoluteUrl

String getAbsoluteUrl(String relativePath)

getSubject

Subject getSubject()

getLoggedOn

boolean getLoggedOn()

getBasePath

String getBasePath()

getPageBasePath

String getPageBasePath()

renderPortletEntity

String renderPortletEntity(String entityId,
                           String portletId)