Class ActionEditor<T>

A factory that assists in editing an action

Type Parameters

T extends IActionConfiguration = IActionConfiguration

Hierarchy (View Summary)

ActionEditor
- EndableActionEditor

Index

Constructors

constructor

new ActionEditor<T extends IActionConfiguration = IActionConfiguration>(
actionConfig: T,
configurationFactory: ConfigurationFactory,
): ActionEditor<T>
Type Parameters
- T extends IActionConfiguration = IActionConfiguration
Parameters
- actionConfig: T
- configurationFactory: ConfigurationFactory
Returns ActionEditor<T>
- Defined in configuration/api/action-editor.ts:36

Properties

`Protected`actionConfig

actionConfig: T

`Protected` `Readonly`configurationFactory

configurationFactory: ConfigurationFactory

Methods

addStartOperation

addStartOperation(
    systemName:
        | "forEach"
        | "animate"
        | "removeClass"
        | "endForEach"
        | "log"
        | "when"
        | "endWhen"
        | "otherwise"
        | "addClass"
        | "addControllerToElement"
        | "addGlobalsToOperation"
        | "animateWithClass"
        | "breakForEach"
        | "broadcastEvent"
        | "calc"
        | "clearElement"
        | "clearOperationData"
        | "continueForEach"
        | "createElement"
        | "customFunction"
        | "endAction"
        | "extendController"
        | "getAttributesFromElement"
        | "getControllerFromElement"
        | "getControllerInstance"
        | "getElementDimensions"
        | "getImport"
        | "getQueryParams"
        | "invokeObjectMethod"
        | "loadJson"
        | "math"
        | "removeControllerFromElement"
        | "removeElement"
        | "removePropertiesFromOperationData"
        | "reparentElement"
        | "requestAction"
        | "selectElement"
        | "setData"
        | "setElementAttributes"
        | "setElementContent"
        | "setGlobalData"
        | "setOperationData"
        | "setStyle"
        | "setVariable"
        | "startAction"
        | "toggleClass"
        | "toggleElement"
        | "wait",
    operationData: TOperationData,
    id?: string,
): OperationEditor<ActionEditor<T>, TOperation<TOperationData>>
Adds the operation data for a start operation specified by the given system name
Parameters
- systemName:
      | "forEach"
      | "animate"
      | "removeClass"
      | "endForEach"
      | "log"
      | "when"
      | "endWhen"
      | "otherwise"
      | "addClass"
      | "addControllerToElement"
      | "addGlobalsToOperation"
      | "animateWithClass"
      | "breakForEach"
      | "broadcastEvent"
      | "calc"
      | "clearElement"
      | "clearOperationData"
      | "continueForEach"
      | "createElement"
      | "customFunction"
      | "endAction"
      | "extendController"
      | "getAttributesFromElement"
      | "getControllerFromElement"
      | "getControllerInstance"
      | "getElementDimensions"
      | "getImport"
      | "getQueryParams"
      | "invokeObjectMethod"
      | "loadJson"
      | "math"
      | "removeControllerFromElement"
      | "removeElement"
      | "removePropertiesFromOperationData"
      | "reparentElement"
      | "requestAction"
      | "selectElement"
      | "setData"
      | "setElementAttributes"
      | "setElementContent"
      | "setGlobalData"
      | "setOperationData"
      | "setStyle"
      | "setVariable"
      | "startAction"
      | "toggleClass"
      | "toggleElement"
      | "wait"
- operationData: TOperationData
- id: string = ...
Returns OperationEditor<ActionEditor<T>, TOperation<TOperationData>>
- Defined in configuration/api/action-editor.ts:121

addStartOperationByType

addStartOperationByType<T extends TOperation<TOperationData>>(
operationClass: T,
operationData: Partial<ExtractOperationDataType<T>>,
): OperationEditor<ActionEditor<T>, T>
Adds the operation data for a start operation specified by the given type
Type Parameters
- T extends TOperation<TOperationData>
Parameters
- operationClass: T
- operationData: Partial<ExtractOperationDataType<T>>
Returns OperationEditor<ActionEditor<T>, T>
- Defined in configuration/api/action-editor.ts:94

editStartOperation

editStartOperation(
id: string,
): OperationEditor<ActionEditor<T>, TOperation<TOperationData>>
Starts an editor for the start operation associated with the given id
Parameters
- id: string
Returns OperationEditor<ActionEditor<T>, TOperation<TOperationData>>
- Defined in configuration/api/action-editor.ts:160

getConfiguration

getConfiguration(callBack: (config: T) => T | undefined): ActionEditor<T>
Returns a copy of the current internal state of the factory
Parameters
- callBack: (config: T) => T | undefined
Returns ActionEditor<T>
- Defined in configuration/api/action-editor.ts:52

getName

getName(): string
Gets the action name

Returns string
- Defined in configuration/api/action-editor.ts:82

moveStartOperation

moveStartOperation(id: string, direction: "up" | "down"): ActionEditor<T>
Moves the start operation associated with the given id in the given direction
Parameters
- id: string
- direction: "up" | "down"
Returns ActionEditor<T>
- Defined in configuration/api/action-editor.ts:212

next(): ConfigurationFactory
Return the fluent scopt to the ConfigurationFactory

Returns ConfigurationFactory
- Defined in configuration/api/action-editor.ts:242

removeStartOperation

removeStartOperation(id: string): ActionEditor<T>
Removes the start operation associated with the given id
Parameters
- id: string
Returns ActionEditor<T>
- Defined in configuration/api/action-editor.ts:181

setName

setName(name: string): ActionEditor<T>
Sets the action name
Parameters
- name: string
Returns ActionEditor<T>
- Defined in configuration/api/action-editor.ts:68

updateConfiguration

updateConfiguration(): void
Returns void
- Defined in configuration/api/action-editor.ts:41

Class ActionEditor<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ActionEditor<T>

Properties

ProtectedactionConfig

Protected ReadonlyconfigurationFactory

Methods

addStartOperation

Parameters

Returns OperationEditor<ActionEditor<T>, TOperation<TOperationData>>

addStartOperationByType

Type Parameters

Parameters

Returns OperationEditor<ActionEditor<T>, T>

editStartOperation

Parameters

Returns OperationEditor<ActionEditor<T>, TOperation<TOperationData>>

getConfiguration

Parameters

Returns ActionEditor<T>

getName

Returns string

moveStartOperation

Parameters

Returns ActionEditor<T>

next

Returns ConfigurationFactory

removeStartOperation

Parameters

Returns ActionEditor<T>

setName

Parameters

Returns ActionEditor<T>

updateConfiguration

Returns void

Settings

On This Page

`Protected`actionConfig

`Protected` `Readonly`configurationFactory