|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DecorationFactory
Factory class used for locating Decorations and Themes for Fragments and pages.
Decoration
,
PortletDecoration
,
LayoutDecoration
,
Theme
Field Summary | |
---|---|
static String |
DEFAULT_NESTED_LAYOUT_PORTLET_DECORATOR
Default nested layout portlet decorator |
Method Summary | |
---|---|
void |
clearCache(RequestContext requestContext)
Clears the lookup cache of all previous located pathes. |
Decoration |
getDecoration(Page page,
Fragment fragment,
RequestContext requestContext)
Returns a Decoration for a specific Fragment contained
within the specified Page . |
String |
getDefaultDesktopLayoutDecoration()
Get the default desktop layout decoration to be used when selected layout decoration does not support /desktop. |
String |
getDefaultDesktopPortletDecoration()
Get the default desktop portlet decoration to be used when selected portlet decoration does not support /desktop. |
Set |
getDesktopPageDecorations(RequestContext request)
Get the portal-wide list of available desktop page decorations. |
Set |
getDesktopPortletDecorations(RequestContext request)
Get the portal-wide list of desktop portlet decorations. |
LayoutDecoration |
getLayoutDecoration(String name,
RequestContext requestContext)
Returns a named layout Decoration appropriate to the current request conetext. |
String |
getLayoutDecorationsBasePath()
Get the path to the layout decorations directory. |
List |
getLayouts(RequestContext request)
Get the portal-wide list of available layouts. |
Set |
getPageDecorations(RequestContext request)
Get the portal-wide list of page decorations. |
PortletDecoration |
getPortletDecoration(String name,
RequestContext requestContext)
Returns a names portlet Decoration appropriate to the current request conetext. |
Set |
getPortletDecorations(RequestContext request)
Get the portal-wide list of portlet decorations. |
String |
getPortletDecorationsBasePath()
Get the path to the portlet decorations directory. |
Theme |
getTheme(Page page,
RequestContext requestContext)
Returns a theme containing all of the Decorations for all of the layouts on the current page. |
boolean |
isDesktopEnabled(RequestContext requestContext)
Indicates whether /desktop is enabled for the current portal request. |
void |
setDefaultDesktopLayoutDecoration(String newOne)
Set the default desktop layout decoration to be used when selected layout decoration does not support /desktop. |
void |
setDefaultDesktopPortletDecoration(String newOne)
Set the default desktop portlet decoration to be used when selected portlet decoration does not support /desktop. |
Field Detail |
---|
static final String DEFAULT_NESTED_LAYOUT_PORTLET_DECORATOR
Method Detail |
---|
Theme getTheme(Page page, RequestContext requestContext)
page
- Page whose theme we are requestingrequestContext
- Current portal request.
Theme
,
RequestContext
PortletDecoration getPortletDecoration(String name, RequestContext requestContext)
name
- Formal name of the decoration.requestContext
- Current portal request.
RequestContext
,
PortletDecoration
LayoutDecoration getLayoutDecoration(String name, RequestContext requestContext)
name
- Formal name of the decoration.requestContext
- Current portal request.
LayoutDecoration
,
RequestContext
Decoration getDecoration(Page page, Fragment fragment, RequestContext requestContext)
Fragment
contained
within the specified Page
.
page
- Current pagefragment
- Fragment whose decoration we require.requestContext
- Current portal request.
Page
,
Fragment
,
RequestContext
boolean isDesktopEnabled(RequestContext requestContext)
requestContext
- current portal request.
void clearCache(RequestContext requestContext)
RequestContext
's current user. This
will generally delegate the cache operation to the PathResolverCache
currently in use.
requestContext
- Current portal request.RequestContext
,
PathResolverCache
Set getPageDecorations(RequestContext request)
String
Set getPortletDecorations(RequestContext request)
String
List getLayouts(RequestContext request)
LayoutInfo
Set getDesktopPageDecorations(RequestContext request)
String
Set getDesktopPortletDecorations(RequestContext request)
String
String getLayoutDecorationsBasePath()
String getPortletDecorationsBasePath()
String getDefaultDesktopLayoutDecoration()
void setDefaultDesktopLayoutDecoration(String newOne)
String getDefaultDesktopPortletDecoration()
void setDefaultDesktopPortletDecoration(String newOne)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |