Package org.ametys.web.clientsideelement

Class ConfigureViewParametersClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.web.clientsideelement.AbstractPageClientSideElement

org.ametys.web.clientsideelement.AbstractSitemapElementClientSideElement

org.ametys.web.clientsideelement.ConfigureViewParametersClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class ConfigureViewParametersClientSideElement
extends AbstractSitemapElementClientSideElement

This client side handles a controller enabled if the active page has at least one view parameter.

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 SkinsManager	_skinsManager	The skins manager
protected ViewParametersManager	_viewParametersManager	The view parameters manager

Fields inherited from class org.ametys.web.clientsideelement.AbstractPageClientSideElement

_resolver, _synchronizeComponent

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

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

Constructor Summary

Constructors

Constructor	Description
ConfigureViewParametersClientSideElement()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
Map<String,Object>	getStatus(String pageId, String zoneName, String zoneItemId)	Get the status of the page for the view parameters
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.web.clientsideelement.AbstractSitemapElementClientSideElement

getAllRightSitemapDescription, getAllRightSitemapElementDescription, getNoRightSitemapDescription, getNoRightSitemapElementDescription, getSitemapDefaultParameters, getSitemapElementDefaultParameters, getSitemapTitle

Methods inherited from class org.ametys.web.clientsideelement.AbstractPageClientSideElement

getAllRightPageDescription, getNoModifiablePageDescription, getNoRightPageDescription, getPageDefaultParameters, hasRight

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

_skinsManager

protected SkinsManager _skinsManager

The skins manager

_viewParametersManager

protected ViewParametersManager _viewParametersManager

The view parameters manager

Constructor Details

ConfigureViewParametersClientSideElement

public ConfigureViewParametersClientSideElement()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSitemapElementClientSideElement

Throws:

ServiceException

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.

getStatus

public Map<String,Object> getStatus(String pageId,
 String zoneName,
 String zoneItemId)

Get the status of the page for the view parameters

Parameters:

pageId - the page id

zoneName - the zone name

zoneItemId - the id of the zone item

Returns:

the status for the page view parameters