Package org.opencms.ui.apps.searchindex
Class CmsSearchindexAppConfiguration
- java.lang.Object
-
- org.opencms.ui.apps.A_CmsWorkplaceAppConfiguration
-
- org.opencms.ui.apps.searchindex.CmsSearchindexAppConfiguration
-
- All Implemented Interfaces:
I_CmsHasOrder
,I_CmsWorkplaceAppConfiguration
public class CmsSearchindexAppConfiguration extends A_CmsWorkplaceAppConfiguration
Configuration class for the searchindex app.
-
-
Field Summary
Fields Modifier and Type Field 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 Description CmsSearchindexAppConfiguration()
-
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.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.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.-
Methods inherited from class org.opencms.ui.apps.A_CmsWorkplaceAppConfiguration
getPriority, getVisibility
-
-
-
-
Field Detail
-
APP_ID
public static final java.lang.String APP_ID
The app id.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsSearchindexAppConfiguration
public CmsSearchindexAppConfiguration()
-
-
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.- Returns:
- a new app instance
- See Also:
I_CmsWorkplaceAppConfiguration.getAppInstance()
-
getButtonStyle
public java.lang.String getButtonStyle()
Description copied from interface:I_CmsWorkplaceAppConfiguration
Returns the button style.- Specified by:
getButtonStyle
in interfaceI_CmsWorkplaceAppConfiguration
- Overrides:
getButtonStyle
in classA_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
- 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.- 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 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()
-
-