com.opencms.workplace
Class CmsXmlWpConfigFile

java.lang.Object
  |
  +--com.opencms.workplace.CmsXmlWpConfigFile

public class CmsXmlWpConfigFile

extends Object

Definition of some paths for the workplace. Currently some are static, but can be switched to read from configurations like registry.

Version:

$Revision: 1.49.2.1 $ $Date: 2003/06/16 11:19:08 $

Author:

Alexander Lucas, Michael Emmerich, Andreas Schouten

Constructor Summary

CmsXmlWpConfigFile()
Default constructor.

CmsXmlWpConfigFile(CmsObject cms)
Constructor for creating a new config file object.

Method Summary

String	getDownGalleryPath() Gets the path at which the folders with the download galleries are
String	getHtmlGalleryPath() Gets the path at which the folders with the html galleries are
String	getLanguagePath() Deprecated. Use the constant value I_CmsWpConstants.C_VFS_PATH_LOCALES instead
String	getLinkGalleryPath() Gets the path at which the folders with the externallink galleries are
String	getPicGalleryPath() Gets the path at which the folders with the picture galleries are
String	getWorkplaceActionPath() Gets the path for OpenCms workplace action files.
String	getWorkplaceAdministrationPath() Gets the path for OpenCms workplace administration files.
void	getWorkplaceIniData(Vector names, Vector values, String tag, String element)
String	getWpPicturePath() Gets the path for system picture files.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CmsXmlWpConfigFile

public CmsXmlWpConfigFile()
                   throws CmsException

Default constructor.

CmsXmlWpConfigFile

public CmsXmlWpConfigFile(CmsObject cms)
                   throws CmsException

Constructor for creating a new config file object. The parameter cms is not needed at the moment.

Parameters:

cms - CmsObject object for accessing system resources.

Method Detail

getDownGalleryPath

public String getDownGalleryPath()

Gets the path at which the folders with the download galleries are

Returns:

Path for download galleries.

getHtmlGalleryPath

public String getHtmlGalleryPath()

Gets the path at which the folders with the html galleries are

Returns:

Path for html galleries.

getPicGalleryPath

public String getPicGalleryPath()

Gets the path at which the folders with the picture galleries are

Returns:

Path for picture galleries.

getLinkGalleryPath

public String getLinkGalleryPath()

Gets the path at which the folders with the externallink galleries are

Returns:

Path for externallink galleries.

getLanguagePath

public String getLanguagePath()
                       throws CmsException

Deprecated. Use the constant value I_CmsWpConstants.C_VFS_PATH_LOCALES instead

Gets the path for OpenCms language files.

Returns:

Path for language files.

Throws:

CmsException - if the corresponding XML tag doesn't exist in the workplace definition file.

getWorkplaceActionPath

public String getWorkplaceActionPath()
                              throws CmsException

Gets the path for OpenCms workplace action files.

Returns:

Path for OpenCms workplace action files.

Throws:

CmsException - if the corresponding XML tag doesn't exist in the workplace definition file.

getWorkplaceAdministrationPath

public String getWorkplaceAdministrationPath()
                                      throws CmsException

Gets the path for OpenCms workplace administration files.

Returns:

Path for OpenCms workplace administration files.

Throws:

CmsException - if the corresponding XML tag doesn't exist in the workplace definition file.

getWpPicturePath

public String getWpPicturePath()
                        throws CmsException

Gets the path for system picture files.

Returns:

Path for picture files.

Throws:

CmsException - if the corresponding XML tag doesn't exist in the workplace definition file.

getWorkplaceIniData

public void getWorkplaceIniData(Vector names,
                                Vector values,
                                String tag,
                                String element)
                         throws CmsException

CmsException