org.opencms.workplace.galleries
Class CmsDownloadGallery

java.lang.Object
  extended byorg.opencms.workplace.CmsWorkplace
      extended byorg.opencms.workplace.tools.CmsToolDialog
          extended byorg.opencms.workplace.CmsDialog
              extended byorg.opencms.workplace.galleries.A_CmsGallery
                  extended byorg.opencms.workplace.galleries.CmsDownloadGallery
All Implemented Interfaces:
java.lang.Comparable

public class CmsDownloadGallery
extends A_CmsGallery

Generates the download gallery popup window which can be used in editors or as a dialog widget.

Since:
6.0.0
Version:
$Revision: 1.16 $
Author:
Armen Markarian

Field Summary
static java.lang.String URI_GALLERY
          URI of the download gallery popup dialog.
 
Fields inherited from class org.opencms.workplace.galleries.A_CmsGallery
ACTION_DELETE, ACTION_LIST, ACTION_SEARCH, ACTION_UPLOAD, CSS_FILENAME, DIALOG_DELETE, DIALOG_EDITPROPERTY, DIALOG_LIST, DIALOG_SEARCH, DIALOG_TYPE, DIALOG_UPLOAD, MODE_EDITOR, MODE_VIEW, MODE_WIDGET, OPEN_URI_SUFFIX, PARAM_CSSPATH, PARAM_DIALOGMODE, PARAM_FIELDID, PARAM_GALLERY_TYPENAME, PARAM_GALLERYPATH, PARAM_PAGE, PARAM_PROPERTYVALUE, PARAM_RESOURCEPATH, PARAM_SEARCHWORD, PATH_GALLERIES
 
Fields inherited from class org.opencms.workplace.CmsDialog
ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE
 
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog
PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW
 
Fields inherited from class org.opencms.workplace.CmsWorkplace
DEBUG, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, TEMP_FILE_PREFIX, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE
 
Constructor Summary
CmsDownloadGallery()
          Public empty constructor, required for A_CmsGallery.createInstance(String, CmsJspActionElement).
CmsDownloadGallery(CmsJspActionElement jsp)
          Public constructor with JSP action element.
CmsDownloadGallery(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          Public constructor with JSP variables.
 
Method Summary
 java.lang.String buildGalleryItemPreview()
          Builds the html String for the preview frame.
 int getGalleryItemsTypeId()
          Returns the type id of the gallery items that should be listed.
 java.lang.String getHeadFrameSetHeight()
          Returns the height of the head frameset.
 java.lang.Integer getOrder()
          Returns the order of the implemented gallery, used to sort the gallery buttons in the editors.
 
Methods inherited from class org.opencms.workplace.galleries.A_CmsGallery
applyButton, buildGalleryButtonBar, buildGalleryItemListCustomEndCols, buildGalleryItemListCustomStartCols, buildGalleryItemListHeadline, buildGalleryItems, buildGallerySelectBox, buildPageSelectBox, compareTo, createInstance, createInstance, deleteButton, editPropertyButton, galleriesExists, getBodyOnload, getCssPath, getCurrentResource, getGalleries, getGalleryItems, getGalleryTypeId, getGalleryTypeName, getGalleryTypeParams, getKeyTitle, getNoGalleryErrorMsg, getParamCssPath, getParamDialogMode, getParamFieldId, getParamGalleryPath, getParamPage, getParamPropertyValue, getParamResourcePath, getParamSearchWord, getPreviewBodyStyle, getPreviewDivStyle, getPropertyValue, getResourceType, getSearchHits, getTargetOptions, getWizardUrl, hasWritePermissions, init, initGallery, initWorkplaceRequestValues, previewButton, previewRow, publishButton, searchButton, setCurrentResource, setParamCssPath, setParamDialogMode, setParamFieldId, setParamGalleryPath, setParamPage, setParamPropertyValue, setParamResourcePath, setParamSearchWord, setResourceType, sortOptions, targetSelectBox, wizardButton, writeTitleProperty
 
Methods inherited from class org.opencms.workplace.CmsDialog
actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle
 
Methods inherited from class org.opencms.workplace.tools.CmsToolDialog
dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamPath, setParamRoot, setParamStyle, useNewStyle
 
Methods inherited from class org.opencms.workplace.CmsWorkplace
addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, isTemporaryFileName, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, switchToCurrentProject, switchToTempProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

URI_GALLERY

public static final java.lang.String URI_GALLERY
URI of the download gallery popup dialog.

See Also:
Constant Field Values
Constructor Detail

CmsDownloadGallery

public CmsDownloadGallery()
Public empty constructor, required for A_CmsGallery.createInstance(String, CmsJspActionElement).


CmsDownloadGallery

public CmsDownloadGallery(CmsJspActionElement jsp)
Public constructor with JSP action element.

Parameters:
jsp - an initialized JSP action element

CmsDownloadGallery

public CmsDownloadGallery(javax.servlet.jsp.PageContext context,
                          javax.servlet.http.HttpServletRequest req,
                          javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables.

Parameters:
context - the JSP page context
req - the JSP request
res - the JSP response
Method Detail

buildGalleryItemPreview

public java.lang.String buildGalleryItemPreview()
Builds the html String for the preview frame.

Specified by:
buildGalleryItemPreview in class A_CmsGallery
Returns:
the html String for the preview frame

getGalleryItemsTypeId

public int getGalleryItemsTypeId()
Description copied from class: A_CmsGallery
Returns the type id of the gallery items that should be listed.

In case of downloadgallery use '-1' to list all resources excluding folders.

Specified by:
getGalleryItemsTypeId in class A_CmsGallery
Returns:
the type id of the gallery items that should be listed
See Also:
A_CmsGallery.getGalleryItemsTypeId()

getHeadFrameSetHeight

public java.lang.String getHeadFrameSetHeight()
Description copied from class: A_CmsGallery
Returns the height of the head frameset.

Overrides:
getHeadFrameSetHeight in class A_CmsGallery
Returns:
the height of the head frameset
See Also:
A_CmsGallery.getHeadFrameSetHeight()

getOrder

public java.lang.Integer getOrder()
Returns the order of the implemented gallery, used to sort the gallery buttons in the editors.

Overrides:
getOrder in class A_CmsGallery
Returns:
the order of the implemented gallery