Package org.ametys.cms.tag
Class StaticTagTargetType
java.lang.Object
org.ametys.cms.tag.StaticTagTargetType
- All Implemented Interfaces:
TagTargetType
,PluginAware
,Configurable
Class representing a static tag target type.
-
Field Summary
Modifier and TypeFieldDescriptionprotected I18nizableText
The descriptionprotected String
The feature nameprotected I18nizableText
The labelprotected String
The nameprotected String
The plugin name -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
configure
(Configuration configuration) protected I18nizableText
configureDescription
(Configuration configuration, String defaultCatalogue) Configure description from the passed configurationprotected I18nizableText
configureLabel
(Configuration configuration, String defaultCatalogue) Configure label from the passed configurationReturns the type's description.getLabel()
Returns the type's label.getName()
Returns the type's name.Get the plugin namevoid
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.
-
Field Details
-
_name
The name -
_label
The label -
_description
The description -
_pluginName
The plugin name -
_featureName
The feature name
-
-
Constructor Details
-
StaticTagTargetType
public StaticTagTargetType()
-
-
Method Details
-
setPluginInfo
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 interfacePluginAware
- Parameters:
pluginName
- Unique identifier for the plugin hosting the extensionfeatureName
- Unique feature identifier (unique for a given pluginName)id
- Unique identifier of this component
-
getPluginName
Get the plugin name- Returns:
- the plugin name
-
configure
- Specified by:
configure
in interfaceConfigurable
- Throws:
ConfigurationException
-
getName
Description copied from interface:TagTargetType
Returns the type's name.- Specified by:
getName
in interfaceTagTargetType
- Returns:
- the type's name.
-
getLabel
Description copied from interface:TagTargetType
Returns the type's label.- Specified by:
getLabel
in interfaceTagTargetType
- Returns:
- the type's label.
-
getDescription
Description copied from interface:TagTargetType
Returns the type's description.- Specified by:
getDescription
in interfaceTagTargetType
- Returns:
- the type's description.
-
configureLabel
protected I18nizableText configureLabel(Configuration configuration, String defaultCatalogue) throws ConfigurationException Configure label from the passed configuration- Parameters:
configuration
- The configurationdefaultCatalogue
- 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 configurationdefaultCatalogue
- The default catalogue- Returns:
- The description
- Throws:
ConfigurationException
- If an error occurred
-