Package org.opencms.ui.editors
Class A_CmsFrameEditor
- java.lang.Object
-
- org.opencms.ui.editors.A_CmsFrameEditor
-
- All Implemented Interfaces:
com.vaadin.navigator.ViewChangeListener
,java.io.Serializable
,I_CmsEditor
- Direct Known Subclasses:
CmsAcaciaEditor
,CmsXmlContentEditor
,CmsXmlPageEditor
public abstract class A_CmsFrameEditor extends java.lang.Object implements I_CmsEditor, com.vaadin.navigator.ViewChangeListener
Class to extended by frame based editors.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected CmsEditorStateExtension
m_editorState
The editor state.
-
Constructor Summary
Constructors Constructor Description A_CmsFrameEditor()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
boolean
beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
protected abstract java.lang.String
getEditorUri()
Returns the editor URI.void
initUI(I_CmsAppUIContext context, CmsResource resource, java.lang.String backLink, java.util.Map<java.lang.String,java.lang.String> params)
Within this method the editor UI should be initialized.boolean
matchesResource(CmsObject cms, CmsResource resource, boolean plainText)
Checks whether the editor is available for the given resource.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.opencms.ui.editors.I_CmsEditor
getPriority, matchesType, newInstance
-
-
-
-
Field Detail
-
m_editorState
protected CmsEditorStateExtension m_editorState
The editor state.
-
-
Constructor Detail
-
A_CmsFrameEditor
public A_CmsFrameEditor()
-
-
Method Detail
-
afterViewChange
public void afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
- Specified by:
afterViewChange
in interfacecom.vaadin.navigator.ViewChangeListener
- See Also:
ViewChangeListener.afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent)
-
beforeViewChange
public boolean beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
- Specified by:
beforeViewChange
in interfacecom.vaadin.navigator.ViewChangeListener
- See Also:
ViewChangeListener.beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent)
-
initUI
public void initUI(I_CmsAppUIContext context, CmsResource resource, java.lang.String backLink, java.util.Map<java.lang.String,java.lang.String> params)
Description copied from interface:I_CmsEditor
Within this method the editor UI should be initialized.Use the context to add the app's components to the UI.
- Specified by:
initUI
in interfaceI_CmsEditor
- Parameters:
context
- the UI contextresource
- the resource to editbackLink
- the link to return to when closing the editorparams
- optional parameters- See Also:
I_CmsEditor.initUI(org.opencms.ui.apps.I_CmsAppUIContext, org.opencms.file.CmsResource, java.lang.String, java.util.Map)
-
matchesResource
public boolean matchesResource(CmsObject cms, CmsResource resource, boolean plainText)
Description copied from interface:I_CmsEditor
Checks whether the editor is available for the given resource.- Specified by:
matchesResource
in interfaceI_CmsEditor
- Parameters:
cms
- the CMS contextresource
- the resource to editplainText
- if plain text editing is required- Returns:
true
if the editor is available for the given resource- See Also:
I_CmsEditor.matchesResource(org.opencms.file.CmsObject, org.opencms.file.CmsResource, boolean)
-
getEditorUri
protected abstract java.lang.String getEditorUri()
Returns the editor URI.- Returns:
- the editor URI
-
-