Class FormEntriesWorkflowStepsClientSideElement
java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.core.ui.StaticFileImportsClientSideElement
org.ametys.cms.clientsideelement.WorkflowStepsClientSideElement
org.ametys.plugins.forms.workflow.FormEntriesWorkflowStepsClientSideElement
- All Implemented Interfaces:
ClientSideElement
,MenuClientSideElement
,LogEnabled
,PluginAware
,Configurable
,Serviceable
This class creates multiple toggle buttons each representing a workflow step on form entries
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement
ClientSideElement.Script, ClientSideElement.ScriptFile
-
Field Summary
Modifier and TypeFieldDescriptionprotected FormPropertiesManager
The manager for the forms JCR representationprotected FormTableManager
The manager for the forms SQL tablesFields inherited from class org.ametys.cms.clientsideelement.WorkflowStepsClientSideElement
_contentHelper, _menuItemManager, _menuItems, _referencedClientSideElement, _resolver, _scripts, _smanager, _unresolvedMenuItems, _userManager, _workflowHelper, _workflowProvider
Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement
_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
_additionalMenuItemConfiguration
(Configuration itemConf, DefaultConfiguration classConf, int actionId, Map<String, Object> parameters) Additional configuration for menu itemsprotected void
_configureDefaultDescriptions
(Map<String, Object> parameters) Configure the default descriptionprotected ClientSideElement.Script
_configureScript
(Configuration configuration) Configure the scriptprotected void
_configureWorkflowStep
(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor, Integer stepId, Map<String, Object> stepParameters, Configuration stepConfiguration, List<Integer> allowedActionIds) Configure the parameters specific to the workflow, for the given stepprotected String
Get the default class name for workflow actionprotected String
Get the default class name for workflow menuprotected String
Get the default plugin nameprotected String
Get the selection target id (can be a Regexp)getWorkflowState
(List<Integer> entryIds, String formId, String scriptId) Get the workflow state of contentsvoid
service
(ServiceManager serviceManager) Methods inherited from class org.ametys.cms.clientsideelement.WorkflowStepsClientSideElement
_configureMenuItems, _configureParameters, _configureScripts, _configureWorkflow, _configureWorkflowStepActions, _getAllowedActions, _getAllowedSteps, configure, getReferencedClientSideElements, getScripts, getWorkflowState
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
-
Field Details
-
_formPropertiesManager
The manager for the forms JCR representation -
_formTableManager
The manager for the forms SQL tables
-
-
Constructor Details
-
FormEntriesWorkflowStepsClientSideElement
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Overrides:
service
in classWorkflowStepsClientSideElement
- Throws:
ServiceException
-
_getDefaultMenuClassName
Description copied from class:WorkflowStepsClientSideElement
Get the default class name for workflow menu- Overrides:
_getDefaultMenuClassName
in classWorkflowStepsClientSideElement
- Returns:
- the default class name
-
_getDefaultActionClassName
Description copied from class:WorkflowStepsClientSideElement
Get the default class name for workflow action- Overrides:
_getDefaultActionClassName
in classWorkflowStepsClientSideElement
- Returns:
- the default class name
-
_configureWorkflowStep
protected void _configureWorkflowStep(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor, Integer stepId, Map<String, Object> stepParameters, Configuration stepConfiguration, List<Integer> allowedActionIds) throws ConfigurationExceptionDescription copied from class:WorkflowStepsClientSideElement
Configure the parameters specific to the workflow, for the given step- Overrides:
_configureWorkflowStep
in classWorkflowStepsClientSideElement
- Parameters:
workflowDescriptor
- The descriptor of the workflowstepId
- The stepstepParameters
- The parameters of the stepstepConfiguration
- The step configurationallowedActionIds
- The list of globally allowed actions- Throws:
ConfigurationException
- If an error occurs
-
_configureScript
protected ClientSideElement.Script _configureScript(Configuration configuration) throws ConfigurationException Description copied from class:StaticFileImportsClientSideElement
Configure the script- Overrides:
_configureScript
in classWorkflowStepsClientSideElement
- Parameters:
configuration
- the global configuration- Returns:
- The script created
- Throws:
ConfigurationException
- The configuration is incorrect
-
_getSelectionTargetId
Description copied from class:WorkflowStepsClientSideElement
Get the selection target id (can be a Regexp)- Overrides:
_getSelectionTargetId
in classWorkflowStepsClientSideElement
- Returns:
- the selection target id
-
_getDefaultPluginName
Description copied from class:WorkflowStepsClientSideElement
Get the default plugin name- Overrides:
_getDefaultPluginName
in classWorkflowStepsClientSideElement
- Returns:
- the default plugin name
-
_additionalMenuItemConfiguration
protected void _additionalMenuItemConfiguration(Configuration itemConf, DefaultConfiguration classConf, int actionId, Map<String, Object> parameters) Description copied from class:WorkflowStepsClientSideElement
Additional configuration for menu items- Overrides:
_additionalMenuItemConfiguration
in classWorkflowStepsClientSideElement
- Parameters:
itemConf
- The item configurationclassConf
- The class configurationactionId
- The workflow action idparameters
- The script parameters
-
_configureDefaultDescriptions
Description copied from class:WorkflowStepsClientSideElement
Configure the default description- Overrides:
_configureDefaultDescriptions
in classWorkflowStepsClientSideElement
- Parameters:
parameters
- The parameters
-
getWorkflowState
Get the workflow state of contents- Parameters:
entryIds
- The ids of the selected entriesformId
- The id of the formscriptId
- The id of the script- Returns:
- The workflow state as a map
-