|
|||||||
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.explorer.CmsNewResource
The new resource entry dialog which displays the possible "new actions" for the current user.
It handles the creation of "simple" resource types like plain or JSP resources.
The following files use this class:
Field Summary | |
static int |
ACTION_NEWFORM
The value for the resource name form action. |
static int |
ACTION_SUBMITFORM
The value for the resource name form submission action. |
static int |
BUTTON_NEXT
Constant for the "Next" button in the build button methods. |
static char |
DELIM_PROPERTYVALUES
Delimiter for property values, e.g. for available resource types or template sites. |
static java.lang.String |
DIALOG_ADVANCED
The name for the advanced resource form action. |
static java.lang.String |
DIALOG_NEWFORM
The name for the resource form action. |
static java.lang.String |
DIALOG_SUBMITFORM
The name for the resource form submission action. |
static java.lang.String |
DIALOG_TYPE
The dialog type. |
static java.lang.String |
PARAM_APPENDSUFFIXHTML
Request parameter name for the append html suffix checkbox. |
static java.lang.String |
PARAM_CURRENTFOLDER
Request parameter name for the current folder name. |
static java.lang.String |
PARAM_NEWRESOURCEEDITPROPS
Request parameter name for the new resource edit properties flag. |
static java.lang.String |
PARAM_NEWRESOURCETYPE
Request parameter name for the new resource type. |
static java.lang.String |
PARAM_NEWRESOURCEURI
Request parameter name for the new resource uri. |
static java.lang.String |
VALUE_DEFAULT
The property value for available resource to reset behaviour to default dialog. |
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog |
PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW |
Constructor Summary | |
CmsNewResource(CmsJspActionElement jsp)
Public constructor with JSP action element. |
|
CmsNewResource(javax.servlet.jsp.PageContext context,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables. |
Method Summary | |
void |
actionCreateResource()
Creates the resource using the specified resource name and the newresourcetype parameter. |
void |
actionEditProperties()
Forwards to the property dialog if the resourceeditprops parameter is true. |
void |
actionSelect()
Forwards to the next page of the new resource wizard after selecting the new resource type. |
protected java.lang.String |
appendSuffixHtml(java.lang.String resourceName,
boolean forceSuffix)
Appends a ".html" suffix to the given resource name if no suffix is present and the append suffix option is checked. |
java.lang.String |
buildNewList(java.lang.String attributes)
Builds the html for the list of possible new resources. |
protected java.lang.String |
computeCurrentFolder()
Returns the full path of the current workplace folder. |
protected java.lang.String |
computeFullResourceName()
Appends the full path to the new resource name given in the resource parameter. |
java.lang.String |
computeNewTitleProperty()
Returns the value for the Title property from the given resource name. |
protected CmsProperty |
createPropertyObject(java.lang.String name,
java.lang.String value)
Creates a single property object and sets the value individual or shared depending on the OpenCms settings. |
protected java.util.List |
createResourceProperties(java.lang.String resourceName,
java.lang.String resTypeName,
java.lang.String title)
Returns the properties to create automatically with the new VFS resource. |
java.lang.String |
dialogButtonsAdvancedNextCancel(java.lang.String advancedAttrs,
java.lang.String nextAttrs,
java.lang.String cancelAttrs)
Builds a button row with an optional "advanced", "next" and a "cancel" button. |
protected void |
dialogButtonsHtml(java.lang.StringBuffer result,
int button,
java.lang.String attribute)
Renders the HTML for a single input button of a specified type. |
java.lang.String |
dialogButtonsNextCancel(java.lang.String nextAttrs,
java.lang.String cancelAttrs)
Builds a button row with a "next" and a "cancel" button. |
static java.lang.Object |
getNewResourceHandler(java.lang.String type,
java.lang.String defaultClassName,
javax.servlet.jsp.PageContext context,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
A factory to return handlers to create new resources. |
java.lang.String |
getParamAppendSuffixHtml()
Returns the parameter to check if a ".html" suffix should be added to the new resource name. |
java.lang.String |
getParamCurrentFolder()
Returns the current folder set by the http request. |
java.lang.String |
getParamNewResourceEditProps()
Returns the new resource edit properties flag parameter. |
java.lang.String |
getParamNewResourceType()
Returns the new resource type parameter. |
java.lang.String |
getParamNewResourceUri()
Returns the new resource URI parameter. |
java.lang.String |
getParamPage()
Returns the paramPage. |
protected void |
initWorkplaceRequestValues(CmsWorkplaceSettings settings,
javax.servlet.http.HttpServletRequest request)
Analyzes the request for workplace parameters and adjusts the workplace settings accordingly. |
boolean |
isResourceCreated()
Returns true if the resource is created successfully; otherwise false. |
void |
setParamAppendSuffixHtml(java.lang.String paramAppendSuffixHtml)
Sets the parameter to check if a ".html" suffix should be added to the new resource name. |
void |
setParamCurrentFolder(java.lang.String paramCurrentFolder)
Sets the current folder. |
void |
setParamNewResourceEditProps(java.lang.String newResourceEditProps)
Sets the new resource edit properties flag parameter. |
void |
setParamNewResourceType(java.lang.String newResourceType)
Sets the new resource type parameter. |
void |
setParamNewResourceUri(java.lang.String newResourceUri)
Sets the new resource URI parameter. |
void |
setParamPage(java.lang.String paramPage)
Sets the paramPage. |
void |
setResourceCreated(boolean successfullyCreated)
Sets the boolean flag successfullyCreated. |
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_NEWFORM
public static final int ACTION_SUBMITFORM
public static final int BUTTON_NEXT
public static final char DELIM_PROPERTYVALUES
public static final java.lang.String DIALOG_ADVANCED
public static final java.lang.String DIALOG_NEWFORM
public static final java.lang.String DIALOG_SUBMITFORM
public static final java.lang.String DIALOG_TYPE
public static final java.lang.String PARAM_APPENDSUFFIXHTML
public static final java.lang.String PARAM_CURRENTFOLDER
public static final java.lang.String PARAM_NEWRESOURCEEDITPROPS
public static final java.lang.String PARAM_NEWRESOURCETYPE
public static final java.lang.String PARAM_NEWRESOURCEURI
public static final java.lang.String VALUE_DEFAULT
Constructor Detail |
public CmsNewResource(CmsJspActionElement jsp)
jsp
- an initialized JSP action elementpublic CmsNewResource(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 java.lang.Object getNewResourceHandler(java.lang.String type, java.lang.String defaultClassName, javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) throws CmsRuntimeException
type
- the resource type name to get a new resource handler for, as specified in the explorer type settingsdefaultClassName
- a default handler class name, to be used if the handler class specified in the explorer type settings cannot be foundcontext
- the JSP page contextreq
- the JSP requestres
- the JSP response
CmsRuntimeException
- if something goes wrongpublic void actionCreateResource() throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException
- if inclusion of error dialog failspublic void actionEditProperties() throws java.io.IOException, javax.servlet.jsp.JspException, javax.servlet.ServletException
If the parameter is not true, the dialog will be closed.
java.io.IOException
- if forwarding to the property dialog fails
javax.servlet.ServletException
- if forwarding to the property dialog fails
javax.servlet.jsp.JspException
- if an inclusion failspublic void actionSelect() throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
- if forwarding fails
javax.servlet.ServletException
- if forwarding failspublic java.lang.String buildNewList(java.lang.String attributes)
attributes
- optional attributes for the radio input tags
public java.lang.String computeNewTitleProperty()
Additionally translates the new resource name according to the file translation rules.
public java.lang.String dialogButtonsAdvancedNextCancel(java.lang.String advancedAttrs, java.lang.String nextAttrs, java.lang.String cancelAttrs)
advancedAttrs
- optional attributes for the advanced buttonnextAttrs
- optional attributes for the next buttoncancelAttrs
- optional attributes for the cancel button
public java.lang.String dialogButtonsNextCancel(java.lang.String nextAttrs, java.lang.String cancelAttrs)
nextAttrs
- optional attributes for the next buttoncancelAttrs
- optional attributes for the cancel button
public java.lang.String getParamAppendSuffixHtml()
public java.lang.String getParamCurrentFolder()
If the request parameter value is null/empty then returns the default computed folder.
public java.lang.String getParamNewResourceEditProps()
public java.lang.String getParamNewResourceType()
public java.lang.String getParamNewResourceUri()
public java.lang.String getParamPage()
public boolean isResourceCreated()
public void setParamAppendSuffixHtml(java.lang.String paramAppendSuffixHtml)
paramAppendSuffixHtml
- the parameter to check if a ".html" suffix should be added to the new resource namepublic void setParamCurrentFolder(java.lang.String paramCurrentFolder)
paramCurrentFolder
- the current folder to setpublic void setParamNewResourceEditProps(java.lang.String newResourceEditProps)
newResourceEditProps
- the new resource edit properties flag parameterpublic void setParamNewResourceType(java.lang.String newResourceType)
newResourceType
- the new resource type parameterpublic void setParamNewResourceUri(java.lang.String newResourceUri)
newResourceUri
- the new resource URI parameterpublic void setParamPage(java.lang.String paramPage)
paramPage
- the paramPage to setpublic void setResourceCreated(boolean successfullyCreated)
successfullyCreated
- a boolean flag that indicates if the create resource operation was successfull or notprotected java.lang.String appendSuffixHtml(java.lang.String resourceName, boolean forceSuffix)
resourceName
- the resource name to checkforceSuffix
- if true, the suffix is appended overriding the append suffix option
protected java.lang.String computeCurrentFolder()
protected java.lang.String computeFullResourceName()
protected CmsProperty createPropertyObject(java.lang.String name, java.lang.String value)
name
- the name of the propertyvalue
- the value to set
protected java.util.List createResourceProperties(java.lang.String resourceName, java.lang.String resTypeName, java.lang.String title)
If configured, the Title and Navigation properties are set on resource creation.
resourceName
- the full resource nameresTypeName
- the name of the resource typetitle
- the Title String to use for the property values
protected void dialogButtonsHtml(java.lang.StringBuffer result, int button, java.lang.String attribute)
CmsDialog
dialogButtonsHtml
in class CmsDialog
result
- a string buffer where the rendered HTML gets appended tobutton
- a integer key to identify the buttonattribute
- an optional string with possible tag attributes, or nullCmsDialog.dialogButtonsHtml(java.lang.StringBuffer, int, java.lang.String)
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)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |