org.opencms.configuration
Class CmsWorkplaceConfiguration

java.lang.Object
  extended by org.opencms.configuration.A_CmsXmlConfiguration
      extended by org.opencms.configuration.CmsWorkplaceConfiguration
All Implemented Interfaces:
I_CmsConfigurationParameterHandler, I_CmsXmlConfiguration

public class CmsWorkplaceConfiguration
extends A_CmsXmlConfiguration

Import/Export master configuration class.

Since:
6.0.0
Version:
$Revision: 1.59 $
Author:
Alexander Kandzior

Field Summary
static java.lang.String A_AUTOSETNAVIGATION
          The "autosetnavigation" attribute.
static java.lang.String A_AUTOSETTITLE
          The "autosettitle" attribute.
static java.lang.String A_INFO
          The "info" attribute.
static java.lang.String A_OPTIONAL
          The attribute name of the optional attribute for the user-info node.
static java.lang.String A_PAGE
          The "page" attribute.
static java.lang.String A_PARAMS
          The "params" attribute.
static java.lang.String A_PARENT
          The "parent" attribute.
static java.lang.String A_PATH
          The "path" attribute.
static java.lang.String A_PERMISSIONS
          The "permissions" attribute.
static java.lang.String A_PRINCIPAL
          The "principal" attribute.
static java.lang.String A_REFERENCE
          The "reference" attribute.
static java.lang.String A_REPLACE
          The "replace" attribute.
static java.lang.String A_RULE
          The "rule" attribute.
static java.lang.String A_RULES
          The "rules" attribute.
static java.lang.String A_SHOWNAVIGATION
          The "shownavigation" attribute.
static java.lang.String A_TARGET
          The "target" attribute.
static java.lang.String A_WIDGET
          The attribute name of the widget attribute for the user-info node.
static java.lang.String CONFIGURATION_DTD_NAME
          The name of the DTD for this configuration.
static java.lang.String DEFAULT_XML_FILE_NAME
          The name of the default XML file for this configuration.
static java.lang.String N_ACCESSCONTROL
          The name of the access control node.
static java.lang.String N_ACCESSENTRY
          The name of the access entry node.
static java.lang.String N_ALLOWBROKENRELATIONS
          The name of the "allow broken relations" node.
static java.lang.String N_AUTOLOCK
          The name of the autolock node.
static java.lang.String N_BACKGROUNDCOLOR
          The name of the background color node.
static java.lang.String N_BUTTONSTYLE
          The node name of the buttonstyle node.
static java.lang.String N_COLOR
          The name of the color node.
static java.lang.String N_CONTEXTMENU
          The name of the context menu node.
static java.lang.String N_DATECREATED
          The node name of the datecreated column node.
static java.lang.String N_DATEEXPIRED
          The node name of the date expired column node.
static java.lang.String N_DATELASTMODIFIED
          The node name of the datelastmodified column node.
static java.lang.String N_DATERELEASED
          The node name of the date released column node.
static java.lang.String N_DEFAULTACCESSCONTROL
          The name of the default access control node.
static java.lang.String N_DEFAULTLOCALE
          The name of the node for the default locale.
static java.lang.String N_DEFAULTPREFERENCES
          The node name of the default preferences node.
static java.lang.String N_DEFAULTPROPERTIES
          The name of the default properties node.
static java.lang.String N_DEFAULTPROPERTIESONSTRUCTURE
          The name of the default properties on structure node.
static java.lang.String N_DEFAULTPROPERTY
          The name of the default property node.
static java.lang.String N_DIALOGHANDLER
          Individual workplace handler node name.
static java.lang.String N_DIALOGHANDLERS
          The main workplace handler node name.
static java.lang.String N_DIALOGSDEFAULTSETTINGS
          The node name of the dialogs defaultsettings node.
static java.lang.String N_DIALOGSPREFERENCES
          The node name of the dialogs preferences node.
static java.lang.String N_DIRECTEDITPROVIDER
          The node name of the direct edit provider node.
static java.lang.String N_DIRECTEDITSTYLE
          The node name of the directedit style node.
static java.lang.String N_DIRECTPUBLISH
          The node name of the directpublish node.
static java.lang.String N_EDITOPTIONS
          The name of the edit options node.
static java.lang.String N_EDITOR
          The node name of the editor node.
static java.lang.String N_EDITORACTION
          The name of the editor action node.
static java.lang.String N_EDITORCSSHANDLER
          The name of the editor css handler node.
static java.lang.String N_EDITORCSSHANDLERS
          The name of the editor css handlers node.
static java.lang.String N_EDITORGENERALOPTIONS
          The node name of the editors general options node.
static java.lang.String N_EDITORHANDLER
          The name of the editor handler node.
static java.lang.String N_EDITORPRECONDITION
          The name of the editorprecondition node.
static java.lang.String N_EDITORPRECONDITIONS
          The name of the editorpreconditions node.
static java.lang.String N_EDITORPREFERENCES
          The node name of the editors preferences node.
static java.lang.String N_EDITORPREFERREDEDITORS
          The node name of the editors preferred editors node.
static java.lang.String N_ENABLEADVANCEDPROPERTYTABS
          The name of the "enable advanced property tabs" node.
static java.lang.String N_ENABLED
          The subname of the rfsfilesettings/enabled node.
static java.lang.String N_ENABLEUSERMGMT
          The name of the "user management enabled" node.
static java.lang.String N_ENTRIES
          The node name of the file entries node.
static java.lang.String N_ENTRY
          The name of the entry node.
static java.lang.String N_ENTRYOPTIONS
          The node name of the file entryoptions node.
static java.lang.String N_EXPANDPERMISSIONSINHERITED
          The name of the expand inherited permissions node.
static java.lang.String N_EXPANDPERMISSIONSUSER
          The name of the expand user permissions node.
static java.lang.String N_EXPLORERDISPLAYOPTIONS
          The node name of the explorer displayoptions node.
static java.lang.String N_EXPLORERGENERALOPTIONS
          The node name of the explorer generaloptions node.
static java.lang.String N_EXPLORERPREFERENCES
          The node name of the explorer preferences node.
static java.lang.String N_EXPLORERTYPE
          The name of the explorer type node.
static java.lang.String N_EXPLORERTYPES
          The name of the explorer types node.
static java.lang.String N_FILECOPY
          The node name of the file copy node.
static java.lang.String N_FILEDELETION
          The node name of the file deletion node.
static java.lang.String N_FILEENCODING
          The subname of the rfsfilesettings/fileEncoding node.
static java.lang.String N_FILEPATH
          The subname of the rfsfilesettings/filePath node.
static java.lang.String N_FOLDER
          The node name of the start folder node.
static java.lang.String N_FOLDERCOPY
          The node name of the folder copy node.
static java.lang.String N_GALLERIESPREFERENCES
          The node name of the gallery preferences node.
static java.lang.String N_HELPTEXT
          The node name of the helptext node.
static java.lang.String N_INFOBLOCK
          The node name of the info-block node.
static java.lang.String N_ISLOGFILE
          The subname of the rfsfilesettings/isLogfile node.
static java.lang.String N_KEY
          The node name of the key node.
static java.lang.String N_LABELEDFOLDERS
          The name of the "labeled folders" node.
static java.lang.String N_LISTALLPROJECTS
          The node name of the list all projects node.
static java.lang.String N_LOCALE
          The node name of the locale node.
static java.lang.String N_LOCALIZEDFOLDERS
          The name of the "localized folders" node.
static java.lang.String N_LOCKEDBY
          The node name of the lockedby column node.
static java.lang.String N_MAXUPLOADSIZE
          The name of the "max file upload size" node.
static java.lang.String N_MENUITEMRULE
          The name of the "menuitemrule" node.
static java.lang.String N_MENURULE
          The name of the "menurule" node.
static java.lang.String N_MENURULES
          The name of the "menurules" node.
static java.lang.String N_MULTICONTEXTMENU
          The name of the context menu node.
static java.lang.String N_NAVTEXT
          The node name of the navtext column node.
static java.lang.String N_NEWFOLDERCREATEINDEXPAGE
          The name of the "create new folder with index page" node.
static java.lang.String N_NEWFOLDEREDITPROPERTIES
          The name of the "create new folder with edit properties" node.
static java.lang.String N_NEWRESOURCE
          The name of the new resource node.
static java.lang.String N_PERMISSIONS
          The node name of the permissions column node.
static java.lang.String N_PERMISSIONSINHERITONFOLDER
          The name of the inherit permissions on folder node.
static java.lang.String N_PROJECT
          The node name of the project node.
static java.lang.String N_PUBLISHBUTTONAPPEARANCE
          The node name of the publish button appearance node.
static java.lang.String N_PUBLISHNOTIFICATION
          The node name of the publish notification node.
static java.lang.String N_PUBLISHRELATEDRESOURCES
          The name of the "publish related resources" node.
static java.lang.String N_REPORTTYPE
          The node name of the report type node.
static java.lang.String N_RESTRICTEXPLORERVIEW
          The node name of the restrict explorer view node.
static java.lang.String N_RFSFILEVIEWESETTINGS
          The node name of the rfsfileviewsettings node.
static java.lang.String N_ROOT
          The node name of the root node.
static java.lang.String N_ROOTPATH
          The subname of the rfsfilesettings/rootPath node.
static java.lang.String N_ROOTS
          The node name of the roots node.
static java.lang.String N_SEARCHINDEXNAME
          The node name of the searchindex-name node.
static java.lang.String N_SEARCHVIEWSTYLE
          The node name of the searchview-style node.
static java.lang.String N_SEPARATOR
          The name of the separator node.
static java.lang.String N_SHOWEXPORTSETTINGS
          The node name of the show lock node.
static java.lang.String N_SHOWFILEUPLOADBUTTON
          The node name of the "show file upload button" option.
static java.lang.String N_SHOWLOCK
          The node name of the show lock node.
static java.lang.String N_SHOWMESSAGES
          The node name of the show messages node.
