|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Decoration
Nested Class Summary | |
---|---|
static class |
Decoration.ActionsOption
|
static class |
Decoration.TitleOption
|
Field Summary | |
---|---|
static java.lang.String |
BASE_CSS_CLASS_PROP
Property for specifying the base CSS class to be used to create a proper CSS cascade and style isolation for a decoration. |
static java.lang.String |
CONFIG_DESKTOP_FILE_NAME
Decoration desktop configuration filename |
static java.lang.String |
CONFIG_FILE_NAME
Decoration configuration filename |
static java.lang.String |
DEFAULT_COMMON_STYLE_SHEET
Default style sheet location |
static java.lang.String |
DEFAULT_DESKTOP_STYLE_SHEET
|
static java.lang.String |
DEFAULT_PORTAL_STYLE_SHEET
|
static java.lang.String |
DESKTOP_SUPPORTED_PROPERTY
Property which indicates whether or not decoration supports desktop mode |
static java.lang.String |
OPTION_ACTIONS
|
static java.lang.String |
OPTION_DRAGHANDLE
|
static java.lang.String |
OPTION_TITLE
|
static java.lang.String |
RESOURCE_BUNDLE_PROP
Property which specifies the resource bundle locator prefix |
static java.lang.String |
RESOURCES_DIRECTORY_NAME
Property which specifies the directory name for resource bundle |
Method Summary | |
---|---|
java.util.List |
getActions()
Returns the list of DecoratorAction s to be displayed
within the portlet window. |
Decoration.ActionsOption |
getActionsOption()
|
java.lang.String |
getBaseCSSClass()
Returns the base CSS class the template should use to create a proper CSS cascade and style isolation for a decoration. |
java.lang.String |
getBasePath()
Returns the base path for the decoration. |
java.lang.String |
getBasePath(java.lang.String relativePath)
Returns the base path for the decoration with the relativePath argument added. |
java.lang.String |
getCurrentModeAction()
Returns the name of the currently active mode action |
java.lang.String |
getCurrentStateAction()
Returns the name of the currently active state action |
java.lang.String |
getDragHandle()
|
java.lang.String |
getName()
The name of this Decoration. |
java.lang.String |
getProperty(java.lang.String name)
Allows access to abritrary properties configured within your decorator.properties config
file. |
java.lang.String |
getResource(java.lang.String path)
Returns the correct path to the resource based on the relative path argument. |
java.util.ResourceBundle |
getResourceBundle(java.util.Locale locale,
RequestContext context)
|
java.lang.String |
getResourceBundleName()
|
java.lang.String |
getStyleSheet()
|
java.lang.String |
getStyleSheetDesktop()
|
java.lang.String |
getStyleSheetPortal()
|
Decoration.TitleOption |
getTitleOption()
|
void |
setActions(java.util.List actions)
Set the list of DecoratorAction s to be displayed
within the portlet window. |
void |
setCurrentModeAction(java.lang.String currentModeAction)
Set the name of the currently active mode action |
void |
setCurrentStateAction(java.lang.String currentStateAction)
Set the name of the currently active state action |
boolean |
supportsDesktop()
Indicates whether the decorator supports /desktop |
Field Detail |
---|
static final java.lang.String DEFAULT_COMMON_STYLE_SHEET
static final java.lang.String DEFAULT_PORTAL_STYLE_SHEET
static final java.lang.String DEFAULT_DESKTOP_STYLE_SHEET
static final java.lang.String CONFIG_FILE_NAME
static final java.lang.String CONFIG_DESKTOP_FILE_NAME
static final java.lang.String DESKTOP_SUPPORTED_PROPERTY
static final java.lang.String BASE_CSS_CLASS_PROP
static final java.lang.String RESOURCE_BUNDLE_PROP
static final java.lang.String RESOURCES_DIRECTORY_NAME
static final java.lang.String OPTION_TITLE
static final java.lang.String OPTION_ACTIONS
static final java.lang.String OPTION_DRAGHANDLE
Method Detail |
---|
Decoration.ActionsOption getActionsOption()
Decoration.TitleOption getTitleOption()
java.lang.String getDragHandle()
java.lang.String getName()
java.lang.String getBasePath()
Returns the base path for the decoration.
java.lang.String getBasePath(java.lang.String relativePath)
Returns the base path for the decoration with the relativePath argument added.
relativePath
-
java.lang.String getResource(java.lang.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.java.lang.String getStyleSheet()
java.lang.String getStyleSheetPortal()
java.lang.String getStyleSheetDesktop()
java.util.List getActions()
DecoratorAction
s to be displayed
within the portlet window.
DecoratorAction
s to be displayed
within the portlet window.org.apache.jetspeed.decoration.DecoratorAction
void setActions(java.util.List actions)
DecoratorAction
s to be displayed
within the portlet window.
actions
- actions to displayed within this portlet window.org.apache.jetspeed.decoration.DecoratorAction
java.lang.String getProperty(java.lang.String name)
decorator.properties
config
file.
name
-
java.lang.String getBaseCSSClass()
java.lang.String getCurrentModeAction()
void setCurrentModeAction(java.lang.String currentModeAction)
java.lang.String getCurrentStateAction()
void setCurrentStateAction(java.lang.String currentStateAction)
java.lang.String getResourceBundleName()
java.util.ResourceBundle getResourceBundle(java.util.Locale locale, RequestContext context)
boolean supportsDesktop()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |