Package org.opencms.ui.editors.messagebundle

Class CmsMessageBundleEditor

java.lang.Object

org.opencms.ui.editors.messagebundle.CmsMessageBundleEditor

All Implemented Interfaces:

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

public class CmsMessageBundleEditor
extends Object
implements I_CmsEditor, I_CmsWindowCloseListener, com.vaadin.navigator.ViewChangeListener, I_CmsHasShortcutActions

Controller for the VAADIN UI of the Message Bundle Editor.

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	PARAM_KEYFILTER	Name of the keyfilter parameter.

Constructor Summary

Constructors

Constructor	Description
CmsMessageBundleEditor()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
boolean	beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
int	getPriority()	Gets the priority.
Map<com.vaadin.event.Action,Runnable>	getShortcutActions()	Returns the shortcut actions.
boolean	handleAddKey(String newKey)
void	handleEntryChange(org.opencms.ui.editors.messagebundle.CmsMessageBundleEditorTypes.EntryChangeEvent event)
boolean	handleItemDeletion(org.opencms.ui.editors.messagebundle.CmsMessageBundleEditorTypes.ItemDeletionEvent e)
void	handleLanguageChange(Locale locale)
void	handleModeChange(org.opencms.ui.editors.messagebundle.CmsMessageBundleEditorTypes.EditMode mode)
void	initUI(I_CmsAppUIContext context, CmsResource resource, String backLink, Map<String,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.
boolean	matchesType(I_CmsResourceType type, boolean plainText)	Checks whether the editor is available for the given resource type.
I_CmsEditor	newInstance()	Returns a new editor instance.
void	onWindowClose()	Executed on window close.

Methods inherited from class java.lang.Object

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

Field Details

PARAM_KEYFILTER

public static final String PARAM_KEYFILTER

Name of the keyfilter parameter.

See Also:

• Constant Field Values

Constructor Details

CmsMessageBundleEditor

public CmsMessageBundleEditor()

Default constructor.

Method Details

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)

getPriority

public int getPriority()

Description copied from interface: I_CmsEditor

Gets the priority.

If multiple editors for the same resource type are available, the one with the highest priority will be picked.

Specified by:

getPriority in interface I_CmsEditor

Returns:

the priority

See Also:

• I_CmsEditor.getPriority()

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()

handleAddKey

public boolean handleAddKey(String newKey)

See Also:

• CmsMessageBundleEditorTypes.I_OptionListener.handleAddKey(java.lang.String)

handleEntryChange

public void handleEntryChange(org.opencms.ui.editors.messagebundle.CmsMessageBundleEditorTypes.EntryChangeEvent event)

See Also:

• CmsMessageBundleEditorTypes.I_EntryChangeListener.handleEntryChange(org.opencms.ui.editors.messagebundle.CmsMessageBundleEditorTypes.EntryChangeEvent)

handleItemDeletion

public boolean handleItemDeletion(org.opencms.ui.editors.messagebundle.CmsMessageBundleEditorTypes.ItemDeletionEvent e)

See Also:

• CmsMessageBundleEditorTypes.I_ItemDeletionListener.handleItemDeletion(org.opencms.ui.editors.messagebundle.CmsMessageBundleEditorTypes.ItemDeletionEvent)

handleLanguageChange

public void handleLanguageChange(Locale locale)

See Also:

• CmsMessageBundleEditorTypes.I_OptionListener.handleLanguageChange(java.util.Locale)

handleModeChange

public void handleModeChange(org.opencms.ui.editors.messagebundle.CmsMessageBundleEditorTypes.EditMode mode)

See Also:

• CmsMessageBundleEditorTypes.I_OptionListener.handleModeChange(org.opencms.ui.editors.messagebundle.CmsMessageBundleEditorTypes.EditMode)

initUI

public void initUI(I_CmsAppUIContext context,
 CmsResource resource,
 String backLink,
 Map<String,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 interface I_CmsEditor

Parameters:

context - the UI context

resource - the resource to edit

backLink - the link to return to when closing the editor

params - 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 interface I_CmsEditor

Parameters:

cms - the CMS context

resource - the resource to edit

plainText - 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)

matchesType

public boolean matchesType(I_CmsResourceType type,
 boolean plainText)

Description copied from interface: I_CmsEditor

Checks whether the editor is available for the given resource type.

Specified by:

matchesType in interface I_CmsEditor

Parameters:

type - the resource type to edit

plainText - if plain text editing is required

Returns:

true if the editor is available for the given resource

See Also:

• invalid reference

  org.opencms.ui.editors.I_CmsEditor#matchesResource(org.opencms.file.CmsResource, boolean)

newInstance

public I_CmsEditor newInstance()

Description copied from interface: I_CmsEditor

Returns a new editor instance.

Specified by:

newInstance in interface I_CmsEditor

Returns:

the editor instance

See Also:

• I_CmsEditor.newInstance()

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()