|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
|
+--com.opencms.template.A_CmsTemplate
|
+--com.opencms.template.CmsXmlTemplate
|
+--com.opencms.workplace.CmsWorkplaceDefault
|
+--com.opencms.workplace.CmsEditor
Template class for displaying the text editor of the OpenCms workplace.
Reads the edirtor layout from a editor template file of the content type
CmsXmlWpTemplateFile.
CmsXmlWpTemplateFile| Field Summary |
| Fields inherited from class com.opencms.template.CmsXmlTemplate |
C_BODY_ELEMENT, C_DEBUG, C_FRAME_SELECTOR, m_cache |
| 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 | |
CmsEditor()
|
|
| Method Summary | |
protected String |
getBrowserSpecificSection(CmsObject cms,
CmsXmlTemplateFile templateFile,
Hashtable parameters)
Get the name of the section that should be loaded from the editor's template file for displaying the editor. |
byte[] |
getContent(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
Displays the editor described by the template file templateFile.
|
boolean |
isCacheable(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
Indicates if the results of this class are cacheable. |
protected CmsFile |
readFile(CmsObject cms,
String filename)
Reads in the requested file to be edited by calling the corresponding method in the cms object. |
Object |
setText(CmsObject cms,
String tagcontent,
A_CmsXmlContent doc,
Object userObj)
User method for setting the editable text in the editor window. |
| Methods inherited from class com.opencms.workplace.CmsWorkplaceDefault |
bubblesort, checkJavaProperty, checkPort, doNotShow, getCacheDirectives, getConfigFile, getConstantSelectEntries, getFonts, getKey, getLastUrl, getOwnTemplateFile, isAdmin, isAdminFalse, isNotOnlineProject, isOnlineProject, isProjectManager, isStreamable, isTheAdminUser, picsUrl, resourcesUri, scriptsUri, startProcessing, userName |
| Methods inherited from class com.opencms.template.A_CmsTemplate |
debugPrint, isExportable, isProxyPrivateCacheable, isProxyPublicCacheable |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.opencms.template.I_CmsTemplate |
isExportable, isProxyPrivateCacheable, isProxyPublicCacheable |
| Constructor Detail |
public CmsEditor()
| Method Detail |
protected String getBrowserSpecificSection(CmsObject cms,
CmsXmlTemplateFile templateFile,
Hashtable parameters)
cms - cms object for accessing the original HTTP requesttemplateFile - the editor's template file containing different sections
templateFile
public byte[] getContent(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
throws CmsException
templateFile.
This can be either the HTML editor or the text editor.
The given template file will be scanned for special section "ie" and "ns" that can be used to generate browser specific versions of the editors (MS IE or Netscape Navigator). If no such section exists, the default section will be displayed.
getContent in interface I_CmsTemplategetContent in class CmsXmlTemplatecms - CmsObject Object for accessing system resources.templateFile - Filename of the template file.elementName - Element name of this template in our parent template.parameters - Hashtable with all template class parameters.templateSelector - template section that should be processed.
CmsExceptiongetContent(CmsObject, String, String, Hashtable, String)
public boolean isCacheable(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
isCacheable in interface I_CmsTemplateisCacheable in class CmsWorkplaceDefaultcms - CmsObject Object for accessing system resourcestemplateFile - Filename of the template fileelementName - Element name of this template in our parent template.parameters - Hashtable with all template class parameters.templateSelector - template section that should be processed.
protected CmsFile readFile(CmsObject cms,
String filename)
throws CmsException
cms - Cms object for accessing system resourcesfilename - Name of the file to be loaded
CmsException
public Object setText(CmsObject cms,
String tagcontent,
A_CmsXmlContent doc,
Object userObj)
This method can be called in the editor's template file using
<METHOD name="setText"/>>. This call will be replaced
by the content of the file that should be edited.
cms - CmsObject Object for accessing system resources.tagcontent - Unused in this special case of a user method. Can be ignored.doc - Reference to the A_CmsXmlContent object of the initiating XLM document.userObj - Hashtable with parameters.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||