org.opencms.workplace.galleries
Class CmsAjaxLinkGallery

java.lang.Object
  org.opencms.workplace.CmsWorkplace
      org.opencms.workplace.tools.CmsToolDialog
          org.opencms.workplace.CmsDialog
              org.opencms.workplace.galleries.A_CmsAjaxGallery
                  org.opencms.workplace.galleries.CmsAjaxLinkGallery

public class CmsAjaxLinkGallery
extends A_CmsAjaxGallery

Provides the specific constants, members and helper methods to generate the content of the external link gallery dialog used in the XML content editors, WYSIWYG editors and context menu.

Since:

7.5.0

Version:

$Revision: 1.5 $

Author:

Polina Smagina

Field Summary

static java.lang.String	GALLERYTYPE_NAME Type name of the link gallery.
static java.lang.String	OPEN_URI_SUFFIX The uri suffix for the gallery start page.

Fields inherited from class org.opencms.workplace.galleries.A_CmsAjaxGallery

DIALOG_CHANGEITEMLINKURL, DIALOG_CHANGEITEMTITLE, DIALOG_GETACTIVEITEM, DIALOG_GETCATEGORIES, DIALOG_GETGALLERIES, DIALOG_GETGALLERY, DIALOG_GETITEMS, DIALOG_LIST, LISTMODE_CATEGORY, LISTMODE_GALLERY, m_galleryTypeParams, MODE_EDITOR, MODE_VIEW, MODE_WIDGET, PARAM_DIALOGMODE, PARAM_EDITEDRESOURCE, PARAM_FIELDID, PARAM_GALLERYPATH, PARAM_ITEMPATH, PARAM_PARAMS, PARAM_STARTUPFOLDER, PARAM_STARTUPTYPE, PATH_GALLERIES, RETURNVALUE_NONE

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_FORCE, 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

CmsAjaxLinkGallery()
Public empty constructor, required for A_CmsAjaxGallery.createInstance(String, CmsJspActionElement).

CmsAjaxLinkGallery(CmsJspActionElement jsp)
Public constructor with JSP action element.

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

Method Summary

protected void	buildJsonItemSpecificPart(JSONObject jsonObj, CmsResource res, java.lang.String sitePath) Fills the JSON object with the specific information used for pointer file resource type.
protected void	changeItemLinkUrl(java.lang.String itemUrl) Writes the current link into the pointer resource.
int	getGalleryItemsTypeId() Returns the type id of the gallery items that should be listed.
int	getGalleryTypeId() Returns the type id of this gallery instance.
java.lang.String	getGalleryTypeName() Returns the type name of this gallery instance.

Methods inherited from class org.opencms.workplace.galleries.A_CmsAjaxGallery

buildJsonActiveItem, buildJsonCategoryList, buildJsonGalleryItem, buildJsonGalleryList, buildJsonItemCommonPart, buildJsonItemObject, buildJsonResourceItems, changeItemTitle, createInstance, displayDialog, getCategoryItems, getGalleries, getGalleries, getGalleryItems, getGalleryTypeParams, getParamDialogMode, getParamFieldId, getParamGalleryPath, getParamListMode, getParamPropertyValue, getResourceType, init, initGallery, initWorkplaceRequestValues, isModeEditor, isModeView, isModeWidget, setParamDialogMode, setParamFieldId, setParamGalleryPath, setParamListMode, setParamPropertyValue, setResourceType, 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, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, 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

GALLERYTYPE_NAME

public static final java.lang.String GALLERYTYPE_NAME

Type name of the link gallery.

See Also:

Constant Field Values

OPEN_URI_SUFFIX

public static final java.lang.String OPEN_URI_SUFFIX

The uri suffix for the gallery start page.

See Also:

Constant Field Values

Constructor Detail

CmsAjaxLinkGallery

public CmsAjaxLinkGallery()

Public empty constructor, required for A_CmsAjaxGallery.createInstance(String, CmsJspActionElement).

CmsAjaxLinkGallery

public CmsAjaxLinkGallery(CmsJspActionElement jsp)

Public constructor with JSP action element.

Parameters:

jsp - an initialized JSP action element

CmsAjaxLinkGallery

public CmsAjaxLinkGallery(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

getGalleryItemsTypeId

public int getGalleryItemsTypeId()

Description copied from class: A_CmsAjaxGallery

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_CmsAjaxGallery

Returns:

the type id of the gallery items that should be listed

See Also:

A_CmsAjaxGallery.getGalleryItemsTypeId()

getGalleryTypeId

public int getGalleryTypeId()

Description copied from class: A_CmsAjaxGallery

Returns the type id of this gallery instance.

Specified by:

getGalleryTypeId in class A_CmsAjaxGallery

Returns:

the type id of this gallery instance

See Also:

A_CmsAjaxGallery.getGalleryTypeId()

getGalleryTypeName

public java.lang.String getGalleryTypeName()

Description copied from class: A_CmsAjaxGallery

Returns the type name of this gallery instance.

Specified by:

getGalleryTypeName in class A_CmsAjaxGallery

Returns:

the type name of this gallery instance

See Also:

A_CmsAjaxGallery.getGalleryTypeName()

buildJsonItemSpecificPart

protected void buildJsonItemSpecificPart(JSONObject jsonObj,
                                         CmsResource res,
                                         java.lang.String sitePath)

Fills the JSON object with the specific information used for pointer file resource type.

• pointer: the content of the pointer resource. This could be an external or internal link.

Specified by:

buildJsonItemSpecificPart in class A_CmsAjaxGallery

Parameters:

jsonObj - containing information used by all possible resource

res - the resource to create the object from

sitePath - site path to the object

See Also:

A_CmsAjaxGallery.buildJsonItemSpecificPart(JSONObject jsonObj, CmsResource res, String sitePath)

changeItemLinkUrl

protected void changeItemLinkUrl(java.lang.String itemUrl)

Writes the current link into the pointer resource.

Overrides:

changeItemLinkUrl in class A_CmsAjaxGallery

Parameters:

itemUrl - the pointer resource to change the link of

See Also:

changeItemLinkUrl(String)