|
|||||||
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.CmsMultiDialog
org.opencms.workplace.commons.CmsLock
Creates the dialogs for locking, unlocking or steal lock operations on a resource.
The following files use this class:
Field Summary | |
static int |
ACTION_SUBMIT_NOCONFIRMATION
Value for the action: confirmed. |
static java.lang.String |
DIALOG_SUBMIT_NOCONFIRMATION
Request parameter value for the action: submit form without user interaction. |
static java.lang.String |
DIALOG_TYPE_LOCK
The dialog type: lock a resource. |
static java.lang.String |
DIALOG_TYPE_LOCKCHANGE
The dialog type: Steal a lock. |
static java.lang.String |
DIALOG_TYPE_UNLOCK
The dialog type: unlock a resource. |
static int |
TYPE_LOCK
Type of the operation which is performed: lock resource. |
static int |
TYPE_LOCKCHANGE
Type of the operation which is performed: steal a lock. |
static int |
TYPE_UNLOCK
Type of the operation which is performed: unlock resource. |
static java.lang.String |
URI_LOCK_DIALOG
The lock dialog URI. |
static java.lang.String |
URI_LOCKCHANGE_DIALOG
The steal lock dialog URI. |
static java.lang.String |
URI_UNLOCK_DIALOG
The unlock dialog URI. |
Fields inherited from class org.opencms.workplace.CmsMultiDialog |
DELIMITER_RESOURCES, PARAM_RESOURCELIST |
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog |
PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW |
Constructor Summary | |
CmsLock()
Default constructor needed for dialog handler implementation. |
|
CmsLock(CmsJspActionElement jsp)
Public constructor. |
|
CmsLock(javax.servlet.jsp.PageContext context,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables. |
Method Summary | |
void |
actionToggleLock()
Performs the lock/unlock operation, will be called by the JSP page. |
java.lang.String |
buildDialogText()
Builds the HTML for the text that is shown on the confirmation dialog depending on the selected resource(s). |
static int |
getDialogAction(CmsObject cms)
Determines if the resource should be locked, unlocked or if the lock should be stolen. |
java.lang.String |
getDialogHandler()
Returns the name of the handler which is used as key for the OpenCms runtime properties. |
java.lang.String |
getDialogUri(java.lang.String resource,
CmsJspActionElement jsp)
Returns the dialog URI in the OpenCms VFS to the dialog selector class. |
boolean |
hasLockedSubResources()
Returns true if the resources to lock have locked subresources. |
protected void |
initWorkplaceRequestValues(CmsWorkplaceSettings settings,
javax.servlet.http.HttpServletRequest request)
Analyzes the request for workplace parameters and adjusts the workplace settings accordingly. |
protected boolean |
performDialogOperation()
Performs the lock/unlock/steal lock operation. |
protected void |
performSingleResourceOperation(java.lang.String resourceName,
int dialogAction)
Performs the lock state operation on a single resource. |
void |
setHasLockedSubResources(boolean hasLockedSubResources)
Sets if the resources to lock have locked subresources. |
boolean |
showConfirmation()
Determines whether to show the lock dialog depending on the users settings and the dilaog type. |
Methods inherited from class org.opencms.workplace.CmsMultiDialog |
addMultiOperationException, buildResourceList, checkMultiOperationException, checkResourcePermissions, getParamResourcelist, getResourceList, isMultiOperation, isOperationOnFolder, setDialogTitle, setParamResourcelist |
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 int ACTION_SUBMIT_NOCONFIRMATION
public static final java.lang.String DIALOG_SUBMIT_NOCONFIRMATION
public static final java.lang.String DIALOG_TYPE_LOCK
public static final java.lang.String DIALOG_TYPE_LOCKCHANGE
public static final java.lang.String DIALOG_TYPE_UNLOCK
public static final int TYPE_LOCK
public static final int TYPE_LOCKCHANGE
public static final int TYPE_UNLOCK
public static final java.lang.String URI_LOCK_DIALOG
public static final java.lang.String URI_LOCKCHANGE_DIALOG
public static final java.lang.String URI_UNLOCK_DIALOG
Constructor Detail |
public CmsLock()
public CmsLock(CmsJspActionElement jsp)
jsp
- an initialized JSP action elementpublic CmsLock(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 static int getDialogAction(CmsObject cms)
cms
- the CmsObject
public void actionToggleLock() throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException
- if problems including sub-elements occurpublic java.lang.String buildDialogText()
public java.lang.String getDialogHandler()
I_CmsDialogHandler
Store the name of the key as a public String constant in the CmsDialogSelector class.
getDialogHandler
in interface I_CmsDialogHandler
I_CmsDialogHandler.getDialogHandler()
public java.lang.String getDialogUri(java.lang.String resource, CmsJspActionElement jsp)
I_CmsDialogHandler
getDialogUri
in interface I_CmsDialogHandler
resource
- the selected resourcejsp
- the CmsJspActionElement
I_CmsDialogHandler.getDialogUri(java.lang.String, CmsJspActionElement)
public boolean hasLockedSubResources()
public void setHasLockedSubResources(boolean hasLockedSubResources)
hasLockedSubResources
- if the resources to lock have locked subresourcespublic boolean showConfirmation()
In case of locking a folder, a confirmation dialog is needed if any sub resources are already locked.
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
CmsWorkplace
initWorkplaceRequestValues
in class CmsDialog
CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
protected boolean performDialogOperation() throws CmsException
performDialogOperation
in class CmsMultiDialog
CmsException
- if operation is not successfulprotected void performSingleResourceOperation(java.lang.String resourceName, int dialogAction) throws CmsException
resourceName
- the resource name to perform the operation ondialogAction
- the lock action: lock, unlock or change lock
CmsException
- if the operation fails
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |