Package org.opencms.ui.apps.cacheadmin

Class CmsCacheFolder

java.lang.Object

org.opencms.ui.apps.cacheadmin.CmsCacheFolder

All Implemented Interfaces:

I_CmsAppCategory, I_CmsFolderAppCategory, I_CmsHasOrder

public class CmsCacheFolder
extends Object
implements I_CmsFolderAppCategory

Class for the Cache folder.

Field Summary

Fields

Modifier and Type	Field	Description
static final CmsCssIcon	ICON	The app icon resource (size 32x32).
static final String	ID	Folder id.

Constructor Summary

Constructors

Constructor	Description
CmsCacheFolder()

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.
String	getId()	Returns the id.
String	getName(Locale locale)	Gets the user readable name for the category for a given locale.
int	getOrder()	Gets an integer used to sort items.
String	getParentId()	Returns the parentId.
int	getPriority()	Returns the priority.
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

Field Details

ID

public static final String ID

Folder id.

See Also:

• Constant Field Values

ICON

public static final CmsCssIcon ICON

The app icon resource (size 32x32).

Constructor Details

CmsCacheFolder

public CmsCacheFolder()

Method Details

getButtonStyle

public String getButtonStyle()

Description copied from interface: I_CmsFolderAppCategory

Returns the button style.

Specified by:

getButtonStyle in interface I_CmsFolderAppCategory

Returns:

the button style

See Also:

• I_CmsFolderAppCategory.getButtonStyle()

getHelpText

public String getHelpText(Locale locale)

Description copied from interface: I_CmsFolderAppCategory

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

Specified by:

getHelpText in interface I_CmsFolderAppCategory

Parameters:

locale - the locale to use

Returns:

the help text

See Also:

• I_CmsFolderAppCategory.getHelpText(java.util.Locale)

getIcon

public com.vaadin.server.Resource getIcon()

Description copied from interface: I_CmsFolderAppCategory

Returns the app icon resource.

Specified by:

getIcon in interface I_CmsFolderAppCategory

Returns:

the icon resource

See Also:

• I_CmsFolderAppCategory.getIcon()

getId

public String getId()

Description copied from interface: I_CmsAppCategory

Returns the id.

Specified by:

getId in interface I_CmsAppCategory

Returns:

the id

See Also:

• I_CmsAppCategory.getId()

getName

public String getName(Locale locale)

Description copied from interface: I_CmsAppCategory

Gets the user readable name for the category for a given locale.

Specified by:

getName in interface I_CmsAppCategory

Parameters:

locale - the locale for which to get the name

Returns:

the localized name

See Also:

• I_CmsAppCategory.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

Returns:

the integer used as a sort key

See Also:

• I_CmsHasOrder.getOrder()

getParentId

public String getParentId()

Description copied from interface: I_CmsAppCategory

Returns the parentId.

App categories can be nested. The method must return the id of the parent category if the category is nested. If it is on top level, null should be returned.

Specified by:

getParentId in interface I_CmsAppCategory

Returns:

the parentId

See Also:

• I_CmsAppCategory.getParentId()

getPriority

public int getPriority()

Description copied from interface: I_CmsAppCategory

Returns the priority.

If more than one category with the same id is present, the one with higher priority is shown. The other categories with this id are discarded.

Specified by:

getPriority in interface I_CmsAppCategory

Returns:

the priority

See Also:

• I_CmsAppCategory.getPriority()

getVisibility

public CmsAppVisibilityStatus getVisibility(CmsObject cms)

Description copied from interface: I_CmsFolderAppCategory

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

Specified by:

getVisibility in interface I_CmsFolderAppCategory

Parameters:

cms - the user context

Returns:

the visibility status

See Also:

• I_CmsFolderAppCategory.getVisibility(org.opencms.file.CmsObject)