Package org.opencms.gwt.shared
Class CmsCategoryBean
- java.lang.Object
-
- org.opencms.gwt.shared.CmsCategoryBean
-
- All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable
,I_CmsHasIconClasses
,I_CmsHasPath
,I_CmsHasTitle
- Direct Known Subclasses:
CmsCategoryTreeEntry
public class CmsCategoryBean extends java.lang.Object implements I_CmsHasTitle, I_CmsHasPath, com.google.gwt.user.client.rpc.IsSerializable, I_CmsHasIconClasses
A specific bean holding all info to be displayed in the categories tab.- Since:
- 8.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
BIG_ICON_CLASSES
The big category type icon classes.static java.lang.String
SMALL_ICON_CLASSES
The small category type icon classes.
-
Constructor Summary
Constructors Modifier Constructor Description protected
CmsCategoryBean()
Constructor for serialization only.CmsCategoryBean(CmsCategoryTreeEntry categoryTreeEntry)
Constructor.CmsCategoryBean(CmsCategory category)
Constructor.CmsCategoryBean(CmsUUID id, java.lang.String title, java.lang.String description, java.lang.String path, java.lang.String basePath, java.lang.String rootPath)
The constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getBasePath()
Returns the base path.java.lang.String
getBigIconClasses()
Returns the big icon CSS classes.java.lang.String
getDescription()
Returns the description.CmsUUID
getId()
Returns the id.java.lang.String
getPath()
Returns the category path.java.lang.String
getRootPath()
Returns the root path.java.lang.String
getSitePath()
Returns the category site path.java.lang.String
getSmallIconClasses()
Returns the small icon CSS classes.java.lang.String
getTitle()
Returns the title.boolean
matchesFilter(java.lang.String filter)
Returns if the category matches the given filter.void
setDescription(java.lang.String description)
Sets the description.void
setPath(java.lang.String path)
Sets the category path.void
setSitePath(java.lang.String sitePath)
Sets the category site path.void
setTitle(java.lang.String title)
Sets the title.
-
-
-
Field Detail
-
BIG_ICON_CLASSES
public static final java.lang.String BIG_ICON_CLASSES
The big category type icon classes.- See Also:
- Constant Field Values
-
SMALL_ICON_CLASSES
public static final java.lang.String SMALL_ICON_CLASSES
The small category type icon classes.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsCategoryBean
public CmsCategoryBean(CmsCategory category)
Constructor.- Parameters:
category
- the server-side category
-
CmsCategoryBean
public CmsCategoryBean(CmsCategoryTreeEntry categoryTreeEntry)
Constructor.- Parameters:
categoryTreeEntry
- the category tree entry to copy
-
CmsCategoryBean
public CmsCategoryBean(CmsUUID id, java.lang.String title, java.lang.String description, java.lang.String path, java.lang.String basePath, java.lang.String rootPath)
The constructor.- Parameters:
id
- the category idtitle
- the title to setdescription
- the subtitle to setpath
- the category pathbasePath
- the category base pathrootPath
- the category root path
-
CmsCategoryBean
protected CmsCategoryBean()
Constructor for serialization only.
-
-
Method Detail
-
getBasePath
public java.lang.String getBasePath()
Returns the base path.- Returns:
- the base path
-
getBigIconClasses
public java.lang.String getBigIconClasses()
Description copied from interface:I_CmsHasIconClasses
Returns the big icon CSS classes.- Specified by:
getBigIconClasses
in interfaceI_CmsHasIconClasses
- Returns:
- the big icon CSS classes
- See Also:
I_CmsHasIconClasses.getBigIconClasses()
-
getDescription
public java.lang.String getDescription()
Returns the description.- Returns:
- the description
-
getPath
public java.lang.String getPath()
Returns the category path.- Specified by:
getPath
in interfaceI_CmsHasPath
- Returns:
- the category path
-
getRootPath
public java.lang.String getRootPath()
Returns the root path.- Returns:
- the root path
-
getSitePath
public java.lang.String getSitePath()
Returns the category site path.- Returns:
- the category site path
-
getSmallIconClasses
public java.lang.String getSmallIconClasses()
Description copied from interface:I_CmsHasIconClasses
Returns the small icon CSS classes.- Specified by:
getSmallIconClasses
in interfaceI_CmsHasIconClasses
- Returns:
- the small icon CSS classes
- See Also:
I_CmsHasIconClasses.getSmallIconClasses()
-
getTitle
public java.lang.String getTitle()
Returns the title.- Specified by:
getTitle
in interfaceI_CmsHasTitle
- Returns:
- the title
-
matchesFilter
public boolean matchesFilter(java.lang.String filter)
Returns if the category matches the given filter.- Parameters:
filter
- the filter to match- Returns:
true
if the gallery matches the given filter.
-
setDescription
public void setDescription(java.lang.String description)
Sets the description.- Parameters:
description
- the description to set
-
setPath
public void setPath(java.lang.String path)
Sets the category path.- Parameters:
path
- the category path to set
-
setSitePath
public void setSitePath(java.lang.String sitePath)
Sets the category site path.- Parameters:
sitePath
- category site path
-
setTitle
public void setTitle(java.lang.String title)
Sets the title.- Parameters:
title
- the title to set
-
-