Package org.ametys.cms.clientsideelement

Class SimpleSearchClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.cms.clientsideelement.SimpleSearchClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Disposable, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

ScriptToolClientSideElement

public class SimpleSearchClientSideElement
extends StaticClientSideElement
implements Contextualizable, Disposable

Simple Search tool HMI item. Only SAX content type enumerator values. TODO To remove

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The context.
protected ThreadSafeComponentManager<Enumerator>	_enumeratorManager	Manager component for enumerators
protected ServiceManager	_manager	The service manager

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
SimpleSearchClientSideElement()

Method Summary

Modifier and Type	Method	Description
protected String	_configureContentTypeEnumerator()	Configures the content type enumerator
void	configure(Configuration configuration)
void	contextualize(Context context)
void	dispose()
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
void	service(ServiceManager smanager)
protected void	setEnumeratorValues(ClientSideElement.Script script, Enumerator enumerator, String prefix)	Set the enumerator values in script parameters

Methods inherited from class org.ametys.core.ui.StaticClientSideElement

_configureClass, _configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, getDependencies, getId, getPluginName, getRights, getScripts, hasRight, setPluginInfo, toString

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, wait, wait, wait

Field Details

_enumeratorManager

protected ThreadSafeComponentManager<Enumerator> _enumeratorManager

Manager component for enumerators

_manager

protected ServiceManager _manager

The service manager

_context

protected Context _context

The context.

Constructor Details

SimpleSearchClientSideElement

public SimpleSearchClientSideElement()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class StaticFileImportsClientSideElement

Throws:

ConfigurationException

getScripts

public List<ClientSideElement.Script> getScripts(boolean ignoreRights,
 Map<String,Object> contextParameters)

Description copied from interface: ClientSideElement

This method return the scripts that will be used on client side. This class will be parametrized by initial and current parameters.

Specified by:

getScripts in interface ClientSideElement

Overrides:

getScripts in class StaticFileImportsClientSideElement

Parameters:

ignoreRights - True to ignore the rights verification.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

_configureContentTypeEnumerator

protected String _configureContentTypeEnumerator()
                                          throws ConfigurationException

Configures the content type enumerator

Returns:

The content type enumerator role

Throws:

ConfigurationException - If the configuration has an issue

setEnumeratorValues

protected void setEnumeratorValues(ClientSideElement.Script script,
 Enumerator enumerator,
 String prefix)
                            throws Exception

Set the enumerator values in script parameters

Parameters:

script - The script into which set the parameters

enumerator - The enumerator

prefix - The parameters prefix

Throws:

Exception - If the enumerator has an issue

dispose

public void dispose()

Specified by:

dispose in interface Disposable