static java.lang.String N_SHOWUPLOADTYPEDIALOG
          The name of the "create new folder with index page" node.
static java.lang.String N_SIZE
          The node name of the size column node.
static java.lang.String N_STARTGALLERIES
          The node name of the galleries start setting node.
static java.lang.String N_STARTGALLERY
          The node name of the start gallery node.
static java.lang.String N_STATE
          The node name of the state column node.
static java.lang.String N_TEXT
          The name of the text node.
static java.lang.String N_TITLE
          The node name of the title column node.
static java.lang.String N_TOOLMANAGER
          The node name of the tool-manager node.
static java.lang.String N_TYPE
          The node name of the type column node.
static java.lang.String N_UPLOADAPPLET
          The node name of the uploadapplet node.
static java.lang.String N_URI
          The node name of the uri node.
static java.lang.String N_USERCREATED
          The node name of the user created node.
static java.lang.String N_USERINFO
          The node name of the user-info node.
static java.lang.String N_USERINFOS
          The node name of the user-infos node.
static java.lang.String N_USERLASTMODIFIED
          The node name of the user lastmodified node.
static java.lang.String N_WINDOWSIZE
          The subname of the rfsfilesettings/windowSize node.
static java.lang.String N_WORKPLACE
          The node name of the master workplace node.
static java.lang.String N_WORKPLACECUSTOMFOOT
          The name of the workplace custom foot node.
static java.lang.String N_WORKPLACEGENERALOPTIONS
          The node name of the workplace general options node.
static java.lang.String N_WORKPLACEPREFERENCES
          The node name of the workplace preferences node.
static java.lang.String N_WORKPLACESEARCH
          The node name of the workplace-search node.
static java.lang.String N_WORKPLACESTARTUPSETTINGS
          The node name of the workplace startup settings node.
static java.lang.String N_WORKPLACEVIEW
          The node name of the view node.
static java.lang.String N_XMLCONTENTAUTOCORRECTION
          The name of the xmlcontentautocorrection node.
 
Fields inherited from interface org.opencms.configuration.I_CmsXmlConfiguration
A_ALIAS, A_CLASS, A_COUNT, A_DEFAULT, A_DESTINATION, A_ENABLED, A_FROM, A_HANDLER, A_ICON, A_ID, A_KEY, A_NAME, A_ORDER, A_PASSWORD, A_PORT, A_PROTOCOL, A_SUFFIX, A_TO, A_TYPE, A_URI, A_USER, A_VALUE, N_EXPORTPOINT, N_EXPORTPOINTS, N_NAME, N_PARAM, N_PROPERTY, N_RESOURCE, N_SITE, N_VALUE
 
Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD
 
Constructor Summary
CmsWorkplaceConfiguration()
           
 
Method Summary
protected static void addContextMenuItemRules(org.apache.commons.digester.Digester digester, java.lang.String xPathPrefix)
          Adds the context menu item rules to the given digester.
protected  void addContextMenuRules(org.apache.commons.digester.Digester digester)
          Adds the digester rules for the menurules node.
protected  void addDefaultAccessControlRules(org.apache.commons.digester.Digester digester)
          Adds the digester rules for the defaultaccesscontrol node.
protected  void addDefaultPreferencesRules(org.apache.commons.digester.Digester digester)
          Adds the digester rules for the default-preferences node.
static void addExplorerTypeXmlRules(org.apache.commons.digester.Digester digester)
          Adds the explorer type rules to the given digester.
protected  void addMultiContextMenuRules(org.apache.commons.digester.Digester digester)
          Adds the digester rules for the multicontextmenu node.
protected  void addToolManagerRules(org.apache.commons.digester.Digester digester)
          Adds the digester rules for the tool-manager node.
protected  void addUserInfoRules(org.apache.commons.digester.Digester digester)
          Adds the digester rules for the user-infos node.
 void addXmlDigesterRules(org.apache.commons.digester.Digester digester)
          Digests an XML node and creates an instance of this configurable class.
protected static void generateContextMenuItemXml(org.dom4j.Element parentElement, CmsMenuRuleTranslator menuRuleTranslator, CmsExplorerContextMenuItem item)
          Creates the xml output for context menu item nodes and eventual subnodes.
static void generateExplorerTypesXml(org.dom4j.Element startNode, java.util.List explorerTypes, boolean module)
          Creates the xml output for explorer type nodes.
 org.dom4j.Element generateXml(org.dom4j.Element parent)
          Generates the XML element for this configurable class.
 java.lang.String getDtdFilename()
          Returns the name of the DTD file for this XML configuration, e.g.
 CmsWorkplaceManager getWorkplaceManager()
          Returns the initialized workplace manager.
 void initializeFinished()
          Will be called when configuration of this object is finished.
protected  void initMembers()
          Initializes member variables.
 void setWorkplaceManager(CmsWorkplaceManager manager)
          Sets the generated workplace manager.
 
Methods inherited from class org.opencms.configuration.A_CmsXmlConfiguration
addConfigurationParameter, getConfiguration, getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName, initConfiguration, setXmlFileName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

