org.opencms.ui.sitemap

Class CmsSitemapTreeNodeData

java.lang.Object

org.opencms.ui.sitemap.CmsSitemapTreeNodeData

public class CmsSitemapTreeNodeData
extends java.lang.Object

Represents the data of a sitemap tree node.

Constructor Summary

Constructors

Constructor and Description
CmsSitemapTreeNodeData(java.util.Locale mainLocale, java.util.Locale otherLocale) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
CmsClientSitemapEntry	getClientEntry() Gets the client sitemap entry.
CmsResource	getLinkedResource() Gets the linked resource.
CmsResource	getResource() Gets the sitemap entry resource.
boolean	hasNoChildren() Returns true if the node definitely has no children to load.
void	initialize(CmsObject cms) Initializes the bean.
boolean	isCopyable() Returns true if the 'Copy page' function should be offered for this entry.
boolean	isDirectLink() Returns true if the linked resource is directly linked.
boolean	isLinked() Returns true if this sitemap entry has a linked resource.
boolean	isMarkedNoTranslation(java.util.Locale locale) Checks if this entry is marked as 'do not translate' for the given locale .
void	setClientEntry(CmsClientSitemapEntry entry) Sets the client entry.
void	setHasNoChildren(boolean b) Sets the 'has no children' flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSitemapTreeNodeData

public CmsSitemapTreeNodeData(java.util.Locale mainLocale,
                              java.util.Locale otherLocale)

Creates a new instance.

Parameters:

mainLocale - the main locale

otherLocale - the other locale

Method Detail

getClientEntry

public CmsClientSitemapEntry getClientEntry()

Gets the client sitemap entry.

Returns:

the client sitemap entry

getLinkedResource

public CmsResource getLinkedResource()

Gets the linked resource.

Returns:

the linked resource

getResource

public CmsResource getResource()

Gets the sitemap entry resource.

Returns:

the resource

hasNoChildren

public boolean hasNoChildren()

Returns true if the node definitely has no children to load.

Returns:

true if there are definitely no children to load

initialize

public void initialize(CmsObject cms)
                throws CmsException

Initializes the bean.

Parameters:

cms - the CMS context to use

Throws:

CmsException - if something goes wrong

isCopyable

public boolean isCopyable()

Returns true if the 'Copy page' function should be offered for this entry.

Returns:

true if the 'copy pgae' function should be available

isDirectLink

public boolean isDirectLink()

Returns true if the linked resource is directly linked.

Returns:

true if the linked resource is directly linked

isLinked

public boolean isLinked()

Returns true if this sitemap entry has a linked resource.

Returns:

true if there is a linked resource

isMarkedNoTranslation

public boolean isMarkedNoTranslation(java.util.Locale locale)

Checks if this entry is marked as 'do not translate' for the given locale .

Parameters:

locale - the locale

Returns:

true if the 'do not translate' mark for the given locale is set

setClientEntry

public void setClientEntry(CmsClientSitemapEntry entry)

Sets the client entry.

Parameters:

entry - the client entry

setHasNoChildren

public void setHasNoChildren(boolean b)

Sets the 'has no children' flag.

Parameters:

b - the new value