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 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 final String	BIG_ICON_CLASSES	The big category type icon classes.
static final 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, String title, String description, String path, String basePath, String rootPath)	The constructor.

Method Summary

Modifier and Type	Method	Description
String	getBasePath()	Returns the base path.
String	getBigIconClasses()	Returns the big icon CSS classes.
String	getDescription()	Returns the description.
CmsUUID	getId()	Returns the id.
String	getPath()	Returns the category path.
String	getRootPath()	Returns the root path.
String	getSitePath()	Returns the category site path.
String	getSmallIconClasses()	Returns the small icon CSS classes.
String	getTitle()	Returns the title.
boolean	matchesFilter(String filter)	Returns if the category matches the given filter.
void	setDescription(String description)	Sets the description.
void	setPath(String path)	Sets the category path.
void	setSitePath(String sitePath)	Sets the category site path.
void	setTitle(String title)	Sets the title.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

BIG_ICON_CLASSES

public static final String BIG_ICON_CLASSES

The big category type icon classes.

See Also:

• Constant Field Values

SMALL_ICON_CLASSES

public static final String SMALL_ICON_CLASSES

The small category type icon classes.

See Also:

• Constant Field Values

Constructor Details

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,
 String title,
 String description,
 String path,
 String basePath,
 String rootPath)

The constructor.

Parameters:

id - the category id

title - the title to set

description - the subtitle to set

path - the category path

basePath - the category base path

rootPath - the category root path

CmsCategoryBean

protected CmsCategoryBean()

Constructor for serialization only.

Method Details

getBasePath

public String getBasePath()

Returns the base path.

Returns:

the base path

getBigIconClasses

public String getBigIconClasses()

Description copied from interface: I_CmsHasIconClasses

Returns the big icon CSS classes.

Specified by:

getBigIconClasses in interface I_CmsHasIconClasses

Returns:

the big icon CSS classes

See Also:

• I_CmsHasIconClasses.getBigIconClasses()

getDescription

public String getDescription()

Returns the description.

Returns:

the description

getId

public CmsUUID getId()

Returns the id.

Returns:

the id

getPath

public String getPath()

Returns the category path.

Specified by:

getPath in interface I_CmsHasPath

Returns:

the category path

getRootPath

public String getRootPath()

Returns the root path.

Returns:

the root path

getSitePath

public String getSitePath()

Returns the category site path.

Returns:

the category site path

getSmallIconClasses

public String getSmallIconClasses()

Description copied from interface: I_CmsHasIconClasses

Returns the small icon CSS classes.

Specified by:

getSmallIconClasses in interface I_CmsHasIconClasses

Returns:

the small icon CSS classes

See Also:

• I_CmsHasIconClasses.getSmallIconClasses()

getTitle

public String getTitle()

Returns the title.

Specified by:

getTitle in interface I_CmsHasTitle

Returns:

the title

matchesFilter

public boolean matchesFilter(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(String description)

Sets the description.

Parameters:

description - the description to set

setPath

public void setPath(String path)

Sets the category path.

Parameters:

path - the category path to set

setSitePath

public void setSitePath(String sitePath)

Sets the category site path.

Parameters:

sitePath - category site path

setTitle

public void setTitle(String title)

Sets the title.

Parameters:

title - the title to set