Class CmsLinkValidationFolder
- java.lang.Object
-
- org.opencms.ui.apps.linkvalidation.CmsLinkValidationFolder
-
- All Implemented Interfaces:
I_CmsAppCategory
,I_CmsFolderAppCategory
,I_CmsHasOrder
public class CmsLinkValidationFolder extends java.lang.Object implements I_CmsFolderAppCategory
Class for the folder for the link validation tools.
-
-
Field Summary
Fields Modifier and Type Field Description static CmsCssIcon
ICON
The app icon resource (size 32x32).static java.lang.String
ID
Folder id.
-
Constructor Summary
Constructors Constructor Description CmsLinkValidationFolder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 id.java.lang.String
getName(java.util.Locale locale)
Gets the user readable name for the category for a given locale.int
getOrder()
Gets an integer used to sort items.java.lang.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.
-
-
-
Field Detail
-
ICON
public static final CmsCssIcon ICON
The app icon resource (size 32x32).
-
ID
public static final java.lang.String ID
Folder id.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsLinkValidationFolder
public CmsLinkValidationFolder()
-
-
Method Detail
-
getButtonStyle
public java.lang.String getButtonStyle()
Description copied from interface:I_CmsFolderAppCategory
Returns the button style.- Specified by:
getButtonStyle
in interfaceI_CmsFolderAppCategory
- Returns:
- the button style
- See Also:
I_CmsFolderAppCategory.getButtonStyle()
-
getHelpText
public java.lang.String getHelpText(java.util.Locale locale)
Description copied from interface:I_CmsFolderAppCategory
Gets the help text for the app in the given locale.- Specified by:
getHelpText
in interfaceI_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 interfaceI_CmsFolderAppCategory
- Returns:
- the icon resource
- See Also:
I_CmsFolderAppCategory.getIcon()
-
getId
public java.lang.String getId()
Description copied from interface:I_CmsAppCategory
Returns the id.- Specified by:
getId
in interfaceI_CmsAppCategory
- Returns:
- the id
- See Also:
I_CmsAppCategory.getId()
-
getName
public java.lang.String getName(java.util.Locale locale)
Description copied from interface:I_CmsAppCategory
Gets the user readable name for the category for a given locale.- Specified by:
getName
in interfaceI_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 interfaceI_CmsHasOrder
- Returns:
- the integer used as a sort key
- See Also:
I_CmsHasOrder.getOrder()
-
getParentId
public java.lang.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 interfaceI_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 interfaceI_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 interfaceI_CmsFolderAppCategory
- Parameters:
cms
- the user context- Returns:
- the visibility status
- See Also:
I_CmsFolderAppCategory.getVisibility(org.opencms.file.CmsObject)
-
-