Java Doc for CmsWorkplaceSettings.java in » Content-Management-System » opencms » org » opencms » workplace » 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 » Content Management System » opencms » org.opencms.workplace

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

org.opencms.workplace .CmsWorkplaceSettings

CmsWorkplaceSettings
public class CmsWorkplaceSettings (Code)
	Object to conveniently access and modify the state of the workplace for a user, will be stored in the session of a user. author: Alexander Kandzior version: $Revision: 1.60 $ since: 6.0.0

Constructor Summary
	CmsWorkplaceSettings()

Method Summary
public I_CmsResourceCollector	getCollector() Returns the collector object. Use this mechanism for transferring a resource collector between several page instances of an interactive dialog.
public Object	getDialogObject() Returns the dialog object. Use this mechanism for transferring a complex object between several page instances of an interactive dialog.
public CmsMessageContainer	getErrorMessage()
public String	getExplorerFlaturl()
public String	getExplorerMode()
public int	getExplorerPage()
public String	getExplorerProjectFilter() Gets the explorer project filter for the project view. This parameter is used in the administration to filter files belonging to a project.
public CmsUUID	getExplorerProjectId() Gets the explorer project id for the project view. This parameter is used in the administration to filter files belonging to a selected project.
public String	getExplorerResource()
public Map	getFrameUris()
public String	getGalleryType()
public String	getLastUsedGallery(int galleryTypeId)
public Object	getListObject() Returns the list dialog object. Use this mechanism for transfering a html list object between several page instances of an interactive dialog.
public String	getPermissionDetailView()
public CmsUUID	getProject()
public CmsPublishList	getPublishList()
public String	getSite()
public CmsToolUserData	getToolUserData()
public String	getTreeResource(String type)
public String	getTreeSite(String type)
public CmsUser	getUser()
public CmsUserSettings	getUserSettings()
public String	getViewStartup()
public String	getViewUri()
public boolean	isViewExplorer()
public void	setCollector(I_CmsResourceCollector collector)
public void	setDialogObject(Object dialogObject) Sets the dialog object. Use this mechanism for transferring a complex object between several page instances of an interactive dialog.
public void	setErrorMessage(CmsMessageContainer errorMessage)
public void	setExplorerFlaturl(String value)
public void	setExplorerMode(String value)
public void	setExplorerPage(int page)
public void	setExplorerProjectFilter(String value)
public void	setExplorerProjectId(CmsUUID value)
public void	setExplorerResource(String value)
public void	setGalleryType(String currentGallery)
public void	setLastUsedGallery(int galleryTypeId, String gallerypath)
public void	setListObject(Object listObject) Sets the list object. Use this mechanism for transfering a html list object between several page instances of an interactive dialog.
public void	setPermissionDetailView(String value)
public void	setProject(CmsUUID project)
public void	setPublishList(CmsPublishList publishList)
public void	setSite(String value)
public void	setToolUserData(CmsToolUserData toolUserData)
public void	setTreeResource(String type, String value)
public void	setTreeSite(String type, String value)
public void	setUser(CmsUser user)
public void	setUserSettings(CmsUserSettings userSettings)
public void	setViewStartup(String viewStartup)
public void	setViewUri(String string)

Constructor Detail

CmsWorkplaceSettings
CmsWorkplaceSettings()(Code)
	Constructor, only package visible.

Method Detail

getCollector

public I_CmsResourceCollector getCollector()(Code)

Returns the collector object.

Use this mechanism for transferring a resource collector between several page instances of an interactive dialog.

the dialog object

getDialogObject

public Object getDialogObject()(Code)

Returns the dialog object.

Use this mechanism for transferring a complex object between several page instances of an interactive dialog. This is usually required when editing a complex object in a dialog of the "Administration" view.

the dialog object

getErrorMessage
public CmsMessageContainer getErrorMessage()(Code)
	Returns the error message to display in the workplace. the error message to display in the workplace

getExplorerFlaturl
public String getExplorerFlaturl()(Code)
	Returns the explorer flat url. the explorer flat url

getExplorerMode
public String getExplorerMode()(Code)
	Returns the current explorer mode. the current explorer mode

getExplorerPage
public int getExplorerPage()(Code)
	Returns the currently selected page in the explorer view. the currently selected page in the explorer view

getExplorerProjectFilter
public String getExplorerProjectFilter()(Code)
	Gets the explorer project filter for the project view. This parameter is used in the administration to filter files belonging to a project. the explorer project filter

getExplorerProjectId
public CmsUUID getExplorerProjectId()(Code)
	Gets the explorer project id for the project view. This parameter is used in the administration to filter files belonging to a selected project. the explorer project id

getExplorerResource
public String getExplorerResource()(Code)
	Returns the current resource to be displayed in the explorer. the current resource to be displayed in the explorer

getFrameUris
public Map getFrameUris()(Code)
	Returns the frame URIs of the currently loaded frameset, with the frame names as keys. the frame URIs of the currently loaded frameset

getGalleryType
public String getGalleryType()(Code)
	Returns the current gallery type name. the current gallery type name

getLastUsedGallery
public String getLastUsedGallery(int galleryTypeId)(Code)
	Returns the last saved gallery for the given gallery type id. Parameters: galleryTypeId - the type id of the gallery the last saved gallery for the given gallery type id

getListObject

public Object getListObject()(Code)

Returns the list dialog object.

Use this mechanism for transfering a html list object between several page instances of an interactive dialog. This is usually required when having several lists in a tool or when a list action another list displays of the "Administration" view.

the dialog object
See Also: org.opencms.workplace.list.A_CmsListDialog.getListObject(ClassCmsWorkplaceSettings)