A_AUTOSETNAVIGATION

public static final java.lang.String A_AUTOSETNAVIGATION
The "autosetnavigation" attribute.

See Also:
Constant Field Values

A_AUTOSETTITLE

public static final java.lang.String A_AUTOSETTITLE
The "autosettitle" attribute.

See Also:
Constant Field Values

A_INFO

public static final java.lang.String A_INFO
The "info" attribute.

See Also:
Constant Field Values

A_OPTIONAL

public static final java.lang.String A_OPTIONAL
The attribute name of the optional attribute for the user-info node.

See Also:
Constant Field Values

A_PAGE

public static final java.lang.String A_PAGE
The "page" attribute.

See Also:
Constant Field Values

A_PARAMS

public static final java.lang.String A_PARAMS
The "params" attribute.

See Also:
Constant Field Values

A_PARENT

public static final java.lang.String A_PARENT
The "parent" attribute.

See Also:
Constant Field Values

A_PATH

public static final java.lang.String A_PATH
The "path" attribute.

See Also:
Constant Field Values

A_PERMISSIONS

public static final java.lang.String A_PERMISSIONS
The "permissions" attribute.

See Also:
Constant Field Values

A_PRINCIPAL

public static final java.lang.String A_PRINCIPAL
The "principal" attribute.

See Also:
Constant Field Values

A_REFERENCE

public static final java.lang.String A_REFERENCE
The "reference" attribute.

See Also:
Constant Field Values

A_REPLACE

public static final java.lang.String A_REPLACE
The "replace" attribute.

See Also:
Constant Field Values

A_RULE

public static final java.lang.String A_RULE
The "rule" attribute.

See Also:
Constant Field Values

A_RULES

public static final java.lang.String A_RULES
The "rules" attribute.

See Also:
Constant Field Values

A_SHOWNAVIGATION

public static final java.lang.String A_SHOWNAVIGATION
The "shownavigation" attribute.

See Also:
Constant Field Values

A_TARGET

public static final java.lang.String A_TARGET
The "target" attribute.

See Also:
Constant Field Values

A_WIDGET

public static final java.lang.String A_WIDGET
The attribute name of the widget attribute for the user-info node.

See Also:
Constant Field Values

CONFIGURATION_DTD_NAME

public static final java.lang.String CONFIGURATION_DTD_NAME
The name of the DTD for this configuration.

See Also:
Constant Field Values

DEFAULT_XML_FILE_NAME

public static final java.lang.String DEFAULT_XML_FILE_NAME
The name of the default XML file for this configuration.

See Also:
Constant Field Values

N_ACCESSCONTROL

public static final java.lang.String N_ACCESSCONTROL
The name of the access control node.

See Also:
Constant Field Values

N_ACCESSENTRY

public static final java.lang.String N_ACCESSENTRY
The name of the access entry node.

See Also:
Constant Field Values

N_ALLOWBROKENRELATIONS

public static final java.lang.String N_ALLOWBROKENRELATIONS
The name of the "allow broken relations" node.

See Also:
Constant Field Values

N_AUTOLOCK

public static final java.lang.String N_AUTOLOCK
The name of the autolock node.

See Also:
Constant Field Values

N_BACKGROUNDCOLOR

public static final java.lang.String N_BACKGROUNDCOLOR
The name of the background color node.

See Also:
Constant Field Values

N_BUTTONSTYLE

public static final java.lang.String N_BUTTONSTYLE
The node name of the buttonstyle node.

See Also:
Constant Field Values

N_COLOR

public static final java.lang.String N_COLOR
The name of the color node.

See Also:
Constant Field Values

N_CONTEXTMENU

public static final java.lang.String N_CONTEXTMENU
The name of the context menu node.

See Also:
Constant Field Values

N_DATECREATED

public static final java.lang.String N_DATECREATED
The node name of the datecreated column node.

See Also:
Constant Field Values

N_DATEEXPIRED

public static final java.lang.String N_DATEEXPIRED
The node name of the date expired column node.

See Also:
Constant Field Values

N_DATELASTMODIFIED

public static final java.lang.String N_DATELASTMODIFIED
The node name of the datelastmodified column node.

See Also:
Constant Field Values

N_DATERELEASED

public static final java.lang.String N_DATERELEASED
The node name of the date released column node.

See Also:
Constant Field Values

N_DEFAULTACCESSCONTROL

public static final java.lang.String N_DEFAULTACCESSCONTROL
The name of the default access control node.

See Also:
Constant Field Values

N_DEFAULTLOCALE

public static final java.lang.String N_DEFAULTLOCALE
The name of the node for the default locale.

See Also:
Constant Field Values

N_DEFAULTPREFERENCES

public static final java.lang.String N_DEFAULTPREFERENCES
The node name of the default preferences node.

See Also:
Constant Field Values

N_DEFAULTPROPERTIES

public static final java.lang.String N_DEFAULTPROPERTIES
The name of the default properties node.

See Also:
Constant Field Values

N_DEFAULTPROPERTIESONSTRUCTURE

public static final java.lang.String N_DEFAULTPROPERTIESONSTRUCTURE
The name of the default properties on structure node.

See Also:
Constant Field Values

N_DEFAULTPROPERTY

public static final java.lang.String N_DEFAULTPROPERTY
The name of the default property node.

See Also:
Constant Field Values

N_DIALOGHANDLER

public static final java.lang.String N_DIALOGHANDLER
Individual workplace handler node name.

See Also:
Constant Field Values

N_DIALOGHANDLERS

public static final java.lang.String N_DIALOGHANDLERS
The main workplace handler node name.

See Also:
Constant Field Values

N_DIALOGSDEFAULTSETTINGS

public static final java.lang.String N_DIALOGSDEFAULTSETTINGS
The node name of the dialogs defaultsettings node.

See Also:
Constant Field Values

N_DIALOGSPREFERENCES

public static final java.lang.String N_DIALOGSPREFERENCES
The node name of the dialogs preferences node.

See Also:
Constant Field Values

N_DIRECTEDITPROVIDER

public static final java.lang.String N_DIRECTEDITPROVIDER
The node name of the direct edit provider node.

See Also:
Constant Field Values

N_DIRECTEDITSTYLE

public static final java.lang.String N_DIRECTEDITSTYLE
The node name of the directedit style node.

See Also:
Constant Field Values

N_DIRECTPUBLISH

public static final java.lang.String N_DIRECTPUBLISH
The node name of the directpublish node.

See Also:
Constant Field Values

N_EDITOPTIONS

public static final java.lang.String N_EDITOPTIONS
The name of the edit options node.

See Also:
Constant Field Values

N_EDITOR

public static final java.lang.String N_EDITOR
The node name of the editor node.

See Also:
Constant Field Values

N_EDITORACTION

public static final java.lang.String N_EDITORACTION
The name of the editor action node.

See Also:
Constant Field Values

N_EDITORCSSHANDLER

public static final java.lang.String N_EDITORCSSHANDLER
The name of the editor css handler node.

See Also:
Constant Field Values

N_EDITORCSSHANDLERS

public static final java.lang.String N_EDITORCSSHANDLERS
The name of the editor css handlers node.

See Also:
Constant Field Values

N_EDITORGENERALOPTIONS

public static final java.lang.String N_EDITORGENERALOPTIONS
The node name of the editors general options node.

See Also:
Constant Field Values

N_EDITORHANDLER

public static final java.lang.String N_EDITORHANDLER
The name of the editor handler node.

See Also:
Constant Field Values

N_EDITORPRECONDITION

public static final java.lang.String N_EDITORPRECONDITION
The name of the editorprecondition node.

See Also:
Constant Field Values

N_EDITORPRECONDITIONS

public static final java.lang.String N_EDITORPRECONDITIONS
The name of the editorpreconditions node.

See Also:
Constant Field Values

N_EDITORPREFERENCES

public static final java.lang.String N_EDITORPREFERENCES
The node name of the editors preferences node.

See Also:
Constant Field Values

N_EDITORPREFERREDEDITORS

public static final java.lang.String N_EDITORPREFERREDEDITORS
The node name of the editors preferred editors node.

See Also:
Constant Field Values

N_GALLERIESPREFERENCES

public static final java.lang.String N_GALLERIESPREFERENCES
The node name of the gallery preferences node.

See Also:
Constant Field Values

N_STARTGALLERIES

public static final java.lang.String N_STARTGALLERIES
The node name of the galleries start setting node.

See Also:
Constant Field Values

N_STARTGALLERY

public static final java.lang.String N_STARTGALLERY
The node name of the start gallery node.

See Also:
Constant Field Values

N_ENABLEADVANCEDPROPERTYTABS

public static final java.lang.String N_ENABLEADVANCEDPROPERTYTABS
The name of the "enable advanced property tabs" node.

See Also:
Constant Field Values

N_ENABLED

public static final java.lang.String N_ENABLED
The subname of the rfsfilesettings/enabled node.

See Also:
Constant Field Values

N_ENABLEUSERMGMT

public static final java.lang.String N_ENABLEUSERMGMT
The name of the "user management enabled" node.

See Also:
Constant Field Values

N_ENTRIES

public static final java.lang.String N_ENTRIES
The node name of the file entries node.

See Also:
Constant Field Values

N_ENTRY

public static final java.lang.String N_ENTRY
The name of the entry node.

See Also:
Constant Field Values

N_ENTRYOPTIONS

public static final java.lang.String N_ENTRYOPTIONS
The node name of the file entryoptions node.

See Also:
Constant Field Values

N_EXPANDPERMISSIONSINHERITED

public static final java.lang.String N_EXPANDPERMISSIONSINHERITED
The name of the expand inherited permissions node.

See Also:
Constant Field Values

N_EXPANDPERMISSIONSUSER

public static final java.lang.String N_EXPANDPERMISSIONSUSER
The name of the expand user permissions node.

See Also:
Constant Field Values

N_EXPLORERDISPLAYOPTIONS

public static final java.lang.String N_EXPLORERDISPLAYOPTIONS
The node name of the explorer displayoptions node.

See Also:
Constant Field Values

N_EXPLORERGENERALOPTIONS

public static final java.lang.String N_EXPLORERGENERALOPTIONS
The node name of the explorer generaloptions node.

See Also:
Constant Field Values

N_EXPLORERPREFERENCES

public static final java.lang.String N_EXPLORERPREFERENCES
The node name of the explorer preferences node.

See Also:
Constant Field Values

N_EXPLORERTYPE

public static final java.lang.String N_EXPLORERTYPE
The name of the explorer type node.

See Also:
Constant Field Values

N_EXPLORERTYPES

public static final java.lang.String N_EXPLORERTYPES
The name of the explorer types node.

See Also:
Constant Field Values

N_FILECOPY

public static final java.lang.String N_FILECOPY
The node name of the file copy node.

See Also:
Constant Field Values

N_FILEDELETION

public static final java.lang.String N_FILEDELETION
The node name of the file deletion node.

See Also:
Constant Field Values

N_FILEENCODING

public static final java.lang.String N_FILEENCODING
The subname of the rfsfilesettings/fileEncoding node.

See Also:
Constant Field Values

N_FILEPATH

public static final java.lang.String N_FILEPATH
The subname of the rfsfilesettings/filePath node.

See Also:
Constant Field Values

N_FOLDER

public static final java.lang.String N_FOLDER
The node name of the start folder node.

See Also:
Constant Field Values

N_FOLDERCOPY

public static final java.lang.String N_FOLDERCOPY
The node name of the folder copy node.

See Also:
Constant Field Values

N_HELPTEXT

public static final java.lang.String N_HELPTEXT
The node name of the helptext node.

See Also:
Constant Field Values

N_INFOBLOCK

public static final java.lang.String N_INFOBLOCK
The node name of the info-block node.

See Also:
Constant Field Values

N_ISLOGFILE

public static final java.lang.String N_ISLOGFILE
The subname of the rfsfilesettings/isLogfile node.

See Also:
Constant Field Values

N_KEY

public static final java.lang.String N_KEY
The node name of the key node.

See Also:
Constant Field Values

N_LABELEDFOLDERS

public static final java.lang.String N_LABELEDFOLDERS
The name of the "labeled folders" node.

See Also:
Constant Field Values

N_LOCALE

public static final java.lang.String N_LOCALE
The node name of the locale node.

See Also:
Constant Field Values

N_LOCALIZEDFOLDERS

public static final java.lang.String N_LOCALIZEDFOLDERS
The name of the "localized folders" node.

See Also:
Constant Field Values

N_LOCKEDBY

public static final java.lang.String N_LOCKEDBY
The node name of the lockedby column node.

See Also:
Constant Field Values

N_MAXUPLOADSIZE

public static final java.lang.String N_MAXUPLOADSIZE
The name of the "max file upload size" node.

See Also:
Constant Field Values

N_MENUITEMRULE

public static final java.lang.String N_MENUITEMRULE
The name of the "menuitemrule" node.

See Also:
Constant Field Values

N_MENURULE

public static final java.lang.String N_MENURULE
The name of the "menurule" node.

See Also:
Constant Field Values

N_MENURULES

public static final java.lang.String N_MENURULES
The name of the "menurules" node.

See Also:
Constant Field Values

N_MULTICONTEXTMENU

public static final java.lang.String N_MULTICONTEXTMENU
The name of the context menu node.

See Also:
Constant Field Values

N_NAVTEXT

public static final java.lang.String N_NAVTEXT
The node name of the navtext column node.

See Also:
Constant Field Values

N_NEWFOLDERCREATEINDEXPAGE

public static final java.lang.String N_NEWFOLDERCREATEINDEXPAGE
The name of the "create new folder with index page" node.

See Also:
Constant Field Values

N_NEWFOLDEREDITPROPERTIES

public static final java.lang.String N_NEWFOLDEREDITPROPERTIES
The name of the "create new folder with edit properties" node.

See Also:
Constant Field Values

N_NEWRESOURCE

public static final java.lang.String N_NEWRESOURCE
The name of the new resource node.

See Also:
Constant Field Values

N_PERMISSIONS

public static final java.lang.String N_PERMISSIONS
The node name of the permissions column node.

See Also:
Constant Field Values

N_PERMISSIONSINHERITONFOLDER

public static final java.lang.String N_PERMISSIONSINHERITONFOLDER
The name of the inherit permissions on folder node.

See Also:
Constant Field Values

N_PROJECT

public static final java.lang.String N_PROJECT
The node name of the project node.

See Also:
Constant Field Values

N_PUBLISHBUTTONAPPEARANCE

public static final java.lang.String N_PUBLISHBUTTONAPPEARANCE
The node name of the publish button appearance node.

See Also:
Constant Field Values

N_LISTALLPROJECTS

public static final java.lang.String N_LISTALLPROJECTS
The node name of the list all projects node.

