Package org.opencms.ade.galleries

Class CmsGalleryFilteredNavTreeBuilder

java.lang.Object

org.opencms.ade.galleries.CmsGalleryFilteredNavTreeBuilder

public class CmsGalleryFilteredNavTreeBuilder
extends java.lang.Object

Helper class for building a filtered sitemap tree for the gallery dialog's 'Sitemap' tab.

Objects of this class are single-use, which means they should only be used for a single navigation tree filtering operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CmsGalleryFilteredNavTreeBuilder.NavigationNode	A tree node representing a navigation entry.

Constructor Summary

Constructors

Constructor	Description
CmsGalleryFilteredNavTreeBuilder(CmsObject cms, java.lang.String rootPath)	Creates a new navigation tree.

Method Summary

Modifier and Type	Method	Description
CmsGalleryFilteredNavTreeBuilder.NavigationNode	getRoot()	Gets the root node.
boolean	hasMatches()	Returns true if any matching tree nodes have been found.
void	initTree(java.lang.String filter)	Constructs the filtered navigation tree.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsGalleryFilteredNavTreeBuilder

public CmsGalleryFilteredNavTreeBuilder(CmsObject cms,
                                        java.lang.String rootPath)

Creates a new navigation tree.

Parameters:

cms - the CMS context

rootPath - the root path

Method Detail

getRoot

public CmsGalleryFilteredNavTreeBuilder.NavigationNode getRoot()

Gets the root node.

Returns:

the root node

hasMatches

public boolean hasMatches()

Returns true if any matching tree nodes have been found.

Returns:

tree if any matching tree nodes have been found

initTree

public void initTree(java.lang.String filter)

Constructs the filtered navigation tree.

Parameters:

filter - the filter string