Java Doc for Decoration.java in » Portal » jetspeed-2.1.3 » org » apache » jetspeed » decoration » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Portal » jetspeed 2.1.3 » org.apache.jetspeed.decoration

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.jetspeed.decoration .Decoration

All known Subclasses:   org.apache.jetspeed.decoration .BaseDecoration,
Decoration
public interface Decoration (Code)

author:
   Scott T. Weaver

Field Summary
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.
String CONFIG_DESKTOP_FILE_NAME

String CONFIG_FILE_NAME

String DEFAULT_COMMON_STYLE_SHEET

String DEFAULT_DESKTOP_STYLE_SHEET

String DEFAULT_PORTAL_STYLE_SHEET

String DESKTOP_SUPPORTED_PROPERTY

String RESOURCES_DIRECTORY_NAME

String RESOURCE_BUNDLE_PROP


Method Summary
List getActions()
     Returns the list of DecoratorActions to be displayed within the portlet window.
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()

String getCurrentStateAction()

String getName()
     The name of this Decoration.
String getProperty(String name)
     Allows access to abritrary properties configured within your decorator.properties config file.
String getResource(String path)

Returns the correct path to the resource based on the relative path argument.
ResourceBundle getResourceBundle(Locale locale, org.apache.jetspeed.request.RequestContext context)

String getResourceBundleName()

String getStyleSheet()

String getStyleSheetDesktop()

String getStyleSheetPortal()

void setActions(List actions)
     Set the list of DecoratorActions to be displayed within the portlet window.
See Also:   org.apache.jetspeed.decoration.DecoratorAction
Parameters:
  actions - actions to displayed within this portlet window.
void setCurrentModeAction(String currentModeAction)

void setCurrentStateAction(String currentStateAction)

boolean supportsDesktop()


Field Detail
BASE_CSS_CLASS_PROP
String BASE_CSS_CLASS_PROP(Code)
Property for specifying the base CSS class to be used to create a proper CSS cascade and style isolation for a decoration.

CONFIG_DESKTOP_FILE_NAME
String CONFIG_DESKTOP_FILE_NAME(Code)
Decoration desktop configuration filename

CONFIG_FILE_NAME
String CONFIG_FILE_NAME(Code)
Decoration configuration filename

DEFAULT_COMMON_STYLE_SHEET
String DEFAULT_COMMON_STYLE_SHEET(Code)
Default style sheet location

DEFAULT_DESKTOP_STYLE_SHEET
String DEFAULT_DESKTOP_STYLE_SHEET(Code)

DEFAULT_PORTAL_STYLE_SHEET
String DEFAULT_PORTAL_STYLE_SHEET(Code)

DESKTOP_SUPPORTED_PROPERTY
String DESKTOP_SUPPORTED_PROPERTY(Code)
Property which indicates whether or not decoration supports desktop mode

RESOURCES_DIRECTORY_NAME
String RESOURCES_DIRECTORY_NAME(Code)
Property which specifies the directory name for resource bundle

RESOURCE_BUNDLE_PROP
String RESOURCE_BUNDLE_PROP(Code)
Property which specifies the resource bundle locator prefix

Method Detail
getActions
List getActions()(Code)
Returns the list of DecoratorActions to be displayed within the portlet window.
See Also:   org.apache.jetspeed.decoration.DecoratorAction the list of DecoratorActions to be displayedwithin the portlet window.

getBaseCSSClass
String getBaseCSSClass()(Code)
Returns the base CSS class the template should use to create a proper CSS cascade and style isolation for a decoration. the base CSS class the template should use.

getBasePath
String getBasePath()(Code)

Returns the base path for the decoration.
the base path for the decoration.

getBasePath
String getBasePath(String relativePath)(Code)

Returns the base path for the decoration with the relativePath argument added.

Parameters:
  relativePath - the base path for the decoration with the relativePath argument added.

getCurrentModeAction
String getCurrentModeAction()(Code)
Returns the name of the currently active mode action the name of the currently active mode action

getCurrentStateAction
String getCurrentStateAction()(Code)
Returns the name of the currently active state action the name of the currently active state action

getName
String getName()(Code)
The name of this Decoration. Name of this decoration.

getProperty
String getProperty(String name)(Code)
Allows access to abritrary properties configured within your decorator.properties config file.
Parameters:
  name - value of decoration property which matches name argument.

getResource
String getResource(String path)(Code)

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

Parameters:
  path - the correct path to the resource based on therelative path argument.

getResourceBundle
ResourceBundle getResourceBundle(Locale locale, org.apache.jetspeed.request.RequestContext context)(Code)
the resource bundle for the given Locale and RequestContext.

getResourceBundleName
String getResourceBundleName()(Code)
the resource bundle locator prefix.

getStyleSheet
String getStyleSheet()(Code)
The appropriate stylesheet to be used with this decoration.

getStyleSheetDesktop
String getStyleSheetDesktop()(Code)
the /desktop specific stylesheet to be used with this decoration; defined only when decoration supports /desktop.

getStyleSheetPortal
String getStyleSheetPortal()(Code)
the /portal specific stylesheet to be used with this decoration; defined only when decoration supports /desktop.

setActions
void setActions(List actions)(Code)
Set the list of DecoratorActions to be displayed within the portlet window.
See Also:   org.apache.jetspeed.decoration.DecoratorAction
Parameters:
  actions - actions to displayed within this portlet window.

setCurrentModeAction
void setCurrentModeAction(String currentModeAction)(Code)
Set the name of the currently active mode action

setCurrentStateAction
void setCurrentStateAction(String currentStateAction)(Code)
Set the name of the currently active state action

supportsDesktop
boolean supportsDesktop()(Code)
Indicates whether the decorator supports /desktop

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.