Package org.ametys.cms.tag

Class StaticTagTargetType

java.lang.Object

org.ametys.cms.tag.StaticTagTargetType

All Implemented Interfaces:

TagTargetType, PluginAware, Configurable

public class StaticTagTargetType
extends Object
implements TagTargetType, Configurable, PluginAware

Class representing a static tag target type.

Field Summary

Fields

Modifier and Type	Field	Description
protected I18nizableText	_description	The description
protected String	_featureName	The feature name
protected I18nizableText	_label	The label
protected String	_name	The name
protected String	_pluginName	The plugin name

Constructor Summary

Constructors

Constructor	Description
StaticTagTargetType()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
protected I18nizableText	configureDescription(Configuration configuration, String defaultCatalogue)	Configure description from the passed configuration
protected I18nizableText	configureLabel(Configuration configuration, String defaultCatalogue)	Configure label from the passed configuration
I18nizableText	getDescription()	Returns the type's description.
I18nizableText	getLabel()	Returns the type's label.
String	getName()	Returns the type's name.
String	getPluginName()	Get the plugin name
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

Field Details

_name

protected String _name

The name

_label

protected I18nizableText _label

The label

_description

protected I18nizableText _description

The description

_pluginName

protected String _pluginName

The plugin name

_featureName

protected String _featureName

The feature name

Constructor Details

StaticTagTargetType

public StaticTagTargetType()

Method Details

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

getPluginName

public String getPluginName()

Get the plugin name

Returns:

the plugin name

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getName

public String getName()

Description copied from interface: TagTargetType

Returns the type's name.

Specified by:

getName in interface TagTargetType

Returns:

the type's name.

getLabel

public I18nizableText getLabel()

Description copied from interface: TagTargetType

Returns the type's label.

Specified by:

getLabel in interface TagTargetType

Returns:

the type's label.

getDescription

public I18nizableText getDescription()

Description copied from interface: TagTargetType

Returns the type's description.

Specified by:

getDescription in interface TagTargetType

Returns:

the type's description.

configureLabel

protected I18nizableText configureLabel(Configuration configuration,
 String defaultCatalogue)
                                 throws ConfigurationException

Configure label from the passed configuration

Parameters:

configuration - The configuration

defaultCatalogue - The default catalogue

Returns:

The label

Throws:

ConfigurationException - If an error occurred

configureDescription

protected I18nizableText configureDescription(Configuration configuration,
 String defaultCatalogue)
                                       throws ConfigurationException

Configure description from the passed configuration

Parameters:

configuration - The configuration

defaultCatalogue - The default catalogue

Returns:

The description

Throws:

ConfigurationException - If an error occurred