Package org.ametys.web.administration.welcome

Class AbstractWelcomeStep

java.lang.Object

org.ametys.web.administration.welcome.AbstractWelcomeStep

All Implemented Interfaces:

PluginAware, WelcomeStep, Configurable

Direct Known Subclasses:

CompleteConfigurationStep, CompleteSiteStep, SiteWithPopulationStep, SiteWithUserStep

public abstract class AbstractWelcomeStep
extends Object
implements WelcomeStep, Configurable, PluginAware

Absract WelcomeStep which is Configurable

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	_actions	The JS actions
protected I18nizableText	_description	The HTML description of the step
protected String[]	_images	The images
protected int	_order	The order of the step
protected String	_pluginName	The name of the plugin that has declared this component
protected Map<String,Set<String>>	_targetIds	The JS target ids to listen for messages
protected I18nizableText	_title	The HTML title of the step

Constructor Summary

Constructors

Constructor	Description
AbstractWelcomeStep()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
String[]	getActions()	Gets the JS actions to execute when clicking on '<a>' elements of description.
I18nizableText	getDescription()	Gets the text describing how to perform the step.
String[]	getImages()	Gets the paths of the images to insert in the '<img/>' elements of description.
Map<String,Set<String>>	getListenedTargetIds()	Gets the JS target ids (as regular expressions) to listen for each message type for potential changes in the steps and thus refresh the admin welcome tool.
int	getOrder()	Gets the order of the step.
I18nizableText	getTitle()	Gets the title of the step.
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.web.administration.welcome.WelcomeStep

isPerformed, toMap

Field Details

_pluginName

protected String _pluginName

The name of the plugin that has declared this component

_order

protected int _order

The order of the step

_title

protected I18nizableText _title

The HTML title of the step

_description

protected I18nizableText _description

The HTML description of the step

_actions

protected String[] _actions

The JS actions

_images

protected String[] _images

The images

_targetIds

protected Map<String,Set<String>> _targetIds

The JS target ids to listen for messages

Constructor Details

AbstractWelcomeStep

public AbstractWelcomeStep()

Method Details

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getTitle

public I18nizableText getTitle()

Description copied from interface: WelcomeStep

Gets the title of the step.

Specified by:

getTitle in interface WelcomeStep

Returns:

The title as HTML

getDescription

public I18nizableText getDescription()

Description copied from interface: WelcomeStep

Gets the text describing how to perform the step.

Specified by:

getDescription in interface WelcomeStep

Returns:

The description as HTML

getActions

public String[] getActions()

Description copied from interface: WelcomeStep

Gets the JS actions to execute when clicking on '<a>' elements of description.

Specified by:

getActions in interface WelcomeStep

Returns:

The JS actions to execute when clicking on '<a>' elements of description

getImages

public String[] getImages()

Description copied from interface: WelcomeStep

Gets the paths of the images to insert in the '<img/>' elements of description.

Specified by:

getImages in interface WelcomeStep

Returns:

The paths of the images to insert in the '<img/>' elements of description.

getListenedTargetIds

public Map<String,Set<String>> getListenedTargetIds()

Description copied from interface: WelcomeStep

Gets the JS target ids (as regular expressions) to listen for each message type for potential changes in the steps and thus refresh the admin welcome tool. For example, {"modified": ["^site$"], "deleted": ["^site$", "^user$"]}

Specified by:

getListenedTargetIds in interface WelcomeStep

Returns:

A map { messageType : [targetIds]}

getOrder

public int getOrder()

Description copied from interface: WelcomeStep

Gets the order of the step.

Specified by:

getOrder in interface WelcomeStep

Returns:

The order of the step