com.opencms.workplace
Interface I_CmsWpElement

All Known Implementing Classes:

A_CmsWpElement, CmsBackbutton, CmsButton, CmsButtonJavascript, CmsButtonSeparator, CmsButtonSubmit, CmsButtonText, CmsContextmenue, CmsErrorpage, CmsFileList, CmsIcon, CmsInput, CmsInputPassword, CmsLabel, CmsMessagebox, CmsModulelist, CmsPanel, CmsPrefsScroller, CmsProjecthistory, CmsProjectlist, CmsRadioButtons, CmsSelectBox, CmsTaskDocu, CmsTaskList

public interface I_CmsWpElement

Interface for all workplace elements.

Any class called by CmsXmlTemplateFile for handling special workplace XML tags (e.g. <BUTTON> or <LABEL>) has to implement this interface.

Version:

$Revision: 1.14 $ $Date: 2003/01/20 23:59:18 $

Author:

Alexander Lucas

See Also:

CmsXmlWpTemplateFile

Method Summary

Object

handleSpecialWorkplaceTag(CmsObject cms, Element n, A_CmsXmlContent doc, Object callingObject, Hashtable parameters, CmsXmlLanguageFile lang) Method for handling the corresponding special workplace XML tag and generating the appropriate output.

Method Detail

handleSpecialWorkplaceTag

public Object handleSpecialWorkplaceTag(CmsObject cms,
                                        Element n,
                                        A_CmsXmlContent doc,
                                        Object callingObject,
                                        Hashtable parameters,
                                        CmsXmlLanguageFile lang)
                                 throws CmsException

Method for handling the corresponding special workplace XML tag and generating the appropriate output.

Parameters:

cms - CmsObject Object for accessing resources.

n - XML element containing the current tag.

doc - Reference to the A_CmsXmlContent object of the initiating XLM document.

callingObject - reference to the calling object.

parameters - Hashtable containing all user parameters.

lang - CmsXmlLanguageFile conataining the currently valid language file.

Returns:

Processed special workplace XML tag.

Throws:

CmsException