Package org.opencms.ui.apps

Class CmsEditor

java.lang.Object

org.opencms.ui.apps.CmsEditor

All Implemented Interfaces:

com.vaadin.navigator.ViewChangeListener, Serializable, I_CmsHasShortcutActions, I_CmsWorkplaceApp, I_CmsWindowCloseListener

public class CmsEditor
extends Object
implements I_CmsWorkplaceApp, com.vaadin.navigator.ViewChangeListener, I_CmsWindowCloseListener, I_CmsHasShortcutActions

The editor app. Will open the appropriate editor for a resource.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.navigator.ViewChangeListener

com.vaadin.navigator.ViewChangeListener.ViewChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BACK_LINK_PREFIX	The back link prefix.
static final String	PLAIN_TEXT_PREFIX	The back link prefix.
static final String	RESOURCE_ID_PREFIX	The resource id state prefix.
static final String	RESOURCE_PATH_PREFIX	The resource id state prefix.

Constructor Summary

Constructors

Constructor	Description
CmsEditor()

Method Summary

Modifier and Type	Method	Description
void	afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
boolean	beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
static String	getEditLink(CmsUUID structureId, boolean plainText, String backLink)	Returns the edit link for given resource structure id.
static String	getEditState(CmsUUID structureId, boolean plainText, String backLink)	Returns the edit state for the given resource structure id.
static String	getEditStateForNew(CmsObject cms, I_CmsResourceType resourceType, String contextPath, String modelFilePath, boolean plainText, String backLink)	Returns the edit state for the given resource structure id.
Map<com.vaadin.event.Action,Runnable>	getShortcutActions()	Returns the shortcut actions.
void	initUI(I_CmsAppUIContext context)	Within this method the app UI should be initialized.
void	onStateChange(String state)	Called on navigation events.
void	onWindowClose()	Executed on window close.
static void	openBackLink(String backlink)	Navigates to the back link target.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

BACK_LINK_PREFIX

public static final String BACK_LINK_PREFIX

The back link prefix.

See Also:

• Constant Field Values

PLAIN_TEXT_PREFIX

public static final String PLAIN_TEXT_PREFIX

The back link prefix.

See Also:

• Constant Field Values

RESOURCE_ID_PREFIX

public static final String RESOURCE_ID_PREFIX

The resource id state prefix.

See Also:

• Constant Field Values

RESOURCE_PATH_PREFIX

public static final String RESOURCE_PATH_PREFIX

The resource id state prefix.

See Also:

• Constant Field Values

Constructor Details

CmsEditor

public CmsEditor()

Method Details

getEditLink

public static String getEditLink(CmsUUID structureId,
 boolean plainText,
 String backLink)

Returns the edit link for given resource structure id.

Parameters:

structureId - the resource structure is

plainText - if plain text/source editing is required

backLink - the back link location

Returns:

the state

getEditState

public static String getEditState(CmsUUID structureId,
 boolean plainText,
 String backLink)

Returns the edit state for the given resource structure id.

Parameters:

structureId - the resource structure id

plainText - if plain text/source editing is required

backLink - the back link location

Returns:

the state

getEditStateForNew

public static String getEditStateForNew(CmsObject cms,
 I_CmsResourceType resourceType,
 String contextPath,
 String modelFilePath,
 boolean plainText,
 String backLink)

Returns the edit state for the given resource structure id.

Parameters:

cms - the cms context

resourceType - the resource type to create

contextPath - the context path

modelFilePath - the model file path

plainText - if plain text/source editing is required

backLink - the back link location

Returns:

the state

openBackLink

public static void openBackLink(String backlink)

Navigates to the back link target.

Parameters:

backlink - the back link

afterViewChange

public void afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)

Specified by:

afterViewChange in interface com.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 interface com.vaadin.navigator.ViewChangeListener

See Also:

• ViewChangeListener.beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent)

getShortcutActions

public Map<com.vaadin.event.Action,Runnable> getShortcutActions()

Description copied from interface: I_CmsHasShortcutActions

Returns the shortcut actions.

Specified by:

getShortcutActions in interface I_CmsHasShortcutActions

Returns:

the shortcut actions

See Also:

• I_CmsHasShortcutActions.getShortcutActions()

initUI

public void initUI(I_CmsAppUIContext context)

Description copied from interface: I_CmsWorkplaceApp

Within this method the app UI should be initialized.

Use the context to add the app's components to the UI.

Specified by:

initUI in interface I_CmsWorkplaceApp

Parameters:

context - the UI context

See Also:

• I_CmsWorkplaceApp.initUI(org.opencms.ui.apps.I_CmsAppUIContext)

onStateChange

public void onStateChange(String state)

Description copied from interface: I_CmsWorkplaceApp

Called on navigation events.

Specified by:

onStateChange in interface I_CmsWorkplaceApp

Parameters:

state - the app state to show

See Also:

• I_CmsWorkplaceApp.onStateChange(java.lang.String)

onWindowClose

public void onWindowClose()

Description copied from interface: I_CmsWindowCloseListener

Executed on window close.

Specified by:

onWindowClose in interface I_CmsWindowCloseListener

See Also:

• I_CmsWindowCloseListener.onWindowClose()