Package org.ametys.web.sitemap

Class SitemapIcon

java.lang.Object

org.ametys.web.sitemap.SitemapIcon

Direct Known Subclasses:

SitemapDecorator

public class SitemapIcon
extends Object

A icon for page in sitemap

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SitemapIcon.Condition	The tag condition.

Constructor Summary

Constructors

Constructor	Description
SitemapIcon()	Constructor

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration, String iconPathPrefix)	Configure decoration
String	getIcon()	The icon path
String	getIconDecorator()	The icon decorator
String	getIconGlyph()	The icon glyph
Map<String,String>	getMetadata()	Get metadata
SitemapIcon.Condition	getMetadataCondition()	Get the metadata condition
int	getOrder()	Get order
Page.PageType	getPageType()	The page type
Map<String,String>	getProperties()	Get properties
SitemapIcon.Condition	getPropertiesCondition()	Get the metadata condition
List<String>	getTags()	The tags
SitemapIcon.Condition	getTagsCondition()	The tags condition
boolean	isLive()	Determines the live version
boolean	isRestricted()	Determines the limited access

Methods inherited from class java.lang.Object

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

Constructor Detail

SitemapIcon

public SitemapIcon()

Constructor

Method Detail

configure

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

Configure decoration

Parameters:

configuration - the configuration

iconPathPrefix - The prfeix of icon path

Throws:

ConfigurationException - if configuration is invalid

getIcon

public String getIcon()

The icon path

Returns:

The icon path. Can be null.

getIconGlyph

public String getIconGlyph()

The icon glyph

Returns:

The icon glyph. Can be null.

getIconDecorator

public String getIconDecorator()

The icon decorator

Returns:

The icon decorator

getMetadataCondition

public SitemapIcon.Condition getMetadataCondition()

Get the metadata condition

Returns:

the metadata condition

getTagsCondition

public SitemapIcon.Condition getTagsCondition()

The tags condition

Returns:

The tags condition

getPropertiesCondition

public SitemapIcon.Condition getPropertiesCondition()

Get the metadata condition

Returns:

the metadata condition

getTags

public List<String> getTags()

The tags

Returns:

The tags

getPageType

public Page.PageType getPageType()

The page type

Returns:

The page type

isLive

public boolean isLive()

Determines the live version

Returns:

true if this icon is for live version

isRestricted

public boolean isRestricted()

Determines the limited access

Returns:

true if this icon is for page with limited access

getMetadata

public Map<String,String> getMetadata()

Get metadata

Returns:

the metadata

getProperties

public Map<String,String> getProperties()

Get properties

Returns:

the properties

getOrder

public int getOrder()

Get order

Returns:

the order of this icon