Package org.ametys.plugins.forms.menu

Class FormWorkflowButtonMenu

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.core.ui.SimpleMenu

org.ametys.plugins.forms.menu.FormWorkflowButtonMenu

All Implemented Interfaces:

ClientSideElement, MenuClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class FormWorkflowButtonMenu
extends SimpleMenu

The form workflow button menu configuration class

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.core.ui.SimpleMenu

SimpleMenu.GalleryGroup, SimpleMenu.GalleryItem, SimpleMenu.UnresolvedItem

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

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkflowHelper	_workflowHelper	The workflow helper
static final String	BUTTON_EXTENSION_ID	The button extension id

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

_galleryItems, _menuItemManager, _menuItems, _primaryMenuItem, _ribbonControlManager, _smanager, _unresolvedMenuItems

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

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

Constructor Summary

Constructors

Constructor	Description
FormWorkflowButtonMenu()

Method Summary

Modifier and Type	Method	Description
protected Configuration	_getWorkflowItemConfiguration(String id, String workflowName)	Get the configuration for a workflow
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
void	reset()	Reset the workflow galery
void	service(ServiceManager serviceManager)

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

_addDependencies, _configureClass, _configureGalleries, _configureGroupGallery, _configureItemsMenu, _getGalleryItemManager, _getGalleryItems, _getGalleryItems, _getMenuItems, _initializeGalleryItemManager, configure, getReferencedClientSideElements, getRights

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

_configureParameters, _configureScript, configureInitialParameters

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

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, getDependencies, getId, getPluginName, 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

BUTTON_EXTENSION_ID

public static final String BUTTON_EXTENSION_ID

The button extension id

See Also:

• Constant Field Values

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper

Constructor Details

FormWorkflowButtonMenu

public FormWorkflowButtonMenu()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SimpleMenu

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 SimpleMenu

Parameters:

ignoreRights - True to ignore the rights verification.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

reset

public void reset()

Reset the workflow galery

_getWorkflowItemConfiguration

protected Configuration _getWorkflowItemConfiguration(String id,
 String workflowName)

Get the configuration for a workflow

Parameters:

id - the id of the button

workflowName - the workflow name. Can be null for no workflow configuration.

Returns:

The configuration