getPermissionDetailView
public String getPermissionDetailView()(Code)
	Returns the current detail grade of the view. value of the details.

getProject
public CmsUUID getProject()(Code)
	Returns the currently selected project of the workplace user. the currently selected project of the workplace user

getPublishList
public CmsPublishList getPublishList()(Code)
	Returns the publish list. the publishList

getSite
public String getSite()(Code)
	Returns the current site for the user. the current site for the user

getToolUserData
public CmsToolUserData getToolUserData()(Code)
	Returns the new admin view tool User Data. the tool User Data

getTreeResource
public String getTreeResource(String type)(Code)
	Returns the tree resource uri for the specified tree type. Parameters: type - the type of the tree the tree resource uri for the specified tree type

getTreeSite
public String getTreeSite(String type)(Code)
	Returns the tree site uri for the specified tree type. Parameters: type - the type of the tree the tree site uri for the specified tree type

getUser
public CmsUser getUser()(Code)
	Returns the current workplace user. the current workplace user

getUserSettings
public CmsUserSettings getUserSettings()(Code)
	Returns the current workplace user settings object. the current workplace user settings object

getViewStartup

public String getViewStartup()(Code)

Returns the view startup page.

The view startup page can be used to directly load a specific workplace dialog or other workplace resource in the OpenCms workplace base frameset after the user logs in.

the view startup page

getViewUri
public String getViewUri()(Code)
	Returns the current view Uri selected in the workplace. the current view Uri selected in the workplace

isViewExplorer
public boolean isViewExplorer()(Code)
	Checks if the current view is the explorer view. true if the current view is the explorer view, otherwise false

setCollector

public void setCollector(I_CmsResourceCollector collector)(Code)

Sets the collector object.

Use this mechanism for transferring a resource collector between several page instances of an interactive dialog.

Parameters:
collector - the dialog object to set

setDialogObject

public void setDialogObject(Object dialogObject)(Code)

Sets the dialog object.

Parameters:
dialogObject - the dialog object to set

setErrorMessage
public void setErrorMessage(CmsMessageContainer errorMessage)(Code)
	Sets the error message to display in the workplace. Parameters: errorMessage - the error message to display in the workplace

setExplorerFlaturl
public void setExplorerFlaturl(String value)(Code)
	Sets the explorer flat url. Parameters: value - the explorer flat url

setExplorerMode
public void setExplorerMode(String value)(Code)
	Sets the current explorer mode. Parameters: value - the current explorer mode

setExplorerPage
public void setExplorerPage(int page)(Code)
	Sets the currently selected page in the explorer view. Parameters: page - the currently selected page in the explorer view

setExplorerProjectFilter
public void setExplorerProjectFilter(String value)(Code)
	Sets the explorer project filter for the project view. Parameters: value - the explorer project filter

setExplorerProjectId
public void setExplorerProjectId(CmsUUID value)(Code)
	Sets the explorer project id for the project view. Parameters: value - the explorer project id

setExplorerResource
public void setExplorerResource(String value)(Code)
	Sets the current resource to be displayed in the explorer. Parameters: value - the current resource to be displayed in the explorer

setGalleryType
public void setGalleryType(String currentGallery)(Code)
	Sets the current gallery type name. Parameters: currentGallery - the current gallery type name to set

setLastUsedGallery
public void setLastUsedGallery(int galleryTypeId, String gallerypath)(Code)
	Saves the last gallery. Parameters: galleryTypeId - the type id of the gallery as key Parameters: gallerypath - the resourcepath of the gallery

setListObject

public void setListObject(Object listObject)(Code)

Sets the list object.

Parameters:
listObject - the list object to set
See Also: org.opencms.workplace.list.A_CmsListDialog.setListObject(Classorg.opencms.workplace.list.CmsHtmlList)

setPermissionDetailView
public void setPermissionDetailView(String value)(Code)
	Sets the current detail grade of the view. Parameters: value - the current details.

setProject
public void setProject(CmsUUID project)(Code)
	Sets the currently selected project of the workplace user. Parameters: project - the currently selected project of thw workplace user

setPublishList
public void setPublishList(CmsPublishList publishList)(Code)
	Sets the publish list. Parameters: publishList - the publishList to set

setSite
public void setSite(String value)(Code)
	Sets the current site for the user. Parameters: value - the current site for the user

setToolUserData
public void setToolUserData(CmsToolUserData toolUserData)(Code)
	Sets the new admin view tool User Data. Parameters: toolUserData - the tool User Data to set

setTreeResource
public void setTreeResource(String type, String value)(Code)
	Sets the tree resource uri for the specified tree type. Parameters: type - the type of the tree Parameters: value - the resource uri to set for the type

setTreeSite
public void setTreeSite(String type, String value)(Code)
	Sets the tree resource uri for the specified tree type. Parameters: type - the type of the tree Parameters: value - the resource uri to set for the type

setUser
public void setUser(CmsUser user)(Code)
	Sets the current workplace user. Parameters: user - the current workplace user

setUserSettings
public void setUserSettings(CmsUserSettings userSettings)(Code)
	Sets the current workplace user settings object. Parameters: userSettings - the current workplace user settings object

setViewStartup

public void setViewStartup(String viewStartup)(Code)

Sets the view startup page.

The view startup page can be used to directly load a specific workplace dialog or other workplace resource in the OpenCms workplace base frameset after the user logs in.

Parameters:
viewStartup - the view startup page to set

setViewUri
public void setViewUri(String string)(Code)
	Sets the view Uri for the workplace. Parameters: string - the view Uri for the workplace

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.