|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.galleries.A_CmsGallery
org.opencms.workplace.galleries.CmsLinkGallery
public class CmsLinkGallery
Generates the links gallery popup window which can be used in editors or as a dialog widget.
The following files use this class:
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 for editing the link of a pointer. |
static java.lang.String |
VALUE_EDITPROPERTY_TITLE
Request parameter value for parameter 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.tools.CmsToolDialog |
---|
PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW |
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 . |
void |
setParamEditPropertyValue(java.lang.String paramEditPropertyValue)
Sets the value of the request parameter . |
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.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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PARAM_EDITPROPERTY
The value of this request parameter will denote the property to edit on the pointer resource.
public static final java.lang.String PARAM_EDITPROPERTY_VALUE
The value of this request parameter will contain the value for the property to edit which
is denoted by
.PARAM_EDITPROPERTY
public static final java.lang.String URI_GALLERY
public static final java.lang.String VALUE_EDITPROPERTY_LINK
PARAM_EDITPROPERTY
for editing the link of a pointer.
public static final java.lang.String VALUE_EDITPROPERTY_TITLE
PARAM_EDITPROPERTY
for editing the title of a pointer.
Constructor Detail |
---|
public CmsLinkGallery()
A_CmsGallery.createInstance(String, CmsJspActionElement)
.
public CmsLinkGallery(CmsJspActionElement jsp)
jsp
- an initialized JSP action elementpublic CmsLinkGallery(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
context
- the JSP page contextreq
- the JSP requestres
- the JSP responseMethod Detail |
---|
public java.lang.String applyButton()
A_CmsGallery
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.
applyButton
in class A_CmsGallery
A_CmsGallery.applyButton()
public java.lang.String buildGalleryButtonBar()
buildGalleryButtonBar
in class A_CmsGallery
public java.lang.String buildGalleryItemPreview()
buildGalleryItemPreview
in class A_CmsGallery
public java.lang.String dialogScriptSubmit()
dialogScriptSubmit
in class CmsDialog
public int getGalleryItemsTypeId()
A_CmsGallery
In case of downloadgallery use '-1' to list all resources excluding folders.
getGalleryItemsTypeId
in class A_CmsGallery
A_CmsGallery.getGalleryItemsTypeId()
public java.lang.String getHeadFrameSetHeight()
A_CmsGallery
getHeadFrameSetHeight
in class A_CmsGallery
A_CmsGallery.getHeadFrameSetHeight()
public java.lang.Integer getOrder()
getOrder
in class A_CmsGallery
public java.lang.String getParamEditProperty()
public java.lang.String getParamEditPropertyValue()
public java.lang.String getWizardUrl()
getWizardUrl
in class A_CmsGallery
public java.lang.String previewRow(java.lang.String column1, java.lang.String column2)
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
.
previewRow
in class A_CmsGallery
column1
- the string value for the first columncolumn2
- the string value for the second column
public java.lang.String previewRow(java.lang.String column1, java.lang.String column2, boolean inputField)
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
.
column1
- the string value for the first columncolumn2
- the string value for the second columninputField
- if true
the column1 parameter is used as id attribute for the input field
public void setParamEditProperty(java.lang.String paramEditProperty)
PARAM_EDITPROPERTY
.
paramEditProperty
- the value of the request parameter PARAM_EDITPROPERTY
to setpublic void setParamEditPropertyValue(java.lang.String paramEditPropertyValue)
PARAM_EDITPROPERTY_VALUE
.
paramEditPropertyValue
- the value of the request parameter PARAM_EDITPROPERTY_VALUE
to setpublic java.lang.String wizardButton()
A_CmsGallery
wizardButton
in class A_CmsGallery
A_CmsGallery.wizardButton()
protected java.lang.String buildGalleryItemListCustomEndCols(CmsResource res, java.lang.String tdClass)
A_CmsGallery
buildGalleryItemListCustomEndCols
in class A_CmsGallery
res
- the current VFS resourcetdClass
- the current syle sheet class name for the table cell
A_CmsGallery.buildGalleryItemListCustomEndCols(org.opencms.file.CmsResource, java.lang.String)
protected java.lang.String buildGalleryItemListHeadline()
A_CmsGallery
buildGalleryItemListHeadline
in class A_CmsGallery
A_CmsGallery.buildGalleryItemListHeadline()
protected java.util.List getSearchHits(java.util.List items)
Searches by the title property value, resource name and stored external link.
getSearchHits
in class A_CmsGallery
items
- a list of resource items
protected void writeTitleProperty(CmsResource res)
writeTitleProperty
in class A_CmsGallery
res
- the resource to change the property value
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |