org.opencms.ui.apps

Class CmsEditorConfiguration

java.lang.Object

org.opencms.ui.apps.A_CmsWorkplaceAppConfiguration

org.opencms.ui.apps.CmsEditorConfiguration

All Implemented Interfaces:

I_CmsHasOrder, I_CmsWorkplaceAppConfiguration

public class CmsEditorConfiguration
extends A_CmsWorkplaceAppConfiguration

The editor app configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APP_ID The app id.

Fields inherited from interface org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration

DEFAULT_PRIORIY

Constructor Summary

Constructors

Constructor and Description
CmsEditorConfiguration()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAppCategory() Gets the id of the app category in which this app should be displayed (null for the root category).
I_CmsWorkplaceApp	getAppInstance() Returns a new app instance.
com.vaadin.server.Resource	getIcon() Returns the app icon resource.
java.lang.String	getId() Returns the unique app id.
java.lang.String	getName(java.util.Locale locale) Returns the display name of the app.
CmsRole	getRequiredRole() Returns the user role required for this app.
CmsAppVisibilityStatus	getVisibility(CmsObject cms) Returns the visibility status of the app for the given user context.

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

getButtonStyle, getHelpText, getOrder, getPriority

Methods inherited from class java.lang.Object

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

Field Detail

APP_ID

public static final java.lang.String APP_ID

The app id.

See Also:

Constant Field Values

Constructor Detail

CmsEditorConfiguration

public CmsEditorConfiguration()

Method Detail

getAppCategory

public java.lang.String getAppCategory()

Description copied from interface: I_CmsWorkplaceAppConfiguration

Gets the id of the app category in which this app should be displayed (null for the root category).

Specified by:

getAppCategory in interface I_CmsWorkplaceAppConfiguration

Overrides:

getAppCategory in class A_CmsWorkplaceAppConfiguration

Returns:

the app category id

See Also:

A_CmsWorkplaceAppConfiguration.getAppCategory()

getAppInstance

public I_CmsWorkplaceApp getAppInstance()

Description copied from interface: I_CmsWorkplaceAppConfiguration

Returns a new app instance.

Returns:

a new app instance

See Also:

I_CmsWorkplaceAppConfiguration.getAppInstance()

getIcon

public com.vaadin.server.Resource getIcon()

Description copied from interface: I_CmsWorkplaceAppConfiguration

Returns the app icon resource.

Returns:

the icon resource

See Also:

I_CmsWorkplaceAppConfiguration.getIcon()

getId

public java.lang.String getId()

Description copied from interface: I_CmsWorkplaceAppConfiguration

Returns the unique app id.

Returns:

the app id

See Also:

I_CmsWorkplaceAppConfiguration.getId()

getName

public java.lang.String getName(java.util.Locale locale)

Description copied from interface: I_CmsWorkplaceAppConfiguration

Returns the display name of the app.

Specified by:

getName in interface I_CmsWorkplaceAppConfiguration

Overrides:

getName in class A_CmsWorkplaceAppConfiguration

Parameters:

locale - the user locale

Returns:

the app name

See Also:

A_CmsWorkplaceAppConfiguration.getName(java.util.Locale)

getRequiredRole

public CmsRole getRequiredRole()

Description copied from interface: I_CmsWorkplaceAppConfiguration

Returns the user role required for this app.

Specified by:

getRequiredRole in interface I_CmsWorkplaceAppConfiguration

Overrides:

getRequiredRole in class A_CmsWorkplaceAppConfiguration

Returns:

the required user role

See Also:

A_CmsWorkplaceAppConfiguration.getRequiredRole()

getVisibility

public CmsAppVisibilityStatus getVisibility(CmsObject cms)

Description copied from interface: I_CmsWorkplaceAppConfiguration

Returns the visibility status of the app for the given user context.

Specified by:

getVisibility in interface I_CmsWorkplaceAppConfiguration

Overrides:

getVisibility in class A_CmsWorkplaceAppConfiguration

Parameters:

cms - the user context

Returns:

the visibility status

See Also:

A_CmsWorkplaceAppConfiguration.getVisibility(org.opencms.file.CmsObject)