AdminWelcomeClientSideElement (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.web.administration.welcome.AdminWelcomeClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable
```
public class AdminWelcomeClientSideElement
extends StaticClientSideElement
```
Admin welcome client side element.

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 WelcomeStepExtensionPoint _welcomeStepEP
The WelcomeStep Extension Point
- Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement
  _currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors
Constructor Description

AdminWelcomeClientSideElement()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canOpenTool()`	Returns true if the tool can be opened.
`int`	`getCurrentStep()`	Gets the index of the current step, i.e.
`List<Map<String,Object>>`	`getSteps()`	Gets all the steps of the welcome tool, in the right order.
`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, 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
  - _welcomeStepEP
```
protected WelcomeStepExtensionPoint _welcomeStepEP
```
    The WelcomeStep Extension Point
- Constructor Detail
  - AdminWelcomeClientSideElement
```
public AdminWelcomeClientSideElement()
```
- Method Detail
  - service
```
public void service(ServiceManager smanager)
             throws ServiceException
```
    Specified by:
    
    service in interface Serviceable
    
    Overrides:
    
    service in class StaticFileImportsClientSideElement
    
    Throws:
    
    ServiceException
  - getSteps
```
public List<Map<String,Object>> getSteps()
```
    Gets all the steps of the welcome tool, in the right order.
    
    Returns:
    
    The steps.
  - getCurrentStep
```
public int getCurrentStep()
```
    Gets the index of the current step, i.e. the first step which is not performed yet. If all steps are performed, return -1
    
    Returns:
    
    The index of the current step.
  - canOpenTool
```
public boolean canOpenTool()
```
    Returns true if the tool can be opened.
    
    Returns:
    
    true if the tool can be opened.