org.opencms.workplace.galleries

类 CmsAjaxImageGallery

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.CmsAjaxImageGallery

public class CmsAjaxImageGallery
extends A_CmsAjaxGallery

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

从以下版本开始:

7.5.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	GALLERYTYPE_NAME Type name of the image gallery.
static java.lang.String	OPEN_URI_SUFFIX The uri suffix for the gallery start page.
static java.lang.String	PARAM_FORMATNAME Request parameter name for the format name.
static java.lang.String	PARAM_FORMATVALUE Request parameter name for the format value.
static java.lang.String	PARAM_HASHID Request parameter name for the input field hash id.
static java.lang.String	PARAM_IMGHEIGHT Request parameter name for the image height.
static java.lang.String	PARAM_IMGWIDTH Request parameter name for the image width.
static java.lang.String	PARAM_SCALE Request parameter name for the image scale parameters.
static java.lang.String	PARAM_USEFORMATS Request parameter name for the use formats flag.
static java.lang.String	PARAM_WIDGETMODE Property definition name for the Copyright property.
static java.lang.String	PROPERTY_COPYRIGHT Property definition name for the Copyright property.

从类继承的字段 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

从类继承的字段 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

从类继承的字段 org.opencms.workplace.tools.CmsToolDialog

PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

从类继承的字段 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, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, 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, VIEW_DIRECT_EDIT, VIEW_WORKPLACE

构造器概要

构造器

构造器和说明
CmsAjaxImageGallery() Public empty constructor, required for A_CmsAjaxGallery.createInstance(String, CmsJspActionElement).
CmsAjaxImageGallery(CmsJspActionElement jsp) Public constructor with JSP action element.
CmsAjaxImageGallery(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.

方法概要

方法

限定符和类型	方法和说明
protected void	buildJsonItemSpecificPart(JSONObject jsonObj, CmsResource res, java.lang.String sitePath) Fills the JSON object with the specific information used for image resource type.
CmsImageScaler	getDefaultScaleParams() Returns the default image scaling parameters for the gallery preview.
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.
void	init() Initializes the default image scaling parameters for the gallery preview.

从类继承的方法 org.opencms.workplace.galleries.A_CmsAjaxGallery

buildJsonActiveItem, buildJsonCategoryList, buildJsonGalleryItem, buildJsonGalleryList, buildJsonItemCommonPart, buildJsonItemObject, buildJsonResourceItems, changeItemLinkUrl, changeItemTitle, createInstance, displayDialog, getCategoryItems, getGalleries, getGalleries, getGalleryItems, getGalleryTypeParams, getParamDialogMode, getParamFieldId, getParamGalleryPath, getParamListMode, getParamPropertyValue, getResourceType, initGallery, initWorkplaceRequestValues, isModeEditor, isModeView, isModeWidget, setParamDialogMode, setParamFieldId, setParamGalleryPath, setParamListMode, setParamPropertyValue, setResourceType, writeTitleProperty

从类继承的方法 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

从类继承的方法 org.opencms.workplace.tools.CmsToolDialog

computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle

从类继承的方法 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, getStartSiteRoot, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, switchToCurrentProject, switchToTempProject

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

GALLERYTYPE_NAME

public static final java.lang.String GALLERYTYPE_NAME

Type name of the image gallery.

另请参阅:

常量字段值

OPEN_URI_SUFFIX

public static final java.lang.String OPEN_URI_SUFFIX

The uri suffix for the gallery start page.

另请参阅:

常量字段值

PARAM_FORMATNAME

public static final java.lang.String PARAM_FORMATNAME

Request parameter name for the format name.

另请参阅:

常量字段值

PARAM_FORMATVALUE

public static final java.lang.String PARAM_FORMATVALUE

Request parameter name for the format value.

另请参阅:

常量字段值

PARAM_HASHID

public static final java.lang.String PARAM_HASHID

Request parameter name for the input field hash id.

另请参阅:

常量字段值

PARAM_IMGHEIGHT

public static final java.lang.String PARAM_IMGHEIGHT

Request parameter name for the image height.

另请参阅:

常量字段值

PARAM_IMGWIDTH

public static final java.lang.String PARAM_IMGWIDTH

Request parameter name for the image width.

另请参阅:

常量字段值

PARAM_SCALE

public static final java.lang.String PARAM_SCALE

Request parameter name for the image scale parameters.

另请参阅:

常量字段值

PARAM_USEFORMATS

public static final java.lang.String PARAM_USEFORMATS

Request parameter name for the use formats flag.

另请参阅:

常量字段值

PARAM_WIDGETMODE

public static final java.lang.String PARAM_WIDGETMODE

Property definition name for the Copyright property.

另请参阅:

常量字段值

PROPERTY_COPYRIGHT

public static final java.lang.String PROPERTY_COPYRIGHT

Property definition name for the Copyright property.

另请参阅:

常量字段值

构造器详细资料

CmsAjaxImageGallery

public CmsAjaxImageGallery()

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

CmsAjaxImageGallery

public CmsAjaxImageGallery(CmsJspActionElement jsp)

Public constructor with JSP action element.

参数:

jsp - an initialized JSP action element

CmsAjaxImageGallery

public CmsAjaxImageGallery(javax.servlet.jsp.PageContext context,
                   javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse res)

Public constructor with JSP variables.

参数:

context - the JSP page context

req - the JSP request

res - the JSP response

方法详细资料

getDefaultScaleParams

public CmsImageScaler getDefaultScaleParams()

Returns the default image scaling parameters for the gallery preview.

返回:

the default image scaling parameters for the gallery preview

getGalleryItemsTypeId

public int getGalleryItemsTypeId()

从类复制的说明: 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.

指定者:

getGalleryItemsTypeId 在类中 A_CmsAjaxGallery

返回:

the type id of the gallery items that should be listed

另请参阅:

A_CmsAjaxGallery.getGalleryItemsTypeId()

getGalleryTypeId

public int getGalleryTypeId()

从类复制的说明: A_CmsAjaxGallery

Returns the type id of this gallery instance.

指定者:

getGalleryTypeId 在类中 A_CmsAjaxGallery

返回:

the type id of this gallery instance

另请参阅:

A_CmsAjaxGallery.getGalleryTypeId()

getGalleryTypeName

public java.lang.String getGalleryTypeName()

从类复制的说明: A_CmsAjaxGallery

Returns the type name of this gallery instance.

指定者:

getGalleryTypeName 在类中 A_CmsAjaxGallery

返回:

the type name of this gallery instance

另请参阅:

A_CmsAjaxGallery.getGalleryTypeName()

init

public void init()

Initializes the default image scaling parameters for the gallery preview.

覆盖:

init 在类中 A_CmsAjaxGallery

另请参阅:

A_CmsAjaxGallery.init()

buildJsonItemSpecificPart

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

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

• scalepath: scaling parameters.
• width: image width.
• height: image height.
• id: image ID.
• type: image type.
• hash: image structure id hash code.
• copyright: image copyright.

指定者:

buildJsonItemSpecificPart 在类中 A_CmsAjaxGallery

参数:

jsonObj - containing information used by all possible resource

res - the resource to create the object from

sitePath - site path to the object

另请参阅:

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