|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object | +--com.opencms.workplace.CmsNewExplorerFileList
Template class for dumping files to the output without further interpreting or processing. This can be used for plain text files or files containing graphics.
| Field Summary | |
static int |
DEBUG
Internal debugging flag |
| 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 | |
CmsNewExplorerFileList()
|
|
| Method Summary | |
CmsCacheDirectives |
collectCacheDirectives(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
Collect caching informations from the current template class. |
A_CmsElement |
createElement(CmsObject cms,
String templateFile,
Hashtable parameters)
Create a new element for the element cache consisting of the current template class and the given template file. |
CmsCacheDirectives |
getCacheDirectives(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
gets the caching information from the current template class. |
byte[] |
getContent(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters)
Gets the content of a given template file. |
byte[] |
getContent(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
Gets the content of a given template file. |
Object |
getKey(CmsObject cms,
String templateFile,
Hashtable parameter,
String templateSelector)
Gets the key that should be used to cache the results of this template class. |
boolean |
isCacheable(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
Template cache is not used here since we don't include any subtemplates. |
boolean |
isExportable(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
Indicates if the results of this class are "static" and may be exported. |
boolean |
isProxyPrivateCacheable(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
Indicates if the results of this class may be cached by public proxy caches. |
boolean |
isProxyPublicCacheable(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
Indicates if the results of this class may be cached by public proxy caches. |
boolean |
isStreamable(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
Indicates if the current template class is able to stream it's results directly to the response oputput stream. |
boolean |
isTemplateCacheSet()
Any results of this class are cacheable since we don't include any subtemplates. |
void |
setTemplateCache(I_CmsTemplateCache c)
Template cache is not used here since we don't include any subtemplates (not implemented). |
boolean |
shouldReload(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
Template cache is not used here since we don't include any subtemplates. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final int DEBUG
| Constructor Detail |
public CmsNewExplorerFileList()
| Method Detail |
public CmsCacheDirectives getCacheDirectives(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
cms - 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.
public byte[] getContent(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters)
throws CmsException
getContent in interface I_CmsTemplatecms - CmsObject Object for accessing system resourcestemplateFile - Filename of the template fileelementName - not used here.parameters - not used here.
CmsException
public byte[] getContent(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
throws CmsException
getContent in interface I_CmsTemplatecms - CmsObject Object for accessing system resourcestemplateFile - Filename of the template fileelementName - not used here.parameters - not used here.templateSelector - not used here.
CmsExceptionI_CmsTemplate.getContent(CmsObject, String, String, Hashtable, String)
public Object getKey(CmsObject cms,
String templateFile,
Hashtable parameter,
String templateSelector)
Since this class is quite simple it's okay to return just the name of the template file here.
getKey in interface I_CmsTemplatecms - CmsObject Object for accessing system resourcestemplateFile - Filename of the template filetemplateSelector - template section that should be processed.parameter - Hashtable with all template class parameters.
public boolean isCacheable(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
true here.
isCacheable in interface I_CmsTemplatecms - 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.
true
public boolean isProxyPrivateCacheable(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
I_CmsTemplateComplex classes that are able top include other subtemplates have to check the cacheability of their subclasses here!
isProxyPrivateCacheable in interface I_CmsTemplatecms - 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.
public boolean isProxyPublicCacheable(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
I_CmsTemplateComplex classes that are able top include other subtemplates have to check the cacheability of their subclasses here!
isProxyPublicCacheable in interface I_CmsTemplatecms - 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.
public boolean isExportable(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
I_CmsTemplateDefault conditions are:
Complex classes that are able top include other subtemplates have to check the cacheability of their subclasses here!
isExportable in interface I_CmsTemplatecms - 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.
public boolean isStreamable(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
I_CmsTemplateClasses must not set this feature, if they might throw special exception that cause HTTP errors (e.g. 404/Not Found), or if they might send HTTP redirects.
If a class sets this feature, it has to check the
isStreaming() property of the RequestContext. If this is set
to true the results must be streamed directly
to the output stream. If it is false the results
must not be streamed.
Complex classes that are able top include other subtemplates have to check the streaming ability of their subclasses here!
isStreamable in interface I_CmsTemplatecms - 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.
public CmsCacheDirectives collectCacheDirectives(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
I_CmsTemplateComplex classes that are able to include other subtemplates have to check the streaming ability of their subclasses here!
collectCacheDirectives in interface I_CmsTemplatecms - 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.
public boolean isTemplateCacheSet()
true here.
isTemplateCacheSet in interface I_CmsTemplatetruepublic void setTemplateCache(I_CmsTemplateCache c)
setTemplateCache in interface I_CmsTemplatec - Template cache to be used.
public boolean shouldReload(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
false here.
shouldReload in interface I_CmsTemplatecms - 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.
false
public A_CmsElement createElement(CmsObject cms,
String templateFile,
Hashtable parameters)
I_CmsTemplateComplex template classes that are able to include other (sub-)templates must generate a collection of element definitions for their possible subtemplates. This collection is part of the new element.
createElement in interface I_CmsTemplatecms - CmsObject for accessing system resources.templateFile - Name of the template file for the new elementparameters - All parameters of the current request
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||