Package org.ametys.web.sitemap

Class AbstractStaticSitemapIndicator

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.sitemap.AbstractStaticSitemapIndicator

All Implemented Interfaces:

LogEnabled, PluginAware, Prioritizable, SitemapTreeIndicator, Configurable

Direct Known Subclasses:

ClassifiedAdsRootSitemapIndicator, DefaultSitemapIndicator, OrgUnitRootSitemapIndicator, PageTagSitemapDecorator, UserDirectoryRootSitemapIndicator

public abstract class AbstractStaticSitemapIndicator
extends AbstractLogEnabled
implements SitemapTreeIndicator, PluginAware, Configurable

Abstract class for implementing a sitemap tree's indicator

Constructor Summary

Constructors

Constructor	Description
AbstractStaticSitemapIndicator()

Method Summary

Modifier and Type	Method	Description
void	configure(String id, Configuration configuration, String defaultI18nCatalog, String iconPathPrefix)	Configure sitemap indicator
void	configure(Configuration configuration)
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
int	getPriority()	Get the priority for the component.
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.web.sitemap.SitemapTreeIndicator

matches

Constructor Details

AbstractStaticSitemapIndicator

public AbstractStaticSitemapIndicator()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

configure

public void configure(String id,
 Configuration configuration,
 String defaultI18nCatalog,
 String iconPathPrefix)
               throws ConfigurationException

Configure sitemap indicator

Parameters:

id - the unique id. Can be null to get id from configuration

configuration - the configuration

defaultI18nCatalog - the default i18n catalogue

iconPathPrefix - the prefix path for icon

Throws:

ConfigurationException - if configuration is invalid

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getId

public String getId()

Description copied from interface: SitemapTreeIndicator

Get the indicator's id

Specified by:

getId in interface SitemapTreeIndicator

Returns:

the id

getLabel

public I18nizableText getLabel()

Description copied from interface: SitemapTreeIndicator

The indicator's label

Specified by:

getLabel in interface SitemapTreeIndicator

Returns:

the label. Can be null

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Specified by:

getPriority in interface Prioritizable

Returns:

the priority

getIcon

public String getIcon()

Description copied from interface: SitemapTreeIndicator

The icon path

Specified by:

getIcon in interface SitemapTreeIndicator

Returns:

The icon path. Can be null.

getIconGlyph

public String getIconGlyph()

Description copied from interface: SitemapTreeIndicator

The icon glyph

Specified by:

getIconGlyph in interface SitemapTreeIndicator

Returns:

The icon glyph. Can be null.

getIconDecorator

public String getIconDecorator()

Description copied from interface: SitemapTreeIndicator

The icon decorator

Specified by:

getIconDecorator in interface SitemapTreeIndicator

Returns:

The icon decorator