WelcomeToolClientSideElement (Ametys 4.4.x - API)

java.lang.Object
- org.ametys.runtime.plugin.component.AbstractLogEnabled
- - org.ametys.core.ui.StaticFileImportsClientSideElement
  - - org.ametys.core.ui.StaticClientSideElement
    - - org.ametys.cms.welcome.WelcomeToolClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable
```
public class WelcomeToolClientSideElement
extends StaticClientSideElement
```
A StaticClientSideElement that override getScript to return canDisplayWelcomeTool to true/false if something can be displayed in the welcome tool

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 WelcomeHelper _welcomeHelper
Welcome helper
- Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement
  _currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors
Constructor Description

WelcomeToolClientSideElement()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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)`

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, configure, 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 Detail
  - _welcomeHelper
```
protected WelcomeHelper _welcomeHelper
```
    Welcome helper
- Constructor Detail
  - WelcomeToolClientSideElement
```
public WelcomeToolClientSideElement()
```
- Method Detail
  - service
```
public void service(ServiceManager smanager)
             throws ServiceException
```
    Specified by:
    
    service in interface Serviceable
    
    Overrides:
    
    service in class StaticFileImportsClientSideElement
    
    Throws:
    
    ServiceException
  - 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.