Package org.opencms.ade.galleries

Class CmsSiteSelectorOptionBuilder

java.lang.Object

org.opencms.ade.galleries.CmsSiteSelectorOptionBuilder

public class CmsSiteSelectorOptionBuilder
extends java.lang.Object

Helper class for building the options for the site selector in the gallery dialog.

Constructor Summary

Constructors

Constructor	Description
CmsSiteSelectorOptionBuilder(CmsObject cms)	Creates a new builder instance.

Method Summary

Modifier and Type	Method	Description
void	addCurrentSubsite(java.lang.String referencePath)	Adds the current subsite.
void	addNormalSites(boolean includeRoot, java.lang.String startFolder)	Adds 'normal' sites.
void	addSharedSite()	Adds the shared folder.
void	addSystemFolder()	Adds the system folder.
java.util.List<CmsSiteSelectorOption>	getOptions()	Gets the site selector options.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSiteSelectorOptionBuilder

public CmsSiteSelectorOptionBuilder(CmsObject cms)

Creates a new builder instance.

Parameters:

cms - the CMS context to use

Method Detail

addCurrentSubsite

public void addCurrentSubsite(java.lang.String referencePath)

Adds the current subsite.

Parameters:

referencePath - the reference path

addNormalSites

public void addNormalSites(boolean includeRoot,
                           java.lang.String startFolder)

Adds 'normal' sites.

Parameters:

includeRoot - if true, also adds the root site

startFolder - the users configured start folder

addSharedSite

public void addSharedSite()

Adds the shared folder.

addSystemFolder

public void addSystemFolder()

Adds the system folder.

getOptions

public java.util.List<CmsSiteSelectorOption> getOptions()

Gets the site selector options.

Returns:

the site selector options