Package org.opencms.ui.apps.modules

Class CmsModuleApp

java.lang.Object

org.opencms.ui.apps.A_CmsWorkplaceApp

org.opencms.ui.apps.A_CmsAttributeAwareApp

org.opencms.ui.apps.modules.CmsModuleApp

All Implemented Interfaces:

Serializable, I_CmsCachableApp, I_CmsWorkplaceApp

public class CmsModuleApp
extends A_CmsAttributeAwareApp
implements I_CmsCachableApp

Main module manager app class.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CmsModuleApp.Attributes	Additional app attributes for the module manager.
static class	CmsModuleApp.Icons	Contains the icon constants for the module manager.
static class	CmsModuleApp.States	Contains the different navigation states for the module maanger.

Nested classes/interfaces inherited from class org.opencms.ui.apps.A_CmsWorkplaceApp

A_CmsWorkplaceApp.NavEntry

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_MODULE	The 'module' parameter.

Fields inherited from class org.opencms.ui.apps.A_CmsAttributeAwareApp

ATTR_INFO_COMPONENT, ATTR_MAIN_HEIGHT_FULL

Fields inherited from class org.opencms.ui.apps.A_CmsWorkplaceApp

m_infoLayout, m_rootLayout, m_uiContext, PARAM_ASSIGN, PARAM_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
CmsModuleApp()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	editModule(String moduleName)	Opens the edit dialog for the given module.
static void	editModule(CmsModule module, boolean isNew, String caption, Runnable callback)	Opens the module editor for the given module.
void	editNewModule(Runnable callback)	Opens module edit dialog for a new module.
protected LinkedHashMap<String,String>	getBreadCrumbForState(String state)	Returns the current bread crumb entries in an ordered map.
protected com.vaadin.ui.Component	getComponentForState(String state)	Returns the app component for the given state.
List<I_CmsSimpleContextMenuEntry<Set<String>>>	getMenuEntries()	Returns the available menu entries.
protected com.vaadin.ui.Component	getModuleTable()	Gets the module table.
protected String	getReportLabel(String state)	Gets the label for a given report.
protected List<A_CmsWorkplaceApp.NavEntry>	getSubNavEntries(String state)	Returns the sub navigation entries.
void	initUI(I_CmsAppUIContext context)	Within this method the app UI should be initialized.
boolean	isCachable()	Returns whether this app should be cached within the user session.
void	onRestoreFromCache()	Called after the view is fetched from the cache.
void	onStateChange(String state)	Called on navigation events.
void	openModuleInfo(Set<String> name)	Opens the module info dialog.
void	openReport(String newState, A_CmsReportThread thread, String label)	Changes to a new sub-view and stores a report to be displayed by that subview.invalid input: '<'pinvalid input: '<'
protected void	reload()	Reloads the table.
void	setReport(String key, A_CmsReportThread report)	Stores a report thread isntance under a given key.
protected void	updateAppAttributes(Map<String,Object> attributes)	Handles the attributes.
static CmsMenuItemVisibilityMode	visibilityCheckHasModule(String name)	Returns VISIBILITY_ACTIVE if a module with the given name exists, and VISIBILITY_INVISIBLE otherwise.

Methods inherited from class org.opencms.ui.apps.A_CmsAttributeAwareApp

getAttributesForComponent, openSubView, updateMainComponent

Methods inherited from class org.opencms.ui.apps.A_CmsWorkplaceApp

addParamToState, addSubNavEntry, getLastPathLevel, getOfflineCmsObject, getParamFromState, getParamsFromState, removeParamsFromState, setBreadCrumbEntries, updateBreadCrumb, updateSubNav

Methods inherited from class java.lang.Object

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

Field Details

PARAM_MODULE

public static final String PARAM_MODULE

The 'module' parameter.

See Also:

• Constant Field Values

Constructor Details

CmsModuleApp

public CmsModuleApp()

Creates a new instance.

Method Details

editModule

public static void editModule(CmsModule module,
 boolean isNew,
 String caption,
 Runnable callback)

Opens the module editor for the given module.

Parameters:

module - the edited module

isNew - true if this is a new module

caption - the caption for the module editor dialog

callback - the callback to call after the edit dialog is done

visibilityCheckHasModule

public static CmsMenuItemVisibilityMode visibilityCheckHasModule(String name)