See Also:
Constant Field Values

N_PUBLISHNOTIFICATION

public static final java.lang.String N_PUBLISHNOTIFICATION
The node name of the publish notification node.

See Also:
Constant Field Values

N_PUBLISHRELATEDRESOURCES

public static final java.lang.String N_PUBLISHRELATEDRESOURCES
The name of the "publish related resources" node.

See Also:
Constant Field Values

N_REPORTTYPE

public static final java.lang.String N_REPORTTYPE
The node name of the report type node.

See Also:
Constant Field Values

N_RESTRICTEXPLORERVIEW

public static final java.lang.String N_RESTRICTEXPLORERVIEW
The node name of the restrict explorer view node.

See Also:
Constant Field Values

N_RFSFILEVIEWESETTINGS

public static final java.lang.String N_RFSFILEVIEWESETTINGS
The node name of the rfsfileviewsettings node.

See Also:
Constant Field Values

N_ROOT

public static final java.lang.String N_ROOT
The node name of the root node.

See Also:
Constant Field Values

N_ROOTPATH

public static final java.lang.String N_ROOTPATH
The subname of the rfsfilesettings/rootPath node.

See Also:
Constant Field Values

N_ROOTS

public static final java.lang.String N_ROOTS
The node name of the roots node.

See Also:
Constant Field Values

N_SEARCHINDEXNAME

public static final java.lang.String N_SEARCHINDEXNAME
The node name of the searchindex-name node.

See Also:
Constant Field Values

N_SEARCHVIEWSTYLE

public static final java.lang.String N_SEARCHVIEWSTYLE
The node name of the searchview-style node.

See Also:
Constant Field Values

N_SEPARATOR

public static final java.lang.String N_SEPARATOR
The name of the separator node.

See Also:
Constant Field Values

N_SHOWEXPORTSETTINGS

public static final java.lang.String N_SHOWEXPORTSETTINGS
The node name of the show lock node.

See Also:
Constant Field Values

N_SHOWFILEUPLOADBUTTON

public static final java.lang.String N_SHOWFILEUPLOADBUTTON
The node name of the "show file upload button" option.

See Also:
Constant Field Values

N_SHOWLOCK

public static final java.lang.String N_SHOWLOCK
The node name of the show lock node.

See Also:
Constant Field Values

N_SHOWMESSAGES

public static final java.lang.String N_SHOWMESSAGES
The node name of the show messages node.

See Also:
Constant Field Values

N_SHOWUPLOADTYPEDIALOG

public static final java.lang.String N_SHOWUPLOADTYPEDIALOG
The name of the "create new folder with index page" node.

See Also:
Constant Field Values

N_SIZE

public static final java.lang.String N_SIZE
The node name of the size column node.

See Also:
Constant Field Values

N_STATE

public static final java.lang.String N_STATE
The node name of the state column node.

See Also:
Constant Field Values

N_TEXT

public static final java.lang.String N_TEXT
The name of the text node.

See Also:
Constant Field Values

N_TITLE

public static final java.lang.String N_TITLE
The node name of the title column node.

See Also:
Constant Field Values

N_TOOLMANAGER

public static final java.lang.String N_TOOLMANAGER
The node name of the tool-manager node.

See Also:
Constant Field Values

N_TYPE

public static final java.lang.String N_TYPE
The node name of the type column node.

See Also:
Constant Field Values

N_UPLOADAPPLET

public static final java.lang.String N_UPLOADAPPLET
The node name of the uploadapplet node.

See Also:
Constant Field Values

N_URI

public static final java.lang.String N_URI
The node name of the uri node.

See Also:
Constant Field Values

N_USERCREATED

public static final java.lang.String N_USERCREATED
The node name of the user created node.

See Also:
Constant Field Values

N_USERINFO

public static final java.lang.String N_USERINFO
The node name of the user-info node.

See Also:
Constant Field Values

N_USERINFOS

public static final java.lang.String N_USERINFOS
The node name of the user-infos node.

See Also:
Constant Field Values

N_USERLASTMODIFIED

public static final java.lang.String N_USERLASTMODIFIED
The node name of the user lastmodified node.

See Also:
Constant Field Values

N_WINDOWSIZE

public static final java.lang.String N_WINDOWSIZE
The subname of the rfsfilesettings/windowSize node.

See Also:
Constant Field Values

N_WORKPLACE

public static final java.lang.String N_WORKPLACE
The node name of the master workplace node.

See Also:
Constant Field Values

N_WORKPLACECUSTOMFOOT

public static final java.lang.String N_WORKPLACECUSTOMFOOT
The name of the workplace custom foot node.

See Also:
Constant Field Values

N_WORKPLACEGENERALOPTIONS

public static final java.lang.String N_WORKPLACEGENERALOPTIONS
The node name of the workplace general options node.

See Also:
Constant Field Values

N_WORKPLACEPREFERENCES

public static final java.lang.String N_WORKPLACEPREFERENCES
The node name of the workplace preferences node.

See Also:
Constant Field Values

