|
| |
|
| org.opencms.workplace.CmsDialog
 org.opencms.workplace.galleries.A_CmsGallery
All known Subclasses: org.opencms.workplace.galleries.CmsLinkGallery, org.opencms.workplace.galleries.CmsImageGallery, org.opencms.workplace.galleries.CmsHtmlGallery, org.opencms.workplace.galleries.CmsDownloadGallery,
| A_CmsGallery | | abstract public class A_CmsGallery extends CmsDialog implements Comparable(Code) | | Provides constants, members and methods to generate a gallery popup window usable in editors or as widget.
Extend this class for every gallery type (e.g. image gallery) to build.
author:
Andreas Zahner
author:
Armen Markarian
version:
$Revision: 1.30 $
since:
6.0.0 |
| ACTION_DELETE | | final public static int ACTION_DELETE(Code) | | Value for the action: delete the gallery item.
|
| ACTION_LIST | | final public static int ACTION_LIST(Code) | | Value for the action: list gallery items.
|
| ACTION_SEARCH | | final public static int ACTION_SEARCH(Code) | | Value for the action: search gallery items.
|
| ACTION_UPLOAD | | final public static int ACTION_UPLOAD(Code) | | Value for the action: upload a new gallery item.
|
| CSS_FILENAME | | final public static String CSS_FILENAME(Code) | | The CSS filename used in the galleries.
|
| DIALOG_DELETE | | final public static String DIALOG_DELETE(Code) | | Request parameter value for the action: delete the gallery item.
|
| DIALOG_EDITPROPERTY | | final public static String DIALOG_EDITPROPERTY(Code) | | Request parameter value for the action: edit property value.
|
| DIALOG_LIST | | final public static String DIALOG_LIST(Code) | | Request parameter value for the action: list gallery items.
|
| DIALOG_SEARCH | | final public static String DIALOG_SEARCH(Code) | | Request parameter value for the action: search gallery items.
|
| DIALOG_TYPE | | final public static String DIALOG_TYPE(Code) | | The dialog type.
|
| DIALOG_UPLOAD | | final public static String DIALOG_UPLOAD(Code) | | Request parameter value for the action: upload a new gallery item.
|
| MODE_EDITOR | | final public static String MODE_EDITOR(Code) | | Request parameter value for the dialog mode: editor.
|
| MODE_VIEW | | final public static String MODE_VIEW(Code) | | Request parameter value for the dialog mode: view.
|
| MODE_WIDGET | | final public static String MODE_WIDGET(Code) | | Request parameter value for the dialog mode: widget.
|
| OPEN_URI_SUFFIX | | final public static String OPEN_URI_SUFFIX(Code) | | The uri suffix for the gallery start page.
|
| PARAM_CSSPATH | | final public static String PARAM_CSSPATH(Code) | | Request parameter name for the CSS path used in the preview area.
|
| PARAM_DIALOGMODE | | final public static String PARAM_DIALOGMODE(Code) | | Request parameter name for the dialog mode (widget or editor).
|
| PARAM_FIELDID | | final public static String PARAM_FIELDID(Code) | | Request parameter name for the input field id.
|
| PARAM_GALLERYPATH | | final public static String PARAM_GALLERYPATH(Code) | | Request parameter name for the gallery path.
|
| PARAM_GALLERY_TYPENAME | | final public static String PARAM_GALLERY_TYPENAME(Code) | | Request parameter name for the gallery type.
|
| PARAM_PAGE | | final public static String PARAM_PAGE(Code) | | Request parameter name for the gallery list page.
|
| PARAM_PROPERTYVALUE | | final public static String PARAM_PROPERTYVALUE(Code) | | Request parameter name for the property value.
|
| PARAM_RESOURCEPATH | | final public static String PARAM_RESOURCEPATH(Code) | | Request parameter name for the resourcepath.
|
| PARAM_SEARCHWORD | | final public static String PARAM_SEARCHWORD(Code) | | Request parameter name for the search word.
|
| PATH_GALLERIES | | final public static String PATH_GALLERIES(Code) | | The galleries path in the workplace containing the JSPs.
|
| A_CmsGallery | | public A_CmsGallery(CmsJspActionElement jsp)(Code) | | Public constructor with JSP action element.
Parameters:
jsp - an initialized JSP action element |
| applyButton | | public String applyButton()(Code) | | 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.
an apply button for the gallery button bar |
| buildGalleryButtonBar | | public String buildGalleryButtonBar()(Code) | | Builds the html String for the buttonbar frame.
the html String for the buttonbar frame |
| buildGalleryItemListCustomEndCols | | protected String buildGalleryItemListCustomEndCols(CmsResource res, String tdClass)(Code) | | Generates the HTML for custom columns to shown at the end of the list of gallery columns.
Parameters:
res - the current VFS resource
Parameters:
tdClass - the current syle sheet class name for the table cell the HTML for custom columns to shown at the end of the list of gallery columns |
| buildGalleryItemListCustomStartCols | | protected String buildGalleryItemListCustomStartCols(CmsResource res, String tdClass)(Code) | | Generates the HTML for custom columns to shown at the start of the list of gallery columns.
Parameters:
res - the current VFS resource
Parameters:
tdClass - the current syle sheet class name for the table cell the HTML for custom columns to shown at the end of the list of gallery columns |
| buildGalleryItemListHeadline | | protected String buildGalleryItemListHeadline()(Code) | | Generates the HTML for the gallery item list headline.
the HTML for the gallery item list headline |
| buildGalleryItemPreview | | abstract public String buildGalleryItemPreview()(Code) | | Builds the html String for the preview frame.
the html String for the preview frame |
| buildGalleryItems | | public String buildGalleryItems()(Code) | | Builds the html for the gallery items list.
the html for the gallery items list |
| buildGallerySelectBox | | public String buildGallerySelectBox()(Code) | | Returns the html for the gallery select box.
the html for the gallery select box |
| buildPageSelectBox | | public String buildPageSelectBox()(Code) | | Builds the HTML String for the page select box.
the HTML String for the page select box |
| createInstance | | public static A_CmsGallery createInstance(CmsJspActionElement jsp)(Code) | | Creates a new gallery instance.
Parameters:
jsp - an initialized JSP action element a new gallery instance |
| createInstance | | public static A_CmsGallery createInstance(String galleryTypeName, CmsJspActionElement jsp)(Code) | | Creates a new gallery instance of the given gallery type name.
Parameters:
galleryTypeName - the gallery type name to create the instance for
Parameters:
jsp - an initialized JSP action element a new gallery instance of the given gallery type name |
| deleteButton | | public String deleteButton()(Code) | | Generates a delete button for the gallery button bar.
This button is disabled if the urrent user has no write permissions.
Overwrite this method if necessary in the specified gallery class.
a delete button for the gallery button bar |
| editPropertyButton | | public String editPropertyButton()(Code) | | Generates an edit property button for the gallery button bar.
If the current resource is not 'editable' a disabled button will be returned.
Overwrite this method if necessary in the specified gallery class.
an edit property button for the gallery button bar |
| galleriesExists | | public boolean galleriesExists()(Code) | | Checks if at least one gallery exists.
true if at least one gallery exists, otherwise false |
| getBodyOnload | | public String getBodyOnload()(Code) | | Returns the javascript body onload call for the gallery head frame.
the javascript body onload call for the gallery head frame |
| getCssPath | | public String getCssPath()(Code) | | Return the path of the css file used in the galleries.
the path of the css file used in the galleries |
| getCurrentResource | | public CmsResource getCurrentResource()(Code) | | Returns the current resource in the gallery.
the current resource in the gallery |
| getGalleries | | public List getGalleries()(Code) | | Returns a list of galleries which have the required gallery type id.
a list of galleries |
| getGalleryItems | | public List getGalleryItems()(Code) | | Returns a list of gallery items (resources) for the currently selected gallery and resource type id.
a list of gallery items (resources) |
| getGalleryItemsTypeId | | abstract public int getGalleryItemsTypeId()(Code) | | Returns the type id of the gallery items that should be listed.
In case of downloadgallery use '-1' to list all resources excluding folders.
the type id of the gallery items that should be listed |
| getGalleryTypeId | | public int getGalleryTypeId()(Code) | | Returns the resource type id of this gallery instance.
the resource type id of this gallery instance |
| getGalleryTypeName | | public String getGalleryTypeName()(Code) | | Returns the resource type name of this gallery instance.
the resource type name of this gallery instance |
| getGalleryTypeParams | | public String getGalleryTypeParams()(Code) | | Returns the (optional) parameters of this gallery instance.
the (optional) parameters of this gallery instance |
| getHeadFrameSetHeight | | public String getHeadFrameSetHeight()(Code) | | Returns the height of the head frameset.
the height of the head frameset |
| getKeyTitle | | public String getKeyTitle()(Code) | | Returns the key title of the current gallery view.
the key title of the current gallery view |
| getNoGalleryErrorMsg | | public String getNoGalleryErrorMsg()(Code) | | Returns the error message if no gallery could be found.
the error message if no gallery could be found |
| getOrder | | public Integer getOrder()(Code) | | Returns the order of the implemented gallery, used to sort the gallery buttons in the editors.
the order of the implemented gallery |
| getParamCssPath | | public String getParamCssPath()(Code) | | Returns the CSS path used in the preview area.
the CSS path used in the preview area |
| getParamDialogMode | | public String getParamDialogMode()(Code) | | Returns the current mode of the dialog.
This is necessary to distinguish between widget mode, view mode and editor mode.
the current mode of the dialog |
| getParamFieldId | | public String getParamFieldId()(Code) | | Returns the input field ID when in widget mode.
the input field ID |
| getParamGalleryPath | | public String getParamGalleryPath()(Code) | | Returns the path of the gallery to display.
the path of the gallery to display |
| getParamPage | | public String getParamPage()(Code) | | Returns the current page to display in the item list.
the current page to display in the item list |
| getParamPropertyValue | | public String getParamPropertyValue()(Code) | | Returns the property value parameter.
the property value parameter |
| getParamResourcePath | | public String getParamResourcePath()(Code) | | Returns the resource path.
the resource path |
| getParamSearchWord | | public String getParamSearchWord()(Code) | | Returns the search word to look up in the gallery items.
the search word to look up in the gallery items |
| getPreviewBodyStyle | | public String getPreviewBodyStyle()(Code) | | Returns the style for the body tag of the preview frame.
the style for the body tag of the preview frame |
| getPreviewDivStyle | | public String getPreviewDivStyle()(Code) | | Returns the style for the div tag of the preview frame.
the style for the div tag of the preview frame |
| getPropertyValue | | protected String getPropertyValue(CmsResource resource, String propertydefinition)(Code) | | Returns the value of the given property definition of the specified resource.
If the property value is null, '[resourcename]' will be returned instead.
Parameters:
resource - the cms resource
Parameters:
propertydefinition - the property definition the value of the title property or '[resourcename]' if property value was null |
| getResourceType | | public CmsResourceTypeFolderExtended getResourceType()(Code) | | Returns the extended folder resource type this gallery is based on.
the extended folder resource type this gallery is based on |
| getSearchHits | | protected List getSearchHits(List items)(Code) | | Returns a list of hit items.
Searches by the title property value and resource name.
Parameters:
items - a list of resource items a list of hit items |
| getTargetOptions | | protected String getTargetOptions()(Code) | | Returns a HTML String representing the options of the target select box.
a HTML String representing the options of the target select box |
| getWizardUrl | | public String getWizardUrl()(Code) | | Returns the url for the upload applet or JSP dialog.
the url for the upload applet or JSP dialog |
| hasWritePermissions | | protected boolean hasWritePermissions() throws CmsException(Code) | | Checks if the current user has required permissions to edit the current resource.
true if the required permissions are satisfied
throws:
CmsException - if something goes wrong |
| init | | public void init()(Code) | | Initialization method that is called after the gallery instance has been created.
|
| initGallery | | public static void initGallery(CmsDialog wp)(Code) | | Initializes the gallery dialog before redirecting.
Parameters:
wp - the workplace object |
| previewButton | | public String previewButton()(Code) | | Generates a preview button for the gallery button bar.
Overwrite this method if neccessary in the specified gallery class.
a preview button for the gallery button bar |
| previewRow | | public String previewRow(String column1, String column2)(Code) | | Generates a HTML table row with two columns.
The first column includes the given string, the second column
includes the value of the given property.
Parameters:
column1 - the string value for the first column
Parameters:
column2 - the string value for the second column a HTML table row with two columns |
| publishButton | | public String publishButton()(Code) | | Generates a publish button for the gallery button bar.
This button is disabled if the current user has no publish rights.
a publish button for the gallery button bar |
| searchButton | | public String searchButton()(Code) | | Builds the HTML for the search button.
the HTML for the search button |
| setCurrentResource | | public void setCurrentResource(CmsResource currentResource)(Code) | | Sets the current resource.
Parameters:
currentResource - the current resource to set |
| setParamCssPath | | public void setParamCssPath(String paramCssPath)(Code) | | Sets the CSS path used in the preview area.
Parameters:
paramCssPath - the CSS path used in the preview area |
| setParamDialogMode | | public void setParamDialogMode(String dialogMode)(Code) | | Sets the current mode of the dialog.
This is necessary to distinguish between widget mode and editor mode.
Parameters:
dialogMode - the current mode of the dialog |
| setParamFieldId | | public void setParamFieldId(String fieldId)(Code) | | Sets the input field ID if in widget mode.
Parameters:
fieldId - the input field ID |
| setParamGalleryPath | | public void setParamGalleryPath(String galleryPath)(Code) | | Sets the path of the gallery to display.
Parameters:
galleryPath - the path of the gallery to display |
| setParamPage | | public void setParamPage(String page)(Code) | | Sets the current page to display in the item list.
Parameters:
page - the current page to display in the item list |
| setParamPropertyValue | | public void setParamPropertyValue(String paramPropertyValue)(Code) | | Sets the property value parameter.
Parameters:
paramPropertyValue - the property value parameter to set |
| setParamResourcePath | | public void setParamResourcePath(String resourcePath)(Code) | | Sets the resource path.
Parameters:
resourcePath - the resource path to set |
| setParamSearchWord | | public void setParamSearchWord(String searchWord)(Code) | | Sets the search word to look up in the gallery items.
Parameters:
searchWord - the search word to look up in the gallery items |
| setResourceType | | public void setResourceType(CmsResourceTypeFolderExtended type)(Code) | | Sets the extended folder resource type this gallery is based on.
Parameters:
type - the extended folder resource type this gallery is based on |
| sortOptions | | protected int sortOptions(List options, List values)(Code) | | Sorts the options and associated values in alphabetical order.
Parameters:
options - a list of options
Parameters:
values - a list of associated values the new index of the currently selected option according to the new order |
| targetSelectBox | | public String targetSelectBox()(Code) | | Generates a HTML String representing a target select box.
a HTML String representing a target select box |
| wizardButton | | public String wizardButton()(Code) | | Builds the HTML for the wizard button.
the HTML for the wizard button |
| writeTitleProperty | | protected void writeTitleProperty(CmsResource res)(Code) | | Changes the value of the property title for the specified resource.
Parameters:
res - the resource to change the property value |
| Methods inherited from org.opencms.workplace.CmsDialog | public void actionCloseDialog() throws JspException(Code)(Java Doc)
protected String appendDelimiter(String attribute)(Code)(Java Doc)
public String buildAjaxResultContainer(String title)(Code)(Java Doc)
protected String buildAjaxWaitMessage()(Code)(Java Doc)
public String buildLockAdditionalOptions()(Code)(Java Doc)
public String buildLockConfirmationMessageJS()(Code)(Java Doc)
public String buildLockDialog() throws CmsException(Code)(Java Doc)
public String buildLockDialog(CmsLockFilter nonBlockingFilter, CmsLockFilter blockingFilter, int hiddenTimeout, boolean includeRelated) throws CmsException(Code)(Java Doc)
public String buildLockHeaderBox() throws CmsException(Code)(Java Doc)
protected boolean checkResourcePermissions(CmsPermissionSet required, boolean neededForFolder)(Code)(Java Doc)
protected boolean checkResourcePermissions(CmsPermissionSet required, boolean neededForFolder, CmsMessageContainer errorMessage)(Code)(Java Doc)
protected String computeCurrentFolder()(Code)(Java Doc)
public String dialog(int segment, String attributes)(Code)(Java Doc)
public String dialogBlock(int segment, String headline, boolean error)(Code)(Java Doc)
public String dialogBlockEnd()(Code)(Java Doc)
public String dialogBlockStart(String headline)(Code)(Java Doc)
public String dialogButtonRow(int segment)(Code)(Java Doc)
public String dialogButtonRowEnd()(Code)(Java Doc)
public String dialogButtonRowStart()(Code)(Java Doc)
public String dialogButtons(int[] buttons, String[] attributes)(Code)(Java Doc)
public String dialogButtonsClose()(Code)(Java Doc)
public String dialogButtonsClose(String closeAttribute)(Code)(Java Doc)
public String dialogButtonsCloseDetails(String closeAttribute, String detailsAttribute)(Code)(Java Doc)
protected void dialogButtonsHtml(StringBuffer result, int button, String attribute)(Code)(Java Doc)
public String dialogButtonsOk()(Code)(Java Doc)
public String dialogButtonsOk(String okAttribute)(Code)(Java Doc)
public String dialogButtonsOkCancel()(Code)(Java Doc)
public String dialogButtonsOkCancel(String okAttributes, String cancelAttributes)(Code)(Java Doc)
public String dialogButtonsOkCancelAdvanced(String okAttributes, String cancelAttributes, String advancedAttributes)(Code)(Java Doc)
public String dialogButtonsSetOkCancel(String setAttributes, String okAttributes, String cancelAttributes)(Code)(Java Doc)
public String dialogContent(int segment, String title)(Code)(Java Doc)
public String dialogContentEnd()(Code)(Java Doc)
public String dialogContentStart(String title)(Code)(Java Doc)
public String dialogEnd()(Code)(Java Doc)
public String dialogHead(String title)(Code)(Java Doc)
public String dialogHorizontalSpacer(int width)(Code)(Java Doc)
public String dialogLockButtons()(Code)(Java Doc)
public String dialogRow(int segment)(Code)(Java Doc)
public String dialogRowEnd()(Code)(Java Doc)
public String dialogRowStart()(Code)(Java Doc)
public String dialogScriptSubmit()(Code)(Java Doc)
public String dialogSeparator()(Code)(Java Doc)
public String dialogSpacer()(Code)(Java Doc)
public String dialogStart()(Code)(Java Doc)
public String dialogStart(String attributes)(Code)(Java Doc)
public String dialogSubheadline(String headline)(Code)(Java Doc)
public String dialogToggleStart(String headline, String id, boolean show)(Code)(Java Doc)
public String dialogWhiteBox(int segment)(Code)(Java Doc)
public String dialogWhiteBoxEnd()(Code)(Java Doc)
public String dialogWhiteBoxStart()(Code)(Java Doc)
public int getAction()(Code)(Java Doc)
protected String getAdministrationBackLink()(Code)(Java Doc)
public String getCancelAction()(Code)(Java Doc)
public String getDialogRealUri()(Code)(Java Doc)
public String getDialogUri()(Code)(Java Doc)
public String getOnlineHelpUriCustom()(Code)(Java Doc)
public String getParamAction()(Code)(Java Doc)
public String getParamCloseLink()(Code)(Java Doc)
public String getParamDialogtype()(Code)(Java Doc)
public String getParamFramename()(Code)(Java Doc)
public String getParamIsPopup()(Code)(Java Doc)
public String getParamMessage()(Code)(Java Doc)
public String getParamOriginalParams()(Code)(Java Doc)
public String getParamPreActionDone()(Code)(Java Doc)
public String getParamRedirect()(Code)(Java Doc)
public String getParamResource()(Code)(Java Doc)
public String getParamTitle()(Code)(Java Doc)
public String getState() throws CmsException(Code)(Java Doc)
public boolean hasCorrectLockstate()(Code)(Java Doc)
public boolean hasSiblings()(Code)(Java Doc)
public String htmlStart()(Code)(Java Doc)
public String htmlStart(String helpUrl)(Code)(Java Doc)
public String htmlStart(String helpUrl, String title)(Code)(Java Doc)
public String htmlStartStyle(String title, String stylesheet)(Code)(Java Doc)
public void includeErrorpage(CmsWorkplace wp, Throwable t) throws JspException(Code)(Java Doc)
public static CmsDialog initCmsDialog(PageContext context, HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request)(Code)(Java Doc)
public boolean isPopup()(Code)(Java Doc)
public boolean isPreEditor()(Code)(Java Doc)
public String pageHtml(int segment, String helpUrl)(Code)(Java Doc)
public String pageHtml(int segment, String helpUrl, String title)(Code)(Java Doc)
protected void setAction(int value)(Code)(Java Doc)
public void setOnlineHelpUriCustom(String uri)(Code)(Java Doc)
public void setParamAction(String value)(Code)(Java Doc)
public void setParamCloseLink(String value)(Code)(Java Doc)
public void setParamDialogtype(String value)(Code)(Java Doc)
public void setParamFramename(String value)(Code)(Java Doc)
public void setParamIsPopup(String value)(Code)(Java Doc)
public void setParamMessage(String value)(Code)(Java Doc)
public void setParamOriginalParams(String paramOriginalParams)(Code)(Java Doc)
public void setParamPreActionDone(String paramPreActionDone)(Code)(Java Doc)
public void setParamRedirect(String redirect)(Code)(Java Doc)
public void setParamResource(String value)(Code)(Java Doc)
public void setParamTitle(String value)(Code)(Java Doc)
|
|
|
|