org.ametys.web.repository.site

Class DefaultSiteType

java.lang.Object

org.ametys.web.repository.site.DefaultSiteType

All Implemented Interfaces:

PluginAware, SiteType, Configurable, Serviceable, ThreadSafe

Direct Known Subclasses:

ProjectWorkspaceSiteType

public class DefaultSiteType
extends Object
implements SiteType, Configurable, PluginAware, ThreadSafe, Serviceable

Type of site which is retrieved from a XML configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected I18nizableText	_description Description.
protected String	_iconGlyph Glyph icon
protected String	_id Site type id.
protected I18nizableText	_label Label.
protected String	_largeIcon Large icon URI 48x48.
protected String	_mediumIcon Medium icon URI 32x32.
protected String	_name Site type name.
protected String	_pluginName Plugin name.
protected String	_smallIcon Small icon URI 16x16.
protected SourceResolver	_srcResolver The source resolver

Fields inherited from interface org.ametys.web.repository.site.SiteType

DEFAULT_SITE_TYPE_ID

Constructor Summary

Constructors

Constructor and Description
DefaultSiteType()

Method Summary

Modifier and Type	Method and Description
protected I18nizableText	_parseI18nizableText(Configuration config, String name) Parse an i18n text.
protected String	_parseIcon(Configuration configuration, String name) Parse an icon path
void	configure(Configuration configuration)
I18nizableText	getDescription() Retrieves the description of the site type.
String	getIconGlyph() Retrieves the CSS class to use for glyph icon
String	getId() Retrieves the id of the site type.
I18nizableText	getLabel() Retrieves the label of the site type.
String	getLargeIcon() Retrieves the URL of the icon without the context path.
String	getMediumIcon() Retrieves the URL of the icon without the context path.
String	getName() Retrieves the name of the site type.
String	getPluginName() Retrieves the name of the plugin declaring this site type.
String	getSmallIcon() Retrieves the URL of the icon without the context path.
void	service(ServiceManager smanager)
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 java.lang.Object

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

Methods inherited from interface org.ametys.web.repository.site.SiteType

isPrivateType, siteInitiallyRestricted

Field Detail

_pluginName

protected String _pluginName

Plugin name.

_id

protected String _id

Site type id.

_name

protected String _name

Site type name.

_label

protected I18nizableText _label

Label.

_description

protected I18nizableText _description

Description.

_iconGlyph

protected String _iconGlyph

Glyph icon

_smallIcon

protected String _smallIcon

Small icon URI 16x16.

_mediumIcon

protected String _mediumIcon

Medium icon URI 32x32.

_largeIcon

protected String _largeIcon

Large icon URI 48x48.

_srcResolver

protected SourceResolver _srcResolver

The source resolver

Constructor Detail

DefaultSiteType

public DefaultSiteType()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getId

public String getId()

Description copied from interface: SiteType

Retrieves the id of the site type.

Specified by:

getId in interface SiteType

Returns:

the id.

getName

public String getName()

Description copied from interface: SiteType

Retrieves the name of the site type.

Specified by:

getName in interface SiteType

Returns:

the name.

getLabel

public I18nizableText getLabel()

Description copied from interface: SiteType

Retrieves the label of the site type.

Specified by:

getLabel in interface SiteType

Returns:

the label.

getDescription

public I18nizableText getDescription()

Description copied from interface: SiteType

Retrieves the description of the site type.

Specified by:

getDescription in interface SiteType

Returns:

the description.

getIconGlyph

public String getIconGlyph()

Description copied from interface: SiteType

Retrieves the CSS class to use for glyph icon

Specified by:

getIconGlyph in interface SiteType

Returns:

the glyph name.

getLargeIcon

public String getLargeIcon()

Description copied from interface: SiteType

Retrieves the URL of the icon without the context path.

Specified by:

getLargeIcon in interface SiteType

Returns:

the icon URL for the large image 48x48.

getMediumIcon

public String getMediumIcon()

Description copied from interface: SiteType

Retrieves the URL of the icon without the context path.

Specified by:

getMediumIcon in interface SiteType

Returns:

the icon URL for the medium sized image 32x32.

getSmallIcon

public String getSmallIcon()

Description copied from interface: SiteType

Retrieves the URL of the icon without the context path.

Specified by:

getSmallIcon in interface SiteType

Returns:

the icon URL for the small image 16x16.

getPluginName

public String getPluginName()

Description copied from interface: SiteType

Retrieves the name of the plugin declaring this site type.

Specified by:

getPluginName in interface SiteType

Returns:

the name of the plugin.

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

_parseI18nizableText

protected I18nizableText _parseI18nizableText(Configuration config,
                                              String name)
                                       throws ConfigurationException

Parse an i18n text.

Parameters:

config - the configuration to use.

name - the child name.

Returns:

the i18n text.

Throws:

ConfigurationException - if the configuration is not valid.

_parseIcon

protected String _parseIcon(Configuration configuration,
                            String name)
                     throws ConfigurationException

Parse an icon path

Parameters:

configuration - the configuration to use

name - the child name.

Returns:

The icon path

Throws:

ConfigurationException - if the configuration is not valid.