N_WORKPLACESEARCH

public static final java.lang.String N_WORKPLACESEARCH
The node name of the workplace-search node.

See Also:
Constant Field Values

N_WORKPLACESTARTUPSETTINGS

public static final java.lang.String N_WORKPLACESTARTUPSETTINGS
The node name of the workplace startup settings node.

See Also:
Constant Field Values

N_WORKPLACEVIEW

public static final java.lang.String N_WORKPLACEVIEW
The node name of the view node.

See Also:
Constant Field Values

N_XMLCONTENTAUTOCORRECTION

public static final java.lang.String N_XMLCONTENTAUTOCORRECTION
The name of the xmlcontentautocorrection node.

See Also:
Constant Field Values
Constructor Detail

CmsWorkplaceConfiguration

public CmsWorkplaceConfiguration()
Method Detail

addExplorerTypeXmlRules

public static void addExplorerTypeXmlRules(org.apache.commons.digester.Digester digester)
Adds the explorer type rules to the given digester.

Parameters:
digester - the digester to add the rules to

generateExplorerTypesXml

public static void generateExplorerTypesXml(org.dom4j.Element startNode,
                                            java.util.List explorerTypes,
                                            boolean module)
Creates the xml output for explorer type nodes.

Parameters:
startNode - the startnode to add all rescource types to
explorerTypes - the list of explorer types
module - true if the XML tree for the module config should be generated, false otherwise

addContextMenuItemRules

protected static void addContextMenuItemRules(org.apache.commons.digester.Digester digester,
                                              java.lang.String xPathPrefix)
Adds the context menu item rules to the given digester.

Parameters:
digester - the digester to add the rules to
xPathPrefix - the path prefix (should be the path to the contextmenu or the multicontextmenu node)

generateContextMenuItemXml

protected static void generateContextMenuItemXml(org.dom4j.Element parentElement,
                                                 CmsMenuRuleTranslator menuRuleTranslator,
                                                 CmsExplorerContextMenuItem item)
Creates the xml output for context menu item nodes and eventual subnodes.

Parameters:
parentElement - the parent element to add the item node to
menuRuleTranslator - the menu rule translator to use for legacy rules
item - the context menu item to create the node for

addXmlDigesterRules

public void addXmlDigesterRules(org.apache.commons.digester.Digester digester)
Description copied from interface: I_CmsXmlConfiguration
Digests an XML node and creates an instance of this configurable class.

Parameters:
digester - the digester to use
See Also:
I_CmsXmlConfiguration.addXmlDigesterRules(org.apache.commons.digester.Digester)

generateXml

public org.dom4j.Element generateXml(org.dom4j.Element parent)
Description copied from interface: I_CmsXmlConfiguration
Generates the XML element for this configurable class.

Parameters:
parent - the parent element in the XML tree
Returns:
the XML element for this configurable class
See Also:
I_CmsXmlConfiguration.generateXml(org.dom4j.Element)

getDtdFilename

public java.lang.String getDtdFilename()
Description copied from interface: I_CmsXmlConfiguration
Returns the name of the DTD file for this XML configuration, e.g. opencms-configuration.dtd.

Returns:
the name of the DTD file for this XML configuration
See Also:
I_CmsXmlConfiguration.getDtdFilename()

getWorkplaceManager

public CmsWorkplaceManager getWorkplaceManager()
Returns the initialized workplace manager.

Returns:
the initialized workplace manager

initializeFinished

public void initializeFinished()
Will be called when configuration of this object is finished.


setWorkplaceManager

public void setWorkplaceManager(CmsWorkplaceManager manager)
Sets the generated workplace manager.

Parameters:
manager - the workplace manager to set

addContextMenuRules

protected void addContextMenuRules(org.apache.commons.digester.Digester digester)
Adds the digester rules for the menurules node.

Parameters:
digester - the digester object

addDefaultAccessControlRules

protected void addDefaultAccessControlRules(org.apache.commons.digester.Digester digester)
Adds the digester rules for the defaultaccesscontrol node.

Parameters:
digester - the digester object

addDefaultPreferencesRules

protected void addDefaultPreferencesRules(org.apache.commons.digester.Digester digester)
Adds the digester rules for the default-preferences node.

Parameters:
digester - the digester object

addMultiContextMenuRules

protected void addMultiContextMenuRules(org.apache.commons.digester.Digester digester)
Adds the digester rules for the multicontextmenu node.

Parameters:
digester - the digester object

addToolManagerRules

protected void addToolManagerRules(org.apache.commons.digester.Digester digester)
Adds the digester rules for the tool-manager node.

Parameters:
digester - the digester object

addUserInfoRules

protected void addUserInfoRules(org.apache.commons.digester.Digester digester)
Adds the digester rules for the user-infos node.

Parameters:
digester - the digester object

initMembers

protected void initMembers()
Description copied from class: A_CmsXmlConfiguration
Initializes member variables.

Specified by:
initMembers in class A_CmsXmlConfiguration
See Also:
A_CmsXmlConfiguration.initMembers()