Package org.craftercms.engine.navigation.impl

Class NavTreeBuilderImpl

java.lang.Object

org.craftercms.engine.navigation.impl.NavTreeBuilderImpl

All Implemented Interfaces:

NavTreeBuilder

public class NavTreeBuilderImpl
extends Object
implements NavTreeBuilder

Default implementation of NavTreeBuilderImpl.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
protected org.craftercms.commons.converters.Converter<SiteItem,NavItem>	defaultItemConverter
protected org.craftercms.core.service.ItemFilter	filter
protected org.craftercms.core.processors.ItemProcessor	processor
protected SiteItemService	siteItemService

Constructor Summary

Constructors

Constructor	Description
NavTreeBuilderImpl()

Method Summary

Modifier and Type	Method	Description
protected NavItem	getNavItem(SiteItem siteItem, String currentPageUrl, org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)
protected List<NavItem>	getNavSubItems(SiteItem siteItem, String currentPageUrl, org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)
NavItem	getNavTree(String url, int depth, String currentPageUrl)	Returns the navigation tree with the specified depth for the specified store URL.
NavItem	getNavTree(String url, int depth, String currentPageUrl, org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)	Returns the navigation tree with the specified depth for the specified store URL.
protected boolean	isActive(String currentPageUrl, String pageUrl)
void	setDefaultItemConverter(org.craftercms.commons.converters.Converter<SiteItem,NavItem> defaultItemConverter)
void	setFilter(org.craftercms.core.service.ItemFilter filter)
void	setFilters(List<org.craftercms.core.service.ItemFilter> filters)
void	setProcessor(org.craftercms.core.processors.ItemProcessor processor)
void	setProcessors(List<org.craftercms.core.processors.ItemProcessor> processors)
void	setSiteItemService(SiteItemService siteItemService)

Methods inherited from class java.lang.Object

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

Field Detail

siteItemService

protected SiteItemService siteItemService

filter

protected org.craftercms.core.service.ItemFilter filter

processor

protected org.craftercms.core.processors.ItemProcessor processor

defaultItemConverter

protected org.craftercms.commons.converters.Converter<SiteItem,NavItem> defaultItemConverter

Constructor Detail

NavTreeBuilderImpl

public NavTreeBuilderImpl()

Method Detail

setSiteItemService

public void setSiteItemService(SiteItemService siteItemService)

setFilter

public void setFilter(org.craftercms.core.service.ItemFilter filter)

setProcessor

public void setProcessor(org.craftercms.core.processors.ItemProcessor processor)

setFilters

public void setFilters(List<org.craftercms.core.service.ItemFilter> filters)

setProcessors

public void setProcessors(List<org.craftercms.core.processors.ItemProcessor> processors)

setDefaultItemConverter

public void setDefaultItemConverter(org.craftercms.commons.converters.Converter<SiteItem,NavItem> defaultItemConverter)

getNavTree

public NavItem getNavTree(String url,
                          int depth,
                          String currentPageUrl)

Description copied from interface: NavTreeBuilder

Returns the navigation tree with the specified depth for the specified store URL.

Specified by:

getNavTree in interface NavTreeBuilder

Parameters:

url - the root folder of the tree

depth - the depth of the tree

currentPageUrl - the URL of the current page (used to determine the active URLs).

Returns:

the navigation tree

getNavTree

public NavItem getNavTree(String url,
                          int depth,
                          String currentPageUrl,
                          org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)

Description copied from interface: NavTreeBuilder

Returns the navigation tree with the specified depth for the specified store URL.

Specified by:

getNavTree in interface NavTreeBuilder

Parameters:

url - the root folder of the tree

depth - the depth of the tree

currentPageUrl - the URL of the current page (used to determine the active URLs).

itemConverter - the converter that should be used to convert from SiteItems to the actual NavItems

Returns:

the navigation tree

getNavItem

protected NavItem getNavItem(SiteItem siteItem,
                             String currentPageUrl,
                             org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)

getNavSubItems

protected List<NavItem> getNavSubItems(SiteItem siteItem,
                                       String currentPageUrl,
                                       org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)

isActive

protected boolean isActive(String currentPageUrl,
                           String pageUrl)