|
|||||||||||
| 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.A_CmsGalleryBrowser
|
+--com.opencms.workplace.CmsPictureBrowser
Template class for displaying OpenCms picture browser.
Reads template files 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 | |
CmsPictureBrowser()
|
|
| Method Summary | |
byte[] |
getContent(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
Gets the content of a defined section in a given template file and its subtemplates with the given parameters. |
Integer |
getPicGalleryNames(CmsObject cms,
CmsXmlLanguageFile lang,
Vector names,
Vector values,
Hashtable parameters)
Gets the filenames of all picture galleries The given vectors names and values will
be filled with the appropriate information to be used for building
a select box. |
boolean |
isCacheable(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
Indicates if the results of this class are cacheable. |
Object |
pictureList(CmsObject cms,
String tagcontent,
A_CmsXmlContent doc,
Object userObj)
User method to generate an URL for the pics folder. |
Boolean |
showBackButton(CmsObject cms,
CmsXmlLanguageFile lang,
Hashtable parameters)
Used by the workplace "back" button to decide whether the icon should be activated or not. |
Boolean |
showNextButton(CmsObject cms,
CmsXmlLanguageFile lang,
Hashtable parameters)
Used by the workplace "next" button to decide whether the icon should be activated or not. |
| Methods inherited from class com.opencms.workplace.A_CmsGalleryBrowser |
checkAccess, getGalleryNames, getGallerySubFolders, inFilter |
| 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 CmsPictureBrowser()
| Method Detail |
public byte[] getContent(CmsObject cms,
String templateFile,
String elementName,
Hashtable parameters,
String templateSelector)
throws CmsException
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 Integer getPicGalleryNames(CmsObject cms,
CmsXmlLanguageFile lang,
Vector names,
Vector values,
Hashtable parameters)
throws CmsException
The given vectors names and values will
be filled with the appropriate information to be used for building
a select box. The values will be the paths to the galleries.
cms - CmsObject Object for accessing system resources.names - Vector to be filled with the appropriate values in this method.values - Vector to be filled with the appropriate values in this method.parameters - Hashtable containing all user parameters (not used here).
CmsException
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.
public Object pictureList(CmsObject cms,
String tagcontent,
A_CmsXmlContent doc,
Object userObj)
throws CmsException
All pictures should reside in the docroot of the webserver for performance reasons. This folder can be mounted into the OpenCms system to make it accessible for the OpenCms explorer.
The path to the docroot can be set in the workplace ini.
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 (not used here).userObj - Hashtable with parameters (not used here).
CmsException
public Boolean showBackButton(CmsObject cms,
CmsXmlLanguageFile lang,
Hashtable parameters)
method="showBackButton"
is defined in the <BUTTON> tag.
This method returns false if the currently displayed page is
the first page.
cms - CmsObject Object for accessing system resources (not used here).lang - reference to the currently valid language file (not used here).parameters - Hashtable containing all user parameters (not used here).
true if the button should be enabled, false otherwise.
public Boolean showNextButton(CmsObject cms,
CmsXmlLanguageFile lang,
Hashtable parameters)
method="showNextButton"
is defined in the <BUTTON> tag.
This method returns false if the currently displayed page is
the last page.
cms - CmsObject Object for accessing system resources (not used here).lang - reference to the currently valid language file (not used here).parameters - Hashtable containing all user parameters (not used here).
true if the button should be enabled, false otherwise.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||