Package org.ametys.plugins.forms.question.autofill

Class AbstractStaticAutoFillSource

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.question.autofill.AbstractStaticAutoFillSource

All Implemented Interfaces:

AutofillSource, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

CurrentUserAutoFillSource, CustomValueAutoFillSource, UDUserAutoFillSource

public abstract class AbstractStaticAutoFillSource
extends AbstractLogEnabled
implements AutofillSource, Serviceable, Configurable, PluginAware

Static class for creating AutofillSource from xml configuration

Field Summary

Fields

Modifier and Type	Field	Description
protected AutofillSourceExtensionPoint	_autoFillSourceExtensionPoint	The autofill source extension point
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected I18nizableText	_description	Description of computing type
protected FormElementDefinitionHelper	_formElementDefinitionHelper	The form element definition helper
protected String	_id	Id of computing type
protected I18nizableText	_label	Label of computing type
protected String	_pluginName	Forms
protected UserManager	_userManager	The users manager

Constructor Summary

Constructors

Constructor	Description
AbstractStaticAutoFillSource()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
I18nizableText	getDescription()	Get description of autofill source
String	getId()	Get id of the autofill source
I18nizableText	getLabel()	Get label of autofill source
void	saxAdditionalInfos(ContentHandler contentHandler, FormQuestion question)	Sax additional infos
void	service(ServiceManager manager)
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 org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.plugins.forms.question.autofill.AutofillSource

getAutofillValue, getModelItems, getViewElements, isCacheable

Field Details

_pluginName

protected String _pluginName

Forms

_id

protected String _id

Id of computing type

_label

protected I18nizableText _label

Label of computing type

_description

protected I18nizableText _description

Description of computing type

_autoFillSourceExtensionPoint

protected AutofillSourceExtensionPoint _autoFillSourceExtensionPoint

The autofill source extension point

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_userManager

protected UserManager _userManager

The users manager

_formElementDefinitionHelper

protected FormElementDefinitionHelper _formElementDefinitionHelper

The form element definition helper

Constructor Details

AbstractStaticAutoFillSource

public AbstractStaticAutoFillSource()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getId

public String getId()

Description copied from interface: AutofillSource

Get id of the autofill source

Specified by:

getId in interface AutofillSource

Returns:

the id

getLabel

public I18nizableText getLabel()

Description copied from interface: AutofillSource

Get label of autofill source

Specified by:

getLabel in interface AutofillSource

Returns:

the label

getDescription

public I18nizableText getDescription()

Description copied from interface: AutofillSource

Get description of autofill source

Specified by:

getDescription in interface AutofillSource

Returns:

the description

saxAdditionalInfos

public void saxAdditionalInfos(ContentHandler contentHandler,
 FormQuestion question)
                        throws SAXException

Description copied from interface: AutofillSource

Sax additional infos

Specified by:

saxAdditionalInfos in interface AutofillSource

Parameters:

contentHandler - the content handler

question - the question

Throws:

SAXException - if an error occurred