org.opencms.ui.apps

Class CmsQuickLaunchEditorConfiguration

java.lang.Object

org.opencms.ui.apps.A_CmsWorkplaceAppConfiguration

org.opencms.ui.apps.CmsQuickLaunchEditorConfiguration

All Implemented Interfaces:

I_CmsHasOrder, I_CmsWorkplaceAppConfiguration

public class CmsQuickLaunchEditorConfiguration
extends A_CmsWorkplaceAppConfiguration

Editor for the user quick launch configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CmsQuickLaunchEditorConfiguration.QuickLaunchEditorApp The quick launch editor app.

Field Summary

Fields

Modifier and Type	Field and 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 and Description
CmsQuickLaunchEditorConfiguration()

Method Summary

Modifier and Type	Method and Description
I_CmsWorkplaceApp	getAppInstance() Returns a new app instance.
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.

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

getAppCategory, getButtonStyle, getPriority, getRequiredRole, getVisibility

Methods inherited from class java.lang.Object

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

Field Detail

APP_ID

public static java.lang.String APP_ID

The app id.

ICON

public static final CmsCssIcon ICON

The app icon resource (size 32x32).

Constructor Detail

CmsQuickLaunchEditorConfiguration

public CmsQuickLaunchEditorConfiguration()

Method Detail

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

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:

A_CmsWorkplaceAppConfiguration.getHelpText(java.util.Locale)

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)

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:

A_CmsWorkplaceAppConfiguration.getOrder()