Package org.opencms.gwt.shared

Class CmsCategoryTreeEntry

java.lang.Object

org.opencms.gwt.shared.CmsCategoryBean

org.opencms.gwt.shared.CmsCategoryTreeEntry

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, I_CmsHasIconClasses, I_CmsHasPath, I_CmsHasTitle

public class CmsCategoryTreeEntry
extends CmsCategoryBean

Recursive category tree entry.

Since:

8.0.0

Field Summary

Fields inherited from class org.opencms.gwt.shared.CmsCategoryBean

BIG_ICON_CLASSES, SMALL_ICON_CLASSES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CmsCategoryTreeEntry()	Constructor for serialization.
	CmsCategoryTreeEntry(CmsCategory category)	Clone constructor.

Method Summary

Modifier and Type	Method	Description
void	addChild(CmsCategoryTreeEntry child)	Adds a child entry.
List<CmsCategoryTreeEntry>	getChildren()	Returns the children.
Boolean	getForcedVisible()	Gets the 'forced visible' status.
Object	getTitleOrName()	Gets the title of the category, or the name if the title is not set.
boolean	isUsed()	Checks if the category is among the 'recently used' ones for the current user.
void	setChildren(List<CmsCategoryTreeEntry> children)	Sets the children.
void	setForcedVisible(Boolean visibility)	Sets the 'forced visible' status.
void	setUsed(boolean used)	Sets the 'recently used' state.

Methods inherited from class org.opencms.gwt.shared.CmsCategoryBean

getBasePath, getBigIconClasses, getDescription, getId, getPath, getRootPath, getSitePath, getSmallIconClasses, getTitle, matchesFilter, setDescription, setPath, setSitePath, setTitle

Methods inherited from class java.lang.Object

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

Constructor Details

CmsCategoryTreeEntry

public CmsCategoryTreeEntry(CmsCategory category)

Clone constructor.

Parameters:

category - the category to clone

CmsCategoryTreeEntry

protected CmsCategoryTreeEntry()

Constructor for serialization.

Method Details

addChild

public void addChild(CmsCategoryTreeEntry child)

Adds a child entry.

Parameters:

child - the child to add

getChildren

public List<CmsCategoryTreeEntry> getChildren()

Returns the children.

Returns:

the children

getForcedVisible

public Boolean getForcedVisible()

Gets the 'forced visible' status.

A category tree entry with this status set to 'true' should be shown even if it is marked as hidden.

Returns:

the 'forced visible' status

getTitleOrName

public Object getTitleOrName()

Gets the title of the category, or the name if the title is not set.

Returns:

the title or name

isUsed

public boolean isUsed()

Checks if the category is among the 'recently used' ones for the current user.

Returns:

true if the category was recently used

setChildren

public void setChildren(List<CmsCategoryTreeEntry> children)

Sets the children.

Parameters:

children - the children to set

setForcedVisible

public void setForcedVisible(Boolean visibility)

Sets the 'forced visible' status.

Parameters:

visibility - the new value

setUsed

public void setUsed(boolean used)

Sets the 'recently used' state.

Parameters:

used - the new 'recently used' state