org.opencms.workplace.galleries
Class CmsImageGallery
java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.galleries.A_CmsGallery
org.opencms.workplace.galleries.CmsImageGallery
- All Implemented Interfaces:
- java.lang.Comparable
- public class CmsImageGallery
- extends A_CmsGallery
Generates the image gallery popup window which can be used in editors or as a dialog widget.
- Since:
- 6.0.0
- Version:
- $Revision: 1.15 $
- Author:
- Andreas Zahner, Armen Markarian
Field Summary |
static java.lang.String |
URI_GALLERY
URI of the image 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_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_DEFAULT, 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_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, 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.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 |
Method Summary |
java.lang.String |
applyButton()
Generates an apply button for the gallery button bar. |
protected java.lang.String |
buildGalleryItemListCustomEndCols(CmsResource res,
java.lang.String tdClass)
Generates the HTML for custom columns to shown at the end of the list of gallery columns. |
protected java.lang.String |
buildGalleryItemListCustomStartCols(CmsResource res,
java.lang.String tdClass)
Generates the HTML for custom columns to shown at the start of the list of gallery columns. |
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.Integer |
getOrder()
Returns the order of the implemented gallery, used to sort the gallery buttons in the editors. |
java.lang.String |
getPreviewBodyStyle()
Returns the style for the body tag of the preview frame. |
void |
init()
Initialization method that is called after the gallery instance has been created. |
java.lang.String |
previewButton()
Generates a preview button for the gallery button bar. |
java.lang.String |
targetSelectBox()
Generates a HTML String representing a target select box. |
Methods inherited from class org.opencms.workplace.galleries.A_CmsGallery |
buildGalleryButtonBar, buildGalleryItemListHeadline, buildGalleryItems, buildGallerySelectBox, buildPageSelectBox, compareTo, createInstance, createInstance, deleteButton, editPropertyButton, galleriesExists, getBodyOnload, getCssPath, getCurrentResource, getGalleries, getGalleryItems, getGalleryTypeId, getGalleryTypeName, getGalleryTypeParams, getHeadFrameSetHeight, getKeyTitle, getNoGalleryErrorMsg, getParamDialogMode, getParamFieldId, getParamGalleryPath, getParamPage, getParamPropertyValue, getParamResourcePath, getParamSearchWord, getPreviewDivStyle, getPropertyValue, getResourceType, getSearchHits, getTargetOptions, getWizardUrl, hasWritePermissions, initGallery, initWorkplaceRequestValues, previewRow, publishButton, searchButton, setCurrentResource, setParamDialogMode, setParamFieldId, setParamGalleryPath, setParamPage, setParamPropertyValue, setParamResourcePath, setParamSearchWord, setResourceType, sortOptions, wizardButton, writeTitleProperty |
Methods inherited from class org.opencms.workplace.CmsDialog |
actionCloseDialog, appendDelimiter, checkResourcePermissions, checkResourcePermissions, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, 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, getParamRedirect, getParamResource, getParamTitle, getState, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, 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, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, htmlEnd, initMessages, initSettings, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, 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 |
URI_GALLERY
public static final java.lang.String URI_GALLERY
- URI of the image gallery popup dialog.
- See Also:
- Constant Field Values
CmsImageGallery
public CmsImageGallery()
- Public empty constructor, required for
A_CmsGallery.createInstance(String, CmsJspActionElement)
.
CmsImageGallery
public CmsImageGallery(CmsJspActionElement jsp)
- Public constructor with JSP action element.
- Parameters:
jsp
- an initialized JSP action element
CmsImageGallery
public CmsImageGallery(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 contextreq
- the JSP requestres
- the JSP response
applyButton
public java.lang.String applyButton()
- Description copied from class:
A_CmsGallery
- Generates an apply button for the gallery button bar.
The default apply button calls the javascript function link(resourcePath, input.title.value, input.title.value).
Overwrite this method if necessary in the specified gallery class.
- Overrides:
applyButton
in class A_CmsGallery
- Returns:
- an apply button for the gallery button bar
- See Also:
A_CmsGallery.applyButton()
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()
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
getPreviewBodyStyle
public java.lang.String getPreviewBodyStyle()
- Description copied from class:
A_CmsGallery
- Returns the style for the body tag of the preview frame.
- Overrides:
getPreviewBodyStyle
in class A_CmsGallery
- Returns:
- the style for the body tag of the preview frame
- See Also:
A_CmsGallery.getPreviewBodyStyle()
init
public void init()
- Description copied from class:
A_CmsGallery
- Initialization method that is called after the gallery instance has been created.
- Overrides:
init
in class A_CmsGallery
- See Also:
A_CmsGallery.init()
previewButton
public java.lang.String previewButton()
- Description copied from class:
A_CmsGallery
- Generates a preview button for the gallery button bar.
Overwrite this method if neccessary in the specified gallery class.
- Overrides:
previewButton
in class A_CmsGallery
- Returns:
- a preview button for the gallery button bar
- See Also:
A_CmsGallery.previewButton()
targetSelectBox
public java.lang.String targetSelectBox()
- Description copied from class:
A_CmsGallery
- Generates a HTML String representing a target select box.
- Overrides:
targetSelectBox
in class A_CmsGallery
- Returns:
- a HTML String representing a target select box
- See Also:
A_CmsGallery.targetSelectBox()
buildGalleryItemListCustomEndCols
protected java.lang.String buildGalleryItemListCustomEndCols(CmsResource res,
java.lang.String tdClass)
- Description copied from class:
A_CmsGallery
- Generates the HTML for custom columns to shown at the end of the list of gallery columns.
- Overrides:
buildGalleryItemListCustomEndCols
in class A_CmsGallery
- Parameters:
res
- the current VFS resourcetdClass
- the current syle sheet class name for the table cell
- Returns:
- the HTML for custom columns to shown at the end of the list of gallery columns
- See Also:
A_CmsGallery.buildGalleryItemListCustomEndCols(org.opencms.file.CmsResource, java.lang.String)
buildGalleryItemListCustomStartCols
protected java.lang.String buildGalleryItemListCustomStartCols(CmsResource res,
java.lang.String tdClass)
- Description copied from class:
A_CmsGallery
- Generates the HTML for custom columns to shown at the start of the list of gallery columns.
- Overrides:
buildGalleryItemListCustomStartCols
in class A_CmsGallery
- Parameters:
res
- the current VFS resourcetdClass
- the current syle sheet class name for the table cell
- Returns:
- the HTML for custom columns to shown at the end of the list of gallery columns
- See Also:
A_CmsGallery.buildGalleryItemListCustomStartCols(org.opencms.file.CmsResource, java.lang.String)