public interface Decoration
| Modifier and Type | Interface and Description | 
|---|---|
| static class  | Decoration.ActionsOption | 
| static class  | Decoration.TitleOption | 
| Modifier and Type | Field and Description | 
|---|---|
| static String | BASE_CSS_CLASS_PROPProperty for specifying the base CSS class to be used to
 create a proper CSS cascade and style isolation for a decoration. | 
| static String | CONFIG_DESKTOP_FILE_NAMEDecoration desktop configuration filename | 
| static String | CONFIG_FILE_NAMEDecoration configuration filename | 
| static String | DEFAULT_COMMON_STYLE_SHEETDefault style sheet location | 
| static String | DEFAULT_DESKTOP_STYLE_SHEET | 
| static String | DEFAULT_PORTAL_STYLE_SHEET | 
| static String | DESKTOP_SUPPORTED_PROPERTYProperty which indicates whether or not decoration supports desktop mode | 
| static String | OPTION_ACTIONS | 
| static String | OPTION_DRAGHANDLE | 
| static String | OPTION_TITLE | 
| static String | RESOURCE_BUNDLE_PROPProperty which specifies the resource bundle locator prefix | 
| static String | RESOURCES_DIRECTORY_NAMEProperty which specifies the directory name for resource bundle | 
| Modifier and Type | Method and Description | 
|---|---|
| List<DecoratorAction> | getActions()Returns the list of  DecoratorActions to be displayed
 within the portlet window. | 
| Decoration.ActionsOption | getActionsOption() | 
| String | getBaseCSSClass()Returns the base CSS class the template should use to
 create a proper CSS cascade and style isolation for a 
 decoration. | 
| String | getBasePath()
 Returns the base path for the decoration. | 
| String | getBasePath(String relativePath)
 Returns the base path for the decoration
 with the relativePath argument added. | 
| String | getCurrentModeAction()Returns the name of the currently active mode action | 
| String | getCurrentStateAction()Returns the name of the currently active state action | 
| String | getDragHandle() | 
| String | getName()The name of this Decoration. | 
| String | getProperty(String name)Allows access to abritrary properties configured
 within your  decorator.propertiesconfig
 file. | 
| String | getResource(String path)
 Returns the correct path to the resource based on the
 relative  pathargument. | 
| ResourceBundle | getResourceBundle(Locale locale,
                 RequestContext context) | 
| String | getResourceBundleName() | 
| String | getStyleSheet() | 
| String | getStyleSheetDesktop() | 
| String | getStyleSheetPortal() | 
| Decoration.TitleOption | getTitleOption() | 
| void | setActions(List<DecoratorAction> actions)Set the list of  DecoratorActions to be displayed
 within the portlet window. | 
| void | setCurrentModeAction(String currentModeAction)Set the name of the currently active mode action | 
| void | setCurrentStateAction(String currentStateAction)Set the name of the currently active state action | 
| boolean | supportsDesktop()Indicates whether the decorator supports /desktop | 
static final String DEFAULT_COMMON_STYLE_SHEET
static final String DEFAULT_PORTAL_STYLE_SHEET
static final String DEFAULT_DESKTOP_STYLE_SHEET
static final String CONFIG_FILE_NAME
static final String CONFIG_DESKTOP_FILE_NAME
static final String DESKTOP_SUPPORTED_PROPERTY
static final String BASE_CSS_CLASS_PROP
static final String RESOURCE_BUNDLE_PROP
static final String RESOURCES_DIRECTORY_NAME
static final String OPTION_TITLE
static final String OPTION_ACTIONS
static final String OPTION_DRAGHANDLE
Decoration.ActionsOption getActionsOption()
Decoration.TitleOption getTitleOption()
String getDragHandle()
String getName()
String getBasePath()
Returns the base path for the decoration.
String getBasePath(String relativePath)
Returns the base path for the decoration with the relativePath argument added.
relativePath - String getResource(String path)
 Returns the correct path to the resource based on the
 relative path argument.  This usually entails
 locating the resource that is most appropriate for the
 current users client and locale.
 
Example Criterion: Relative Path: images/myimage.gif Client: web browser Language: en Country: US
The implementation should now attempt to resolve the resource using logic that starts at the most specific and ends at the most general path.
For exmaples sake, lets say we are concerned with finding the image, myimage.gif, within the layout decoration, tigris. The logical progression to find the resourc, myimage.gif, would be as follows:
/decorations/layout/tigris/html/en/US/images/myimage.gif /decorations/layout/tigris/html/en/images/myimage.gif /decorations/layout/tigris/html/images/myimage.gif /decorations/layout/tigris/images/myimage.gif /decorations/layout/images/myimage.gif /decorations/layout/images/myimage.gif
path - path argument.String getStyleSheet()
String getStyleSheetPortal()
String getStyleSheetDesktop()
List<DecoratorAction> getActions()
DecoratorActions to be displayed
 within the portlet window.DecoratorActions to be displayed
 within the portlet window.DecoratorActionvoid setActions(List<DecoratorAction> actions)
DecoratorActions to be displayed
 within the portlet window.actions - actions to displayed within this portlet window.DecoratorActionString getProperty(String name)
decorator.properties config
 file.name - String getBaseCSSClass()
String getCurrentModeAction()
void setCurrentModeAction(String currentModeAction)
String getCurrentStateAction()
void setCurrentStateAction(String currentStateAction)
String getResourceBundleName()
ResourceBundle getResourceBundle(Locale locale, RequestContext context)
boolean supportsDesktop()
Copyright © 1999–2016 The Apache Software Foundation. All rights reserved.