|
||||||
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.CmsPublishProject
public class CmsPublishProject
Creates the dialogs for publishing a project or a resource.
The following files use this class:
Field Summary | |
---|---|
static int |
ACTION_PUBLISH
Value for the action: delete the resource. |
static int |
ACTION_RESOURCES_CONFIRMED
Value for the action: resources confirmed. |
static java.lang.String |
DIALOG_RESOURCES_CONFIRMED
Request parameter value for the action: dialog resources confirmed. |
static java.lang.String |
DIALOG_TYPE
The dialog type. |
static java.lang.String |
PARAM_PUBLISHSIBLINGS
Request parameter name for the publishsiblings parameter. |
static java.lang.String |
PARAM_RELATEDRESOURCES
Request parameter name for the relatedresources parameter. |
static java.lang.String |
PARAM_SUBRESOURCES
Request parameter name for the subresources parameter. |
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 | |
---|---|
CmsPublishProject(CmsJspActionElement jsp)
Public constructor. |
|
CmsPublishProject(javax.servlet.jsp.PageContext context,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables. |
Method Summary | |
---|---|
void |
actionPublish()
Performs the publish action, will be called by the JSP page. |
java.lang.String |
buildConfirmation()
Returns the html for the confirmation message. |
java.lang.String |
buildLockConfirmationMessageJS()
Returns the html code to build the confirmation messages. |
java.lang.String |
buildLockDialog()
Returns the html code to build the lock dialog. |
java.lang.String |
buildLockHeaderBox()
Returns the html code to build the header box. |
java.lang.String |
buildPublishOptions()
Override to display additional options in the lock dialog. |
java.lang.String |
buildReport()
Returns html code for the possible broken relations. |
java.lang.String |
buildResourcesReport()
Returns html code for the list of resources to be published. |
java.lang.String |
getParamDirectpublish()
Returns if a resource will be directly published. |
java.lang.String |
getParamProjectid()
Returns the value of the project id which will be published. |
java.lang.String |
getParamProjectname()
Returns the value of the project name which will be published. |
java.lang.String |
getParamPublishsiblings()
Returns if siblings of the resource should be published. |
java.lang.String |
getParamRelatedresources()
Returns the value of the related resources parameter. |
java.lang.String |
getParamSubresources()
Returns the value of the subresources parameter. |
CmsPublishList |
getPublishList()
Unlocks all selected resources, will be called by the JSP page. |
boolean |
hasBrokenLinks()
Returns true if the resources to be published will generate broken links. |
protected void |
initWorkplaceRequestValues(CmsWorkplaceSettings settings,
javax.servlet.http.HttpServletRequest request)
Analyzes the request for workplace parameters and adjusts the workplace settings accordingly. |
boolean |
isCanPublish()
Returns true if the current user is allowed
to publish the selected resources. |
boolean |
isLockStateOk()
Returns true if the selection has blocking locks. |
protected boolean |
performDialogOperation()
Performs the dialog operation for the selected resources. |
void |
setParamDirectpublish(java.lang.String value)
Sets if a resource will be directly published. |
void |
setParamProjectid(java.lang.String value)
Sets the value of the project id which will be published. |
void |
setParamProjectname(java.lang.String value)
Sets the value of the project name which will be published. |
void |
setParamPublishsiblings(java.lang.String value)
Sets if siblings of the resource should be published. |
void |
setParamRelatedresources(java.lang.String relatedResources)
Sets the value of the related resources parameter. |
void |
setParamSubresources(java.lang.String paramSubresources)
Sets the value of the subresources parameter. |
Methods inherited from class org.opencms.workplace.CmsMultiDialog |
---|
addMultiOperationException, buildResourceList, checkMultiOperationException, checkResourcePermissions, getParamResourcelist, getResourceList, getResourceListAsParam, isMultiOperation, isOperationOnFolder, setDialogTitle, setParamResource, 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_PUBLISH
public static final int ACTION_RESOURCES_CONFIRMED
public static final java.lang.String DIALOG_RESOURCES_CONFIRMED
public static final java.lang.String DIALOG_TYPE
public static final java.lang.String PARAM_PUBLISHSIBLINGS
public static final java.lang.String PARAM_SUBRESOURCES
public static final java.lang.String PARAM_RELATEDRESOURCES
Constructor Detail |
---|
public CmsPublishProject(CmsJspActionElement jsp)
jsp
- an initialized JSP action elementpublic CmsPublishProject(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 void actionPublish() throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException
- if problems including sub-elements occurpublic java.lang.String buildConfirmation()
public java.lang.String buildLockConfirmationMessageJS()
buildLockConfirmationMessageJS
in class CmsDialog
public java.lang.String buildLockDialog() throws CmsException
buildLockDialog
in class CmsDialog
CmsException
- if something goes wrongpublic java.lang.String buildLockHeaderBox() throws CmsException
CmsDialog
buildLockHeaderBox
in class CmsMultiDialog
CmsException
- if something goes wrongCmsMultiDialog.buildLockHeaderBox()
public java.lang.String buildPublishOptions()
public java.lang.String buildReport()
public java.lang.String buildResourcesReport() throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException
- if creation of publish list failspublic java.lang.String getParamDirectpublish()
"true"
if a resource will be directly publishedpublic java.lang.String getParamProjectid()
public java.lang.String getParamProjectname()
public java.lang.String getParamPublishsiblings()
"true"
(String) if siblings of the resource should be publishedpublic java.lang.String getParamSubresources()
public java.lang.String getParamRelatedresources()
public CmsPublishList getPublishList() throws javax.servlet.jsp.JspException
true
if everything went ok
javax.servlet.jsp.JspException
- if there is some problem including the error pagepublic boolean hasBrokenLinks()
true
if the resources to be published will generate broken links.
true
if the resources to be published will generate broken linkspublic boolean isCanPublish()
true
if the current user is allowed
to publish the selected resources.
true
if the current user is allowed
to publish the selected resourcespublic boolean isLockStateOk()
true
if the selection has blocking locks.
true
if the selection has blocking lockspublic void setParamDirectpublish(java.lang.String value)
value
- "true"
(String) if a resource will be directly publishedpublic void setParamProjectid(java.lang.String value)
value
- the String value of the project idpublic void setParamProjectname(java.lang.String value)
value
- the String value of the project namepublic void setParamPublishsiblings(java.lang.String value)
value
- "true"
(String) if siblings of the resource should be publishedpublic void setParamSubresources(java.lang.String paramSubresources)
paramSubresources
- the value of the subresources parameterpublic void setParamRelatedresources(java.lang.String relatedResources)
relatedResources
- the value of the related resources parameterprotected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
CmsWorkplace
initWorkplaceRequestValues
in class CmsDialog
settings
- the workplace settingsrequest
- the current requestCmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
protected boolean performDialogOperation() throws CmsException
CmsMultiDialog
performDialogOperation
in class CmsMultiDialog
CmsException
- if operation was not successfulCmsMultiDialog.performDialogOperation()
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |