|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object | +--com.opencms.workplace.A_CmsWpElement
Abstract class for all workplace elements.
Any class called by CmsXmlTemplateFile for handling special workplace
XML tags (e.g. <BUTTON> or <LABEL>)
has to extend this class.
This class contains basic functionality for loading and caching definition
files for workplace elements, such as CmsXmlWpButtonsDefFile or
CmsXmlWpLabelDefFile
CmsXmlWpTemplateFile| Field Summary | |
protected static String |
C_WORKPLACE_ELEMENT_PATH
Path to all worplace definition files. |
protected static CmsXmlWpTemplateFile |
m_backbuttondef
Reference to backbutton definition file |
protected static CmsXmlWpBoxDefFile |
m_boxdef
Reference to the box defintion file |
protected static CmsXmlWpButtonsDefFile |
m_buttondef
Reference to to buttons definition file |
protected static CmsXmlWpTemplateFile |
m_contextdef
Reference to projectlist definition file |
protected static CmsXmlWpTemplateFile |
m_errordef
Reference to the error defintion file |
protected static CmsXmlWpTemplateFile |
m_icondef
Reference to icons definition file |
protected static CmsXmlWpInputDefFile |
m_inputdef
Reference to the input defintion file |
protected static CmsXmlWpLabelDefFile |
m_labeldef
Reference to the label defintion file |
protected static CmsXmlWpTemplateFile |
m_modulelistdef
Reference to modulelist definition file |
protected static CmsXmlWpTemplateFile |
m_paneldef
Reference to the panel bar defintion file |
protected static CmsXmlWpTemplateFile |
m_prefsscrollerdef
Reference to the box defintion file |
protected static CmsXmlWpTemplateFile |
m_projectlistdef
Reference to projectlist definition file |
protected static CmsXmlWpTemplateFile |
m_radiodef
Reference to the radio button defintion file |
protected static CmsXmlWpTemplateFile |
m_taskdocudef
Reference to taskdocu definition file |
protected static CmsXmlWpTemplateFile |
m_tasklistdef
Reference to projectlist definition file |
| Fields inherited from interface com.opencms.boot.I_CmsLogChannels |
C_FLEX_CACHE, C_FLEX_LOADER, C_LOGGING, C_MODULE_CRITICAL, C_MODULE_DEBUG, C_MODULE_INFO, C_OPENCMS_CACHE, C_OPENCMS_CRITICAL, C_OPENCMS_CRONSCHEDULER, C_OPENCMS_DEBUG, C_OPENCMS_ELEMENTCACHE, C_OPENCMS_INFO, C_OPENCMS_INIT, C_OPENCMS_POOL, C_OPENCMS_STATICEXPORT, C_OPENCMS_STREAMING, C_PREPROCESSOR_IS_LOGGING |
| Constructor Summary | |
A_CmsWpElement()
|
|
| Method Summary | |
CmsXmlWpTemplateFile |
getBackbuttonDefinitions(CmsObject cms)
Reads the backbutton definition file. |
CmsXmlWpBoxDefFile |
getBoxDefinitions(CmsObject cms)
Reads the box definition file. |
CmsXmlWpButtonsDefFile |
getButtonDefinitions(CmsObject cms)
Reads the buttons definition file. |
protected String |
getClassName()
Help method to print nice classnames in error messages |
CmsXmlWpConfigFile |
getConfigFile(CmsObject cms)
Gets a reference to the default config file. |
CmsXmlWpTemplateFile |
getContextmenueDefinitions(CmsObject cms)
Reads the contextmenue definition file. |
CmsXmlWpTemplateFile |
getErrorDefinitions(CmsObject cms)
Reads the error definition file. |
CmsXmlWpTemplateFile |
getIconDefinitions(CmsObject cms)
Reads the icons definition file. |
CmsXmlWpInputDefFile |
getInputDefinitions(CmsObject cms)
Reads the input field definition file. |
CmsXmlWpLabelDefFile |
getLabelDefinitions(CmsObject cms)
Reads the label definition file. |
CmsXmlWpTemplateFile |
getModulelistDefinitions(CmsObject cms)
Reads the modulelist definition file. |
CmsXmlWpTemplateFile |
getPanelDefinitions(CmsObject cms)
Reads the panel bar definition file. |
CmsXmlWpTemplateFile |
getPrefsScrollerDefinitions(CmsObject cms)
Reads the preferences scroller definition file. |
CmsXmlWpTemplateFile |
getProjectlistDefinitions(CmsObject cms)
Reads the projectlist definition file. |
CmsXmlWpTemplateFile |
getRadioDefinitions(CmsObject cms)
Reads the radiobutton definition file. |
CmsXmlWpTemplateFile |
getTaskDocuDefinitions(CmsObject cms)
Reads the task docu definition file. |
CmsXmlWpTemplateFile |
getTaskListDefinitions(CmsObject cms)
Reads the projectlist definition file. |
protected void |
throwException(String errorMessage)
Help method that handles any occuring exception by writing an error message to the OpenCms logfile and throwing a CmsException of the type "unknown". |
protected void |
throwException(String errorMessage,
int type)
Help method that handles any occuring exception by writing an error message to the OpenCms logfile and throwing a CmsException of the given type. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.opencms.workplace.I_CmsWpElement |
handleSpecialWorkplaceTag |
| Field Detail |
protected static CmsXmlWpButtonsDefFile m_buttondef
protected static CmsXmlWpTemplateFile m_icondef
protected static CmsXmlWpTemplateFile m_backbuttondef
protected static CmsXmlWpTemplateFile m_projectlistdef
protected static CmsXmlWpTemplateFile m_modulelistdef
protected static CmsXmlWpTemplateFile m_tasklistdef
protected static CmsXmlWpTemplateFile m_paneldef
protected static CmsXmlWpTemplateFile m_taskdocudef
protected static CmsXmlWpTemplateFile m_contextdef
protected static CmsXmlWpLabelDefFile m_labeldef
protected static CmsXmlWpInputDefFile m_inputdef
protected static CmsXmlWpTemplateFile m_errordef
protected static CmsXmlWpTemplateFile m_radiodef
protected static CmsXmlWpBoxDefFile m_boxdef
protected static CmsXmlWpTemplateFile m_prefsscrollerdef
protected static final String C_WORKPLACE_ELEMENT_PATH
| Constructor Detail |
public A_CmsWpElement()
| Method Detail |
public CmsXmlWpTemplateFile getBackbuttonDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
public CmsXmlWpBoxDefFile getBoxDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
public CmsXmlWpButtonsDefFile getButtonDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsExceptionprotected String getClassName()
public CmsXmlWpConfigFile getConfigFile(CmsObject cms)
throws CmsException
C_WORKPLACE_INI
cms - CmsObject Object for accessing system resources.
CmsException
public CmsXmlWpTemplateFile getContextmenueDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
public CmsXmlWpTemplateFile getErrorDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
public CmsXmlWpTemplateFile getIconDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
public CmsXmlWpInputDefFile getInputDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
public CmsXmlWpLabelDefFile getLabelDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
public CmsXmlWpTemplateFile getModulelistDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
public CmsXmlWpTemplateFile getPanelDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
public CmsXmlWpTemplateFile getPrefsScrollerDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
public CmsXmlWpTemplateFile getProjectlistDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
public CmsXmlWpTemplateFile getRadioDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
public CmsXmlWpTemplateFile getTaskDocuDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
public CmsXmlWpTemplateFile getTaskListDefinitions(CmsObject cms)
throws CmsException
cms - The actual cms object
CmsException
protected void throwException(String errorMessage,
int type)
throws CmsException
errorMessage - String with the error message to be printed.type - Type of the exception to be thrown.
CmsException
protected void throwException(String errorMessage)
throws CmsException
errorMessage - String with the error message to be printed.
CmsException
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||