Package org.opencms.ade.galleries.shared
Class CmsSitemapEntryBean
- java.lang.Object
-
- org.opencms.gwt.shared.CmsIconBean
-
- org.opencms.ade.galleries.shared.CmsSitemapEntryBean
-
- All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable
,I_CmsGalleryTreeEntry<CmsSitemapEntryBean>
,I_CmsHasIconClasses
public class CmsSitemapEntryBean extends CmsIconBean implements I_CmsGalleryTreeEntry<CmsSitemapEntryBean>
A sitemap entry bean.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CmsSitemapEntryBean()
Constructor for serialization only.CmsSitemapEntryBean(java.lang.String rootPath, java.lang.String sitePath, CmsUUID structureId, java.lang.String title, java.lang.String type, boolean isFolder, boolean isRoot, boolean isHiddenEntry)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addChild(CmsSitemapEntryBean child)
Adds a new child to the node.java.util.List<CmsSitemapEntryBean>
getChildren()
Returns the children of this entry ornull
if not loaded.java.lang.String
getDisplayName()
Gets the name which should be displayed in the widget representing this VFS entry.java.lang.String
getRootPath()
Gets the root path of the sitemap entry.java.lang.String
getSitePath()
Returns the site path of this VFS tree.java.lang.String
getSiteRoot()
Gets the site root.CmsUUID
getStructureId()
Returns the entry structure id.java.lang.String
getType()
Returns the type.boolean
hasChildren()
Returns if the children of this entry have been loaded.boolean
isFolder()
Returns the isFolder.boolean
isHiddenEntry()
Returns if this is a hidden entry.boolean
isRoot()
Returns true if this entry is a top-level entry.boolean
isSearchMatch()
Returns true if this is a search match.void
setChildren(java.util.List<CmsSitemapEntryBean> children)
Sets the children of this entry.void
setSearchMatch(boolean isSearchMatch)
Marks this entry as a search match.void
setSiteRoot(java.lang.String siteRoot)
Sets the site root for this bean.java.lang.String
toString()
-
Methods inherited from class org.opencms.gwt.shared.CmsIconBean
getBigIconClasses, getSmallIconClasses, setBigIconClasses, setSmallIconClasses
-
-
-
-
Constructor Detail
-
CmsSitemapEntryBean
public CmsSitemapEntryBean(java.lang.String rootPath, java.lang.String sitePath, CmsUUID structureId, java.lang.String title, java.lang.String type, boolean isFolder, boolean isRoot, boolean isHiddenEntry)
Constructor.- Parameters:
rootPath
- the root pathsitePath
- the site pathstructureId
- the entry idtitle
- the titletype
- the resource typeisFolder
-true
if this entry represents a folderisRoot
-true
if this is a site root entryisHiddenEntry
-true
if this is a hidden entry
-
CmsSitemapEntryBean
protected CmsSitemapEntryBean()
Constructor for serialization only.
-
-
Method Detail
-
addChild
public void addChild(CmsSitemapEntryBean child)
Description copied from interface:I_CmsGalleryTreeEntry
Adds a new child to the node.- Specified by:
addChild
in interfaceI_CmsGalleryTreeEntry<CmsSitemapEntryBean>
- Parameters:
child
- the child to add- See Also:
I_CmsGalleryTreeEntry.addChild(java.lang.Object)
-
getChildren
public java.util.List<CmsSitemapEntryBean> getChildren()
Returns the children of this entry ornull
if not loaded.- Specified by:
getChildren
in interfaceI_CmsGalleryTreeEntry<CmsSitemapEntryBean>
- Returns:
- the children of the entry
-
getDisplayName
public java.lang.String getDisplayName()
Gets the name which should be displayed in the widget representing this VFS entry.- Returns:
- the name to display
-
getRootPath
public java.lang.String getRootPath()
Gets the root path of the sitemap entry.- Returns:
- the root path of the sitemap entry
-
getSitePath
public java.lang.String getSitePath()
Returns the site path of this VFS tree.- Returns:
- the site path
-
getSiteRoot
public java.lang.String getSiteRoot()
Gets the site root.- Returns:
- the site root
-
getStructureId
public CmsUUID getStructureId()
Returns the entry structure id.- Returns:
- the entry structure id
-
getType
public java.lang.String getType()
Returns the type.- Returns:
- the type
-
hasChildren
public boolean hasChildren()
Returns if the children of this entry have been loaded.- Returns:
true
if the children of this entry have been loaded
-
isFolder
public boolean isFolder()
Returns the isFolder.- Returns:
- the isFolder
-
isHiddenEntry
public boolean isHiddenEntry()
Returns if this is a hidden entry.- Returns:
true
if this is a hidden entry
-
isRoot
public boolean isRoot()
Returns true if this entry is a top-level entry.- Returns:
- true if this is a top-level entry
-
isSearchMatch
public boolean isSearchMatch()
Returns true if this is a search match.- Returns:
- true if this is a search match
-
setChildren
public void setChildren(java.util.List<CmsSitemapEntryBean> children)
Sets the children of this entry.- Parameters:
children
- the children
-
setSearchMatch
public void setSearchMatch(boolean isSearchMatch)
Marks this entry as a search match.- Parameters:
isSearchMatch
- true if this is a search match
-
setSiteRoot
public void setSiteRoot(java.lang.String siteRoot)
Sets the site root for this bean.- Parameters:
siteRoot
- the site root
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- See Also:
Object.toString()
-
-