Package org.opencms.ui.apps
Class A_CmsWorkplaceAppConfiguration
- java.lang.Object
-
- org.opencms.ui.apps.A_CmsWorkplaceAppConfiguration
-
- All Implemented Interfaces:
I_CmsHasOrder
,I_CmsWorkplaceAppConfiguration
- Direct Known Subclasses:
CmsAccountsAppConfiguration
,CmsAppHierarchyConfiguration
,CmsBroadCastConfigurtion
,CmsCacheAdminConfiguration
,CmsCacheViewFlexConfiguration
,CmsCacheViewImageConfiguration
,CmsDbExportConfiguration
,CmsDbImportHTTPConfiguration
,CmsDbImportServerConfiguration
,CmsDbManagerConfiguration
,CmsDbPropertiesAppConfiguration
,CmsDbRemovePubLocksConfiguration
,CmsDbStaticExportConfiguration
,CmsDbSynchronizationConfiguration
,CmsEditorConfiguration
,CmsFileExplorerConfiguration
,CmsFileHistoryConfiguration
,CmsGitAppConfiguration
,CmsLinkInFolderValidationConfiguration
,CmsLinkValidationConfiguration
,CmsLinkValidationExternalConfiguration
,CmsListManagerConfiguration
,CmsLogFileConfiguration
,CmsModuleAppConfiguration
,CmsPageEditorConfiguration
,CmsProjectManagerConfiguration
,CmsProjectOverviewConfiguration
,CmsPublishQueueConfiguration
,CmsQuickLaunchEditorConfiguration
,CmsResourceTypeAppConfiguration
,CmsScheduledJobsAppConfig
,CmsSearchindexAppConfiguration
,CmsShellAppConfiguration
,CmsSiteManagerConfiguration
,CmsSitemapEditorConfiguration
,CmsSourceSearchAppConfiguration
,CmsSqlConsoleAppConfiguration
,CmsUserDataAppConfiguration
public abstract class A_CmsWorkplaceAppConfiguration extends java.lang.Object implements I_CmsWorkplaceAppConfiguration
Abstract superclass for workplace apps.
-
-
Field Summary
-
Fields inherited from interface org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration
DEFAULT_PRIORIY
-
-
Constructor Summary
Constructors Constructor Description A_CmsWorkplaceAppConfiguration()
-
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).java.lang.String
getButtonStyle()
Returns the button style.java.lang.String
getHelpText(java.util.Locale locale)
Gets the help text for the app in the given locale.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration
getAppInstance, getIcon, getId
-
-
-
-
Constructor Detail
-
A_CmsWorkplaceAppConfiguration
public A_CmsWorkplaceAppConfiguration()
-
-
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
- Returns:
- the app category id
- See Also:
I_CmsWorkplaceAppConfiguration.getAppCategory()
-
getButtonStyle
public java.lang.String getButtonStyle()
Description copied from interface:I_CmsWorkplaceAppConfiguration
Returns the button style.- Specified by:
getButtonStyle
in interfaceI_CmsWorkplaceAppConfiguration
- Returns:
- the button style
- See Also:
I_CmsWorkplaceAppConfiguration.getButtonStyle()
-
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
- Parameters:
locale
- the locale to use- Returns:
- the help text
- See Also:
I_CmsWorkplaceAppConfiguration.getHelpText(java.util.Locale)
-
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
- 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
- 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 interfaceI_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 interfaceI_CmsWorkplaceAppConfiguration
- Returns:
- the required user role
- See Also:
I_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
- Parameters:
cms
- the user context- Returns:
- the visibility status
- See Also:
I_CmsWorkplaceAppConfiguration.getVisibility(org.opencms.file.CmsObject)
-
-