Package org.ametys.web.sitemap

Interface SitemapTreeIndicator

All Superinterfaces:

Prioritizable

All Known Implementing Classes:

AbstractStaticSitemapIndicator, ClassifiedAdsRootSitemapIndicator, DefaultSitemapIndicator, OrgUnitRootSitemapIndicator, PageTagSitemapDecorator, UserDirectoryRootSitemapIndicator

public interface SitemapTreeIndicator
extends Prioritizable

Interface representing a sitemap's indicator (icon or decorator)

Method Summary

Modifier and Type	Method	Description
String	getIcon()	The icon path
String	getIconDecorator()	The icon decorator
String	getIconGlyph()	The icon glyph
String	getId()	Get the indicator's id
I18nizableText	getLabel()	The indicator's label
boolean	matches(SitemapElement sitemapElement)	Check if the sitemap element matches the indicator's conditions

Methods inherited from interface org.ametys.runtime.plugin.component.Prioritizable

getPriority

Method Details

getId

String getId()

Get the indicator's id

Returns:

the id

getLabel

I18nizableText getLabel()

The indicator's label

Returns:

the label. Can be null

getIcon

String getIcon()

The icon path

Returns:

The icon path. Can be null.

getIconGlyph

String getIconGlyph()

The icon glyph

Returns:

The icon glyph. Can be null.

getIconDecorator

String getIconDecorator()

The icon decorator

Returns:

The icon decorator

matches

boolean matches(SitemapElement sitemapElement)

Check if the sitemap element matches the indicator's conditions

Parameters:

sitemapElement - the sitemap element to check

Returns:

true if the element matches the indicator