Package org.ametys.cms.properties.section.technical

Class AbstractTechnicalItem

java.lang.Object

org.ametys.cms.properties.section.technical.AbstractTechnicalItem

All Implemented Interfaces:

TechnicalItem, PluginAware, Prioritizable, Supporter<AmetysObject>, Configurable

Direct Known Subclasses:

AbstractLanguageItem, AmetysObjectIdItem, AmetysObjectNameItem, AmetysObjectWorkflowItem, ContentDateItem, ContentSCCItem, ContentTypeItem, ContentVersionItem, PagePathItem, PageSiteItem, ResourceFileItem, ResourceKeywordsItem, ResourceUpdateItem

public abstract class AbstractTechnicalItem
extends Object
implements TechnicalItem, Configurable, PluginAware

Abstract implementation of TechnicalItem to make priority and XSL configurable.

Constructor Summary

Constructors

Constructor	Description
AbstractTechnicalItem()

Method Summary

Modifier and Type	Method	Description
protected String	_getDefaultXSLT()	The default XSL if not defined in the configuration.
void	configure(Configuration configuration)
String	getId()	Get the identifier of the technical item
int	getPriority()	Get the priority for the component.
String	getXSLT()	Path to the XSL to render the section item.
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.runtime.plugin.component.Supporter

supports

Methods inherited from interface org.ametys.cms.properties.section.technical.TechnicalItem

buildData

Constructor Details

AbstractTechnicalItem

public AbstractTechnicalItem()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

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: TechnicalItem

Get the identifier of the technical item

Specified by:

getId in interface TechnicalItem

Returns:

the identifier

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

getXSLT

public String getXSLT()

Description copied from interface: TechnicalItem

Path to the XSL to render the section item. It is recommended to use the 'view' protocol, with a plugin, like view:myplugin://stylesheets/properties/filename.xsl

Specified by:

getXSLT in interface TechnicalItem

Returns:

The XSL path

_getDefaultXSLT

protected String _getDefaultXSLT()

The default XSL if not defined in the configuration. Not mandatory to implement this method but if there is not XSLT configured for the section, the loading will failed.

Returns:

The default XSL path