SitemapDecoratorsHandler (Ametys 4.3.x - API)

All Known Implementing Classes:

DefaultSitemapDecoratorsHandler
```
public interface SitemapDecoratorsHandler
```
Interface representing a sitemap decorator

Field Summary

Fields
Modifier and Type Field Description

static String ROLE
Avalon Role

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	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(Site site)`	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(Site site)
```
    Get the list of available icons
    
    Parameters:
    
    site - the site name
    
    Returns:
    
    the list of available icons