Returns VISIBILITY_ACTIVE if a module with the given name exists, and VISIBILITY_INVISIBLE otherwise.

Parameters:

name - a module name

Returns:

the visibility

editModule

public void editModule(String moduleName)

Opens the edit dialog for the given module.

Parameters:

moduleName - the name of the module

editNewModule

public void editNewModule(Runnable callback)

Opens module edit dialog for a new module.

Parameters:

callback - the callback to call after finishing

getMenuEntries

public List<I_CmsSimpleContextMenuEntry<Set<String>>> getMenuEntries()

Returns the available menu entries.

Returns:

the menu entries

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

Overrides:

initUI in class A_CmsWorkplaceApp

Parameters:

context - the UI context

See Also:

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

isCachable

public boolean isCachable()

Description copied from interface: I_CmsCachableApp

Returns whether this app should be cached within the user session.

Specified by:

isCachable in interface I_CmsCachableApp

Returns:

true if the app is cachable

See Also:

• I_CmsCachableApp.isCachable()

onRestoreFromCache

public void onRestoreFromCache()

Description copied from interface: I_CmsCachableApp

Called after the view is fetched from the cache.

Specified by:

onRestoreFromCache in interface I_CmsCachableApp

See Also:

• I_CmsCachableApp.onRestoreFromCache()

onStateChange

public void onStateChange(String state)

Description copied from interface: I_CmsWorkplaceApp

Called on navigation events.

Specified by:

onStateChange in interface I_CmsWorkplaceApp

Overrides:

onStateChange in class A_CmsWorkplaceApp

Parameters:

state - the app state to show

See Also:

• A_CmsWorkplaceApp.onStateChange(java.lang.String)

openModuleInfo

public void openModuleInfo(Set<String> name)

Opens the module info dialog.

Parameters:

name - the name of the module

openReport

public void openReport(String newState,
 A_CmsReportThread thread,
 String label)

Changes to a new sub-view and stores a report to be displayed by that subview.invalid input: '<'pinvalid input: '<'

Parameters:

newState - the new state

thread - the report thread which should be displayed in the sub view

label - the label to display for the report

setReport

public void setReport(String key,
 A_CmsReportThread report)

Stores a report thread isntance under a given key.

Parameters:

key - the key

report - the report thread instance

getBreadCrumbForState

protected LinkedHashMap<String,String> getBreadCrumbForState(String state)

Description copied from class: A_CmsWorkplaceApp

Returns the current bread crumb entries in an ordered map.

Specified by:

getBreadCrumbForState in class A_CmsWorkplaceApp

Parameters:

state - the current state

Returns:

bread crumb entry name by state, in case the state is empty, the entry will be disabled

See Also:

• A_CmsWorkplaceApp.getBreadCrumbForState(java.lang.String)

getComponentForState

protected com.vaadin.ui.Component getComponentForState(String state)

Description copied from class: A_CmsWorkplaceApp

Returns the app component for the given state.

Specified by:

getComponentForState in class A_CmsWorkplaceApp

Parameters:

state - the state to render

Returns:

the app component

See Also:

• A_CmsWorkplaceApp.getComponentForState(java.lang.String)

getModuleTable

protected com.vaadin.ui.Component getModuleTable()

Gets the module table.

Returns:

the module table

getReportLabel

protected String getReportLabel(String state)

Gets the label for a given report.

Parameters:

state - the state for which to get the label

Returns:

the label

getSubNavEntries

protected List<A_CmsWorkplaceApp.NavEntry> getSubNavEntries(String state)

Description copied from class: A_CmsWorkplaceApp

Returns the sub navigation entries.

Specified by:

getSubNavEntries in class A_CmsWorkplaceApp

Parameters:

state - the state

Returns:

the sub navigation entries

See Also:

• A_CmsWorkplaceApp.getSubNavEntries(java.lang.String)

reload

protected void reload()

Reloads the table.

updateAppAttributes

protected void updateAppAttributes(Map<String,Object> attributes)

Description copied from class: A_CmsAttributeAwareApp

Handles the attributes.

Overrides:

updateAppAttributes in class A_CmsAttributeAwareApp

Parameters:

attributes - to set

See Also:

• A_CmsAttributeAwareApp.updateAppAttributes(java.util.Map)