Package org.opencms.ui.apps

Class CmsSitemapEditorConfiguration

java.lang.Object

org.opencms.ui.apps.A_CmsWorkplaceAppConfiguration

org.opencms.ui.apps.CmsSitemapEditorConfiguration

All Implemented Interfaces:

I_CmsHasAppLaunchCommand, I_CmsHasOrder, I_CmsWorkplaceAppConfiguration

public class CmsSitemapEditorConfiguration
extends A_CmsWorkplaceAppConfiguration
implements I_CmsHasAppLaunchCommand

The sitemap editor app configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	APP_ID	The app id.
static CmsCssIcon	ICON	The app icon resource (size 32x32).

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

DEFAULT_PRIORIY

Constructor Summary

Constructors

Constructor	Description
CmsSitemapEditorConfiguration()

Method Summary

Modifier and Type	Method	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.
java.lang.Runnable	getAppLaunchCommand()	The runnable to launch this app.
java.lang.String	getHelpText(java.util.Locale locale)	Gets the help text for the app in the given locale.
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.
int	getOrder()	Gets an integer used to sort items.
int	getPriority()	Gets the priority of the app configuration.
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

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

ICON

public static final CmsCssIcon ICON

The app icon resource (size 32x32).

Constructor Detail

CmsSitemapEditorConfiguration

public CmsSitemapEditorConfiguration()

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:

I_CmsWorkplaceAppConfiguration.getAppCategory()

getAppInstance

public I_CmsWorkplaceApp getAppInstance()

Description copied from interface: I_CmsWorkplaceAppConfiguration

Returns a new app instance.

Specified by:

getAppInstance in interface I_CmsWorkplaceAppConfiguration

Returns:

a new app instance

See Also:

I_CmsWorkplaceAppConfiguration.getAppInstance()

getAppLaunchCommand

public java.lang.Runnable getAppLaunchCommand()

Description copied from interface: I_CmsHasAppLaunchCommand

The runnable to launch this app.

Specified by:

getAppLaunchCommand in interface I_CmsHasAppLaunchCommand

Returns:

the app launch runnable

See Also:

I_CmsHasAppLaunchCommand.getAppLaunchCommand()

getHelpText

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

Description copied from interface: I_CmsWorkplaceAppConfiguration

Gets the help text for the app in the given locale.

Specified by:

getHelpText in interface I_CmsWorkplaceAppConfiguration

Overrides:

getHelpText in class A_CmsWorkplaceAppConfiguration

Parameters:

locale - the locale to use

Returns:

the help text

See Also:

I_CmsWorkplaceAppConfiguration.getHelpText(java.util.Locale)

getIcon

public com.vaadin.server.Resource getIcon()

Description copied from interface: I_CmsWorkplaceAppConfiguration

Returns the app icon resource.

Specified by:

getIcon in interface I_CmsWorkplaceAppConfiguration

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.

Specified by:

getId in interface I_CmsWorkplaceAppConfiguration

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:

I_CmsWorkplaceAppConfiguration.getName(java.util.Locale)

getOrder

public int getOrder()

Description copied from interface: I_CmsHasOrder

Gets an integer used to sort items.

Specified by:

getOrder in interface I_CmsHasOrder

Overrides:

getOrder in class A_CmsWorkplaceAppConfiguration

Returns:

the integer used as a sort key

See Also:

I_CmsHasOrder.getOrder()

getPriority

public int getPriority()

Description copied from interface: I_CmsWorkplaceAppConfiguration

Gets the priority of the app configuration.

Between two apps with the same id and different priorities, the one with the higher priority will override the one with the lower priority.

Specified by:

getPriority in interface I_CmsWorkplaceAppConfiguration

Overrides:

getPriority in class A_CmsWorkplaceAppConfiguration

Returns:

the priority

See Also:

I_CmsWorkplaceAppConfiguration.getPriority()

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:

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