|
|||||||
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.editors.CmsEditor
org.opencms.workplace.editors.CmsDefaultPageEditor
Provides methods for building editors for the CmsDefaultPage page type.
Extend this class for all editors that work with the CmsDefaultPage.
Field Summary | |
protected CmsFile |
m_file
File object used to read and write contents. |
protected CmsXmlPage |
m_page
Page object used from the action and init methods, be sure to initialize this e.g. in the initWorkplaceRequestValues method. |
static java.lang.String |
PARAM_ELEMENTNAME
Parameter name for the request parameter "element name". |
static java.lang.String |
PARAM_OLDELEMENTNAME
Parameter name for the request parameter "old element name". |
static java.lang.String[] |
SELECTBOX_FONTS
option values for font select boxes. |
static java.lang.String |
XML_BODY_ELEMENT
Name of the special body element from an XMLTemplate. |
Fields inherited from class org.opencms.workplace.editors.CmsEditor |
ACTION_CHANGE_BODY, ACTION_EXIT, ACTION_PREVIEW, ACTION_SAVE, ACTION_SAVEACTION, ACTION_SAVEEXIT, ACTION_SHOW, ACTION_SHOW_ERRORMESSAGE, EDITOR_CHANGE_ELEMENT, EDITOR_CLEANUP, EDITOR_EXIT, EDITOR_PREVIEW, EDITOR_SAVE, EDITOR_SAVEACTION, EDITOR_SAVEEXIT, EDITOR_SHOW, EDITOR_SHOW_ERRORMESSAGE, PARAM_BACKLINK, PARAM_CONTENT, PARAM_DIRECTEDIT, PARAM_EDITASTEXT, PARAM_EDITORMODE, PARAM_ELEMENTLANGUAGE, PARAM_LOADDEFAULT, PARAM_MODIFIED, PARAM_OLDELEMENTLANGUAGE, PARAM_TEMPFILE, PATH_EDITORS |
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog |
PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW |
Constructor Summary | |
CmsDefaultPageEditor(CmsJspActionElement jsp)
Public constructor. |
Method Summary | |
void |
actionChangeBodyElement()
Performs the change body action of the editor. |
void |
actionCleanupBodyElement()
Performs the cleanup body action of the editor. |
void |
actionClear(boolean forceUnlock)
Unlocks the edited resource when in direct edit mode or when the resource was not modified. |
void |
actionDirectEdit()
Performs a configurable action performed by the editor. |
void |
actionExit()
Performs the exit editor action and deletes the temporary file. |
void |
actionPreview()
Performs the preview page action in a new browser window. |
void |
actionSave()
Performs the save content action. |
abstract java.lang.String |
buildGalleryButtons(CmsEditorDisplayOptions options,
int buttonStyle,
java.util.Properties displayOptions)
Builds the html String for the gallery buttons. |
java.lang.String |
buildSelectElementLanguage(java.lang.String attributes)
Builds the html String for the element language selector. |
java.lang.String |
buildSelectElementName(java.lang.String attributes)
Builds the html String for the element name selector. |
java.lang.String |
buildSelectFonts(java.lang.String attributes)
Builds the html for the font face select box of a WYSIWYG editor. |
void |
escapeParams()
Escapes the content and title parameters to display them in the editor form. |
protected java.util.List |
getElementList()
Returns the list of active elements of the page. |
java.util.Locale |
getElementLocale()
Returns the current element locale. |
java.lang.String |
getParamElementname()
Returns the current element name. |
java.lang.String |
getParamOldelementname()
Returns the old element name. |
java.lang.String |
getUriStyleSheet()
Returns the OpenCms VFS uri of the style sheet of the current page. |
java.lang.String |
getUriTemplate()
Returns the OpenCms VFS uri of the template of the current page. |
protected void |
initBodyElementLanguage()
Initializes the body element language for the first call of the editor. |
protected void |
initBodyElementName(java.lang.String elementName)
Initializes the body element name of the editor. |
protected void |
initContent()
This method has to be called after initializing the body element name and language. |
protected void |
performSaveContent(java.lang.String body,
java.util.Locale locale)
Saves the editor content to the temporary file. |
protected abstract java.lang.String |
prepareContent(boolean save)
Manipulates the content String for different editor views and the save operation. |
void |
setParamElementname(java.lang.String elementName)
Sets the current element name. |
void |
setParamOldelementname(java.lang.String oldElementName)
Sets the old element name. |
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_ELEMENTNAME
public static final java.lang.String PARAM_OLDELEMENTNAME
public static final java.lang.String XML_BODY_ELEMENT
protected CmsFile m_file
protected CmsXmlPage m_page
public static final java.lang.String[] SELECTBOX_FONTS
Constructor Detail |
public CmsDefaultPageEditor(CmsJspActionElement jsp)
jsp
- an initialized JSP action elementMethod Detail |
public void actionChangeBodyElement()
public void actionCleanupBodyElement()
public void actionClear(boolean forceUnlock)
CmsEditor
actionClear
in class CmsEditor
forceUnlock
- if true, the resource will be unlocked anywayCmsEditor.actionClear(boolean)
public void actionDirectEdit() throws java.io.IOException, javax.servlet.jsp.JspException, javax.servlet.ServletException
The default action is: save resource, clear temporary files and publish the resource directly.
java.io.IOException
- if a forward fails
javax.servlet.jsp.JspException
- if including a JSP fails
javax.servlet.ServletException
- if a forward failspublic void actionExit() throws java.io.IOException, javax.servlet.jsp.JspException, javax.servlet.ServletException
actionExit
in class CmsEditor
javax.servlet.ServletException
- if a forward fails
javax.servlet.jsp.JspException
- if including an element fails
java.io.IOException
- if a forward failsCmsEditor.actionExit()
public void actionPreview() throws java.io.IOException, javax.servlet.jsp.JspException
java.io.IOException
- if redirect fails
javax.servlet.jsp.JspException
- if inclusion of error page failspublic void actionSave() throws javax.servlet.jsp.JspException
CmsEditor
actionSave
in class CmsEditor
javax.servlet.jsp.JspException
- if including an element failsCmsEditor.actionSave()
public abstract java.lang.String buildGalleryButtons(CmsEditorDisplayOptions options, int buttonStyle, java.util.Properties displayOptions)
options
- the display configuration for the editorbuttonStyle
- the style for the buttonsdisplayOptions
- the display options for the editor
public java.lang.String buildSelectElementLanguage(java.lang.String attributes)
attributes
- optional attributes for the <select> tag
public java.lang.String buildSelectElementName(java.lang.String attributes)
attributes
- optional attributes for the <select> tag
public java.lang.String buildSelectFonts(java.lang.String attributes)
attributes
- optional attributes for the <select> tag
public void escapeParams()
This method has to be called on the JSP right before the form display html is created.
*
public java.util.Locale getElementLocale()
public java.lang.String getParamElementname()
public java.lang.String getParamOldelementname()
public java.lang.String getUriStyleSheet()
public java.lang.String getUriTemplate()
public void setParamElementname(java.lang.String elementName)
elementName
- the current element namepublic void setParamOldelementname(java.lang.String oldElementName)
oldElementName
- the old element nameprotected java.util.List getElementList()
protected void initBodyElementLanguage()
protected void initBodyElementName(java.lang.String elementName)
This has to be called after the element language has been set with setParamBodylanguage().
elementName
- the name of the element to initialize or null, if default element should be usedprotected void initContent()
initContent
in class CmsEditor
CmsEditor.initContent()
protected void performSaveContent(java.lang.String body, java.util.Locale locale) throws CmsException
body
- the body name to writelocale
- the body locale to write
CmsException
- if writing the file failsprotected abstract java.lang.String prepareContent(boolean save)
save
- if set to true, the result String is not escaped and the content parameter is not updated
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |