Package org.ametys.web.clientsideelement

Class SiteSelectionAwareAddTaskClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.core.ui.AddTaskClientSideElement

org.ametys.core.ui.SelectionAwareAddTaskClientSideElement

org.ametys.web.clientsideelement.SiteSelectionAwareAddTaskClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Contextualizable, Serviceable

public class SiteSelectionAwareAddTaskClientSideElement
extends SelectionAwareAddTaskClientSideElement

This implementation creates an site-selection aware element for adding a new task which need a site parameter (called 'siteName')

Nested Class Summary

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

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

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

_context, _scheduler

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

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

Constructor Summary

Constructors

Constructor	Description
SiteSelectionAwareAddTaskClientSideElement()

Method Summary

Modifier and Type	Method	Description
protected String	_configureClass(Configuration configuration)	Configure the js class name
protected ClientSideElement.Script	_configureScript(Configuration configuration)	Configure the script
protected Map<String,Object>	configureInitialParameters(Configuration configuration)	Configure the initial parameters
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.

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

_configureDependencies, add, contextualize, getDependencies, getParameters, service

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

_configureParameters

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

_configureImports, _configureRights, _configureRightsMode, configure, 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

Constructor Details

SiteSelectionAwareAddTaskClientSideElement

public SiteSelectionAwareAddTaskClientSideElement()

Method Details

_configureClass

protected String _configureClass(Configuration configuration)
                          throws ConfigurationException

Description copied from class: StaticClientSideElement

Configure the js class name

Overrides:

_configureClass in class SelectionAwareAddTaskClientSideElement

Parameters:

configuration - The configuration on action tag

Returns:

The js class name

Throws:

ConfigurationException - If an error occurs

configureInitialParameters

protected Map<String,Object> configureInitialParameters(Configuration configuration)
                                                 throws ConfigurationException

Description copied from class: StaticClientSideElement

Configure the initial parameters

Overrides:

configureInitialParameters in class SelectionAwareAddTaskClientSideElement

Parameters:

configuration - the global configuration

Returns:

The initial parameters read

Throws:

ConfigurationException - The configuration is incorrect

_configureScript

protected ClientSideElement.Script _configureScript(Configuration configuration)
                                             throws ConfigurationException

Description copied from class: StaticFileImportsClientSideElement

Configure the script

Overrides:

_configureScript in class SelectionAwareAddTaskClientSideElement

Parameters:

configuration - the global configuration

Returns:

The script created

Throws:

ConfigurationException - The configuration is incorrect

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.