Package org.opencms.ui.apps
Class CmsPageEditorConfiguration
- java.lang.Object
-
- org.opencms.ui.apps.A_CmsWorkplaceAppConfiguration
-
- org.opencms.ui.apps.CmsPageEditorConfiguration
-
- All Implemented Interfaces:
I_CmsHasAppLaunchCommand
,I_CmsHasOrder
,I_CmsWorkplaceAppConfiguration
public class CmsPageEditorConfiguration extends A_CmsWorkplaceAppConfiguration implements I_CmsHasAppLaunchCommand
The page 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 CmsPageEditorConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods 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.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, getPriority
-
-
-
-
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
-
CmsPageEditorConfiguration
public CmsPageEditorConfiguration()
-
-
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 interfaceI_CmsWorkplaceAppConfiguration
- Overrides:
getAppCategory
in classA_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 interfaceI_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 interfaceI_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 interfaceI_CmsWorkplaceAppConfiguration
- Overrides:
getHelpText
in classA_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 interfaceI_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 interfaceI_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 interfaceI_CmsWorkplaceAppConfiguration
- Overrides:
getName
in classA_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 interfaceI_CmsHasOrder
- Overrides:
getOrder
in classA_CmsWorkplaceAppConfiguration
- Returns:
- the integer used as a sort key
- See Also:
I_CmsHasOrder.getOrder()
-
getRequiredRole
public CmsRole getRequiredRole()
Description copied from interface:I_CmsWorkplaceAppConfiguration
Returns the user role required for this app.- Specified by:
getRequiredRole
in interfaceI_CmsWorkplaceAppConfiguration
- Overrides:
getRequiredRole
in classA_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 interfaceI_CmsWorkplaceAppConfiguration
- Overrides:
getVisibility
in classA_CmsWorkplaceAppConfiguration
- Parameters:
cms
- the user context- Returns:
- the visibility status
- See Also:
I_CmsWorkplaceAppConfiguration.getVisibility(org.opencms.file.CmsObject)
-
-