org.ametys.web.sitemap

Interface SitemapDecoratorsHandler

All Known Implementing Classes:

DefaultSitemapDecoratorsHandler

public interface SitemapDecoratorsHandler

Interface representing a sitemap decorator

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE Avalon Role

Method Summary

Modifier and Type	Method and Description
List<SitemapDecorator>	getDecorators(Page page) Get the list of decorators for a given page
List<SitemapDecorator>	getDecorators(Site site) Get the list of available decorators
List<SitemapDecorator>	getDecorators(Sitemap sitemap) Get the list of available decorators
SitemapIcon	getIcon(Page page) Get the icon of the page
List<SitemapIcon>	getIcons(String siteName) Get the list of available icons

Field Detail

ROLE

static final String ROLE

Avalon Role

Method Detail

getDecorators

List<SitemapDecorator> getDecorators(Site site)

Get the list of available decorators

Parameters:

site - the site name

Returns:

the list of available decorators

getDecorators

List<SitemapDecorator> getDecorators(Sitemap sitemap)

Get the list of available decorators

Parameters:

sitemap - the sitemap

Returns:

the list of available decorators

getDecorators

List<SitemapDecorator> getDecorators(Page page)

Get the list of decorators for a given page

Parameters:

page - the page

Returns:

decorators of page

getIcon

SitemapIcon getIcon(Page page)

Get the icon of the page

Parameters:

page - the page

Returns:

the file icon path

getIcons

List<SitemapIcon> getIcons(String siteName)

Get the list of available icons

Parameters:

siteName - the site name

Returns:

the list of available icons