Package org.opencms.ui.apps

Interface I_CmsFolderAppCategory

All Superinterfaces:

I_CmsAppCategory, I_CmsHasOrder

All Known Implementing Classes:

CmsCacheFolder, CmsDbManagerFolder, CmsFileHistoryFolder, CmsLinkValidationFolder

public interface I_CmsFolderAppCategory
extends I_CmsAppCategory

Displays a sub menu in the app launch pad.

Method Summary

Modifier and Type	Method	Description
String	getButtonStyle()	Returns the button style.
String	getHelpText(Locale locale)	Gets the help text for the app in the given locale.
com.vaadin.server.Resource	getIcon()	Returns the app icon resource.
CmsAppVisibilityStatus	getVisibility(CmsObject cms)	Returns the visibility status of the app for the given user context.

Methods inherited from interface org.opencms.ui.apps.I_CmsAppCategory

getId, getName, getParentId, getPriority

Methods inherited from interface org.opencms.ui.apps.I_CmsHasOrder

getOrder

Method Details

getButtonStyle

String getButtonStyle()

Returns the button style.

Returns:

the button style

getHelpText

String getHelpText(Locale locale)

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

Parameters:

locale - the locale to use

Returns:

the help text

getIcon

com.vaadin.server.Resource getIcon()

Returns the app icon resource.

Returns:

the icon resource

getVisibility

CmsAppVisibilityStatus getVisibility(CmsObject cms)

Returns the visibility status of the app for the given user context.

Parameters:

cms - the user context

Returns:

the visibility status