|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JetspeedPowerTool
JetspeedPowerTool
Field Summary | |
---|---|
static java.lang.String |
DECORATOR_TYPE
|
static java.lang.String |
FRAGMENT_ATTR
|
static java.lang.String |
FRAGMENT_PROCESSING_ERROR_PREFIX
|
static java.lang.String |
GENERIC_TEMPLATE_TYPE
|
static java.lang.String |
HIDDEN
|
static java.lang.String |
LAYOUT_ATTR
|
static java.lang.String |
LAYOUT_TEMPLATE_TYPE
|
Method Summary | |
---|---|
java.lang.String |
decorateAndInclude(ContentFragment f)
Decorate and include fragment content. |
java.lang.String |
getAbsoluteUrl(java.lang.String relativePath)
|
java.lang.String |
getBasePath()
|
java.util.List[] |
getColumns()
|
java.util.List |
getColumnSizes()
|
java.lang.Object |
getComponent(java.lang.String name)
|
ContentFragment |
getCurrentFragment()
|
ContentFragment |
getCurrentLayout()
|
org.apache.pluto.om.entity.PortletEntity |
getCurrentPortletEntity()
|
TemplateDescriptor |
getDecoration(java.lang.String path,
java.lang.String templateType)
|
java.util.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()
|
java.lang.String |
getPageBasePath()
|
java.util.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) |
javax.security.auth.Subject |
getSubject()
|
TemplateDescriptor |
getTemplate(java.lang.String path,
java.lang.String templateType)
Retreives a template using Jetspeed's |
java.lang.String |
getTitle(org.apache.pluto.om.entity.PortletEntity entity)
getTitle |
java.lang.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) |
java.lang.String |
includeDecoration(java.lang.String template,
java.lang.String templateType)
|
java.lang.String |
includeTemplate(java.lang.String template,
java.lang.String templateType)
|
boolean |
isHidden(ContentFragment f)
Checks the the visibilty of this fragment with respect to the current RenderReqeust. |
java.lang.String |
renderPortletEntity(java.lang.String entityId,
java.lang.String portletId)
|
void |
setCurrentFragment(ContentFragment f)
|
void |
setCurrentLayout()
|
Field Detail |
---|
static final java.lang.String GENERIC_TEMPLATE_TYPE
static final java.lang.String FRAGMENT_PROCESSING_ERROR_PREFIX
static final java.lang.String FRAGMENT_ATTR
static final java.lang.String LAYOUT_ATTR
static final java.lang.String HIDDEN
static final java.lang.String LAYOUT_TEMPLATE_TYPE
static final java.lang.String DECORATOR_TYPE
Method Detail |
---|
javax.portlet.WindowState getWindowState() throws java.lang.Exception
java.lang.Exception
javax.portlet.WindowState getMappedWindowState() throws java.lang.Exception
java.lang.Exception
javax.portlet.PortletMode getPortletMode() throws java.lang.Exception
java.lang.Exception
javax.portlet.PortletMode getMappedPortletMode() throws java.lang.Exception
java.lang.Exception
ContentFragment getCurrentFragment()
void setCurrentFragment(ContentFragment f)
f
- void setCurrentLayout()
ContentFragment getCurrentLayout()
Page getPage()
java.util.List[] getColumns()
java.util.List getColumnSizes()
org.apache.pluto.om.entity.PortletEntity getCurrentPortletEntity() throws java.lang.Exception
java.lang.Exception
org.apache.pluto.om.entity.PortletEntity getPortletEntity(ContentFragment f) throws java.lang.Exception
f
- Fragment whose PortletEntity
we want to
retreive.
java.lang.Exception
boolean isHidden(ContentFragment f)
f
- Fragment
TemplateDescriptor getTemplate(java.lang.String path, java.lang.String templateType) throws TemplateLocatorException
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.
TemplateLocatorException
- if the path
does not exist.TemplateLocator
TemplateDescriptor getDecoration(java.lang.String path, java.lang.String templateType) throws TemplateLocatorException
TemplateLocatorException
java.lang.String includeTemplate(java.lang.String template, java.lang.String templateType) throws java.io.IOException
java.io.IOException
java.lang.String includeDecoration(java.lang.String template, java.lang.String templateType) throws java.io.IOException
java.io.IOException
java.lang.String decorateAndInclude(ContentFragment f) throws java.lang.Exception
Decorate and include fragment content.
f
- Fragment to include and decorate
java.lang.Exception
java.util.List getDecoratorActions()
java.lang.Exception
java.util.List getPageDecoratorActions() throws java.lang.Exception
java.lang.Exception
java.lang.String getTitle(org.apache.pluto.om.entity.PortletEntity entity, ContentFragment f)
getTitle
Returns the appropriate for the title based on locale prferences
entity
-
java.lang.String getTitle(org.apache.pluto.om.entity.PortletEntity entity)
getTitle
Returns the appropriate for the title based on locale prferences
entity
-
java.lang.Object getComponent(java.lang.String name)
java.lang.String getAbsoluteUrl(java.lang.String relativePath)
javax.security.auth.Subject getSubject()
boolean getLoggedOn()
java.lang.String getBasePath()
java.lang.String getPageBasePath()
java.lang.String renderPortletEntity(java.lang.String entityId, java.lang.String portletId)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |