org.opencms.workplace.galleries
Class CmsLinkGallery

java.lang.Object
  extended by org.opencms.workplace.CmsWorkplace
      extended by org.opencms.workplace.tools.CmsToolDialog
          extended by org.opencms.workplace.CmsDialog
              extended by org.opencms.workplace.galleries.A_CmsGallery
                  extended by org.opencms.workplace.galleries.CmsLinkGallery
All Implemented Interfaces:
java.lang.Comparable

public class CmsLinkGallery
extends A_CmsGallery

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

The following files use this class:

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

Field Summary
static java.lang.String PARAM_EDITPROPERTY
          Request parameter name needed for the action: edit property value.
static java.lang.String PARAM_EDITPROPERTY_VALUE
          Request parameter name needed for the action: edit property value.
static java.lang.String URI_GALLERY
          URI of the image gallery popup dialog.
static java.lang.String VALUE_EDITPROPERTY_LINK
          Request parameter value for parameter PARAM_EDITPROPERTY for editing the link of a pointer.
static java.lang.String VALUE_EDITPROPERTY_TITLE
          Request parameter value for parameter PARAM_EDITPROPERTY for editing the title of a pointer.
 
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
CmsLinkGallery()
          Public empty constructor, required for A_CmsGallery.createInstance(String, CmsJspActionElement).
CmsLinkGallery(CmsJspActionElement jsp)
          Public constructor with JSP action element.
CmsLinkGallery(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 applyButton()
          Generates an apply button for the gallery button bar.
 java.lang.String buildGalleryButtonBar()
          Builds the html String for the buttonbar frame.
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 buildGalleryItemListHeadline()
          Generates the HTML for the gallery item list headline.
 java.lang.String buildGalleryItemPreview()
          Builds the html String for the preview frame.
 java.lang.String dialogScriptSubmit()
          Builds the javascript for submitting the property changes for the current pointer in 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.
 java.lang.String getParamEditProperty()
          Returns the property to edit on the previewed resource parameter value.
 java.lang.String getParamEditPropertyValue()
          Returns the property value to edit on the previewed resource parameter value.
protected  java.util.List getSearchHits(java.util.List items)
          Returns a list of hit items.
 java.lang.String getWizardUrl()
          Returns the url for the new CmsResourceTypePointer dialog.
 java.lang.String previewRow(java.lang.String column1, java.lang.String column2)
          Generates a HTML table row with two columns that contain the name on the left side and an a text input on the right side.
 java.lang.String previewRow(java.lang.String column1, java.lang.String column2, boolean inputField)
          Generates a HTML table row with two columns that contain the name on the left side and an a text input or plain text (based upon the boolean argument flag) on the right side.
 void setParamEditProperty(java.lang.String paramEditProperty)
          Sets the value of the request parameter PARAM_EDITPROPERTY.
 void setParamEditPropertyValue(java.lang.String paramEditPropertyValue)
          Sets the value of the request parameter PARAM_EDITPROPERTY_VALUE.
 java.lang.String wizardButton()
          Builds the HTML for the wizard button.
protected  void writeTitleProperty(CmsResource res)
          Changes the value of the property title for the specified resource.
 
Methods inherited from class org.opencms.workplace.galleries.A_CmsGallery
buildGalleryItemListCustomStartCols, 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, getTargetOptions, hasWritePermissions, init, initGallery, initWorkplaceRequestValues, previewButton, publishButton, searchButton, setCurrentResource, setParamCssPath, setParamDialogMode, setParamFieldId, setParamGalleryPath, setParamPage, setParamPropertyValue, setParamResourcePath, setParamSearchWord, setResourceType, sortOptions, targetSelectBox
 
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, 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

PARAM_EDITPROPERTY

public static final java.lang.String PARAM_EDITPROPERTY
Request parameter name needed for the action: edit property value.

The value of this request parameter will denote the property to edit on the pointer resource.

See Also:
Constant Field Values

PARAM_EDITPROPERTY_VALUE

public static final java.lang.String PARAM_EDITPROPERTY_VALUE
Request parameter name needed for the action: edit property value.

The value of this request parameter will contain the value for the property to edit which is denoted by PARAM_EDITPROPERTY.

See Also:
Constant Field Values

URI_GALLERY

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

See Also:
Constant Field Values

VALUE_EDITPROPERTY_LINK

public static final java.lang.String VALUE_EDITPROPERTY_LINK
Request parameter value for parameter PARAM_EDITPROPERTY for editing the link of a pointer.

See Also:
Constant Field Values

VALUE_EDITPROPERTY_TITLE

public static final java.lang.String VALUE_EDITPROPERTY_TITLE
Request parameter value for parameter PARAM_EDITPROPERTY for editing the title of a pointer.

See Also:
Constant Field Values
Constructor Detail

CmsLinkGallery

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


CmsLinkGallery

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

Parameters:
jsp - an initialized JSP action element

CmsLinkGallery

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

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()

buildGalleryButtonBar

public java.lang.String buildGalleryButtonBar()
Builds the html String for the buttonbar frame.

Overrides:
buildGalleryButtonBar in class A_CmsGallery
Returns:
the html String for the buttonbar frame

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

dialogScriptSubmit

public java.lang.String dialogScriptSubmit()
Builds the javascript for submitting the property changes for the current pointer in the preview frame.

Overrides:
dialogScriptSubmit in class CmsDialog
Returns:
the javascript for submitting the property changes for the current pointer in 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

getParamEditProperty

public java.lang.String getParamEditProperty()
Returns the property to edit on the previewed resource parameter value.

Returns:
the parameter value

getParamEditPropertyValue

public java.lang.String getParamEditPropertyValue()
Returns the property value to edit on the previewed resource parameter value.

Returns:
the parameter value

getWizardUrl

public java.lang.String getWizardUrl()
Returns the url for the new CmsResourceTypePointer dialog.

Overrides:
getWizardUrl in class A_CmsGallery
Returns:
the url for the wizard dialog

previewRow

public java.lang.String previewRow(java.lang.String column1,
                                   java.lang.String column2)
Generates a HTML table row with two columns that contain the name on the left side and an a text input on the right side.

The first column includes the given display String, the second column includes an input field with the id attribute set to column1 preset with column2.

Overrides:
previewRow in class A_CmsGallery
Parameters:
column1 - the string value for the first column
column2 - the string value for the second column
Returns:
a HTML table row with two columns

previewRow

public java.lang.String previewRow(java.lang.String column1,
                                   java.lang.String column2,
                                   boolean inputField)
Generates a HTML table row with two columns that contain the name on the left side and an a text input or plain text (based upon the boolean argument flag) on the right side.

The first column includes the given display String, the second column includes an input field with the id attribute set to column1 preset with column2.

Parameters:
column1 - the string value for the first column
column2 - the string value for the second column
inputField - if true the column1 parameter is used as id attribute for the input field
Returns:
a HTML table row with two columns

setParamEditProperty

public void setParamEditProperty(java.lang.String paramEditProperty)
Sets the value of the request parameter PARAM_EDITPROPERTY.

Parameters:
paramEditProperty - the value of the request parameter PARAM_EDITPROPERTY to set

setParamEditPropertyValue

public void setParamEditPropertyValue(java.lang.String paramEditPropertyValue)
Sets the value of the request parameter PARAM_EDITPROPERTY_VALUE.

Parameters:
paramEditPropertyValue - the value of the request parameter PARAM_EDITPROPERTY_VALUE to set

wizardButton

public java.lang.String wizardButton()
Description copied from class: A_CmsGallery
Builds the HTML for the wizard button.

Overrides:
wizardButton in class A_CmsGallery
Returns:
the HTML for the wizard button
See Also:
A_CmsGallery.wizardButton()

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 resource
tdClass - 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)

buildGalleryItemListHeadline

protected java.lang.String buildGalleryItemListHeadline()
Description copied from class: A_CmsGallery
Generates the HTML for the gallery item list headline.

Overrides:
buildGalleryItemListHeadline in class A_CmsGallery
Returns:
the HTML for the gallery item list headline
See Also:
A_CmsGallery.buildGalleryItemListHeadline()

getSearchHits

protected java.util.List getSearchHits(java.util.List items)
Returns a list of hit items.

Searches by the title property value, resource name and stored external link.

Overrides:
getSearchHits in class A_CmsGallery
Parameters:
items - a list of resource items
Returns:
a list of hit items

writeTitleProperty

protected void writeTitleProperty(CmsResource res)
Changes the value of the property title for the specified resource.

Overrides:
writeTitleProperty in class A_CmsGallery
Parameters:
res - the resource to change the property value