Skip to content

rune-langium / visual-editor/src / EnumFormActions

Interface: EnumFormActions ​

Defined in: packages/visual-editor/src/types.ts:308

Enum-specific editor actions.

Extends ​

Methods ​

addAnnotation() ​

ts
addAnnotation(nodeId, annotationName): void;

Defined in: packages/visual-editor/src/types.ts:267

Parameters ​

ParameterType
nodeIdstring
annotationNamestring

Returns ​

void

Inherited from ​

CommonFormActions.addAnnotation


addCondition() ​

ts
addCondition(nodeId, condition): void;

Defined in: packages/visual-editor/src/types.ts:269

Parameters ​

ParameterType
nodeIdstring
condition{ definition?: string; expressionText: string; isPostCondition?: boolean; name?: string; }
condition.definition?string
condition.expressionTextstring
condition.isPostCondition?boolean
condition.name?string

Returns ​

void

Inherited from ​

CommonFormActions.addCondition


addEnumValue() ​

ts
addEnumValue(
   nodeId, 
   valueName, 
   displayName?): void;

Defined in: packages/visual-editor/src/types.ts:309

Parameters ​

ParameterType
nodeIdstring
valueNamestring
displayName?string

Returns ​

void


addSynonym() ​

ts
addSynonym(nodeId, synonym): void;

Defined in: packages/visual-editor/src/types.ts:265

Parameters ​

ParameterType
nodeIdstring
synonymstring

Returns ​

void

Inherited from ​

CommonFormActions.addSynonym


deleteType() ​

ts
deleteType(nodeId): void;

Defined in: packages/visual-editor/src/types.ts:262

Parameters ​

ParameterType
nodeIdstring

Returns ​

void

Inherited from ​

CommonFormActions.deleteType


removeAnnotation() ​

ts
removeAnnotation(nodeId, index): void;

Defined in: packages/visual-editor/src/types.ts:268

Parameters ​

ParameterType
nodeIdstring
indexnumber

Returns ​

void

Inherited from ​

CommonFormActions.removeAnnotation


removeCondition() ​

ts
removeCondition(nodeId, index): void;

Defined in: packages/visual-editor/src/types.ts:278

Parameters ​

ParameterType
nodeIdstring
indexnumber

Returns ​

void

Inherited from ​

CommonFormActions.removeCondition


removeEnumValue() ​

ts
removeEnumValue(nodeId, valueName): void;

Defined in: packages/visual-editor/src/types.ts:310

Parameters ​

ParameterType
nodeIdstring
valueNamestring

Returns ​

void


removeSynonym() ​

ts
removeSynonym(nodeId, index): void;

Defined in: packages/visual-editor/src/types.ts:266

Parameters ​

ParameterType
nodeIdstring
indexnumber

Returns ​

void

Inherited from ​

CommonFormActions.removeSynonym


renameType() ​

ts
renameType(nodeId, newName): void;

Defined in: packages/visual-editor/src/types.ts:261

Parameters ​

ParameterType
nodeIdstring
newNamestring

Returns ​

void

Inherited from ​

CommonFormActions.renameType


reorderCondition() ​

ts
reorderCondition(
   nodeId, 
   fromIndex, 
   toIndex): void;

Defined in: packages/visual-editor/src/types.ts:288

Parameters ​

ParameterType
nodeIdstring
fromIndexnumber
toIndexnumber

Returns ​

void

Inherited from ​

CommonFormActions.reorderCondition


reorderEnumValue() ​

ts
reorderEnumValue(
   nodeId, 
   fromIndex, 
   toIndex): void;

Defined in: packages/visual-editor/src/types.ts:312

Parameters ​

ParameterType
nodeIdstring
fromIndexnumber
toIndexnumber

Returns ​

void


setEnumParent() ​

ts
setEnumParent(nodeId, parentId): void;

Defined in: packages/visual-editor/src/types.ts:313

Parameters ​

ParameterType
nodeIdstring
parentIdstring | null

Returns ​

void


updateComments() ​

ts
updateComments(nodeId, comments): void;

Defined in: packages/visual-editor/src/types.ts:264

Parameters ​

ParameterType
nodeIdstring
commentsstring

Returns ​

void

Inherited from ​

CommonFormActions.updateComments


updateCondition() ​

ts
updateCondition(
   nodeId, 
   index, 
   updates): void;

Defined in: packages/visual-editor/src/types.ts:279

Parameters ​

ParameterType
nodeIdstring
indexnumber
updates{ definition?: string; expressionText?: string; name?: string; }
updates.definition?string
updates.expressionText?string
updates.name?string

Returns ​

void

Inherited from ​

CommonFormActions.updateCondition


updateDefinition() ​

ts
updateDefinition(nodeId, definition): void;

Defined in: packages/visual-editor/src/types.ts:263

Parameters ​

ParameterType
nodeIdstring
definitionstring

Returns ​

void

Inherited from ​

CommonFormActions.updateDefinition


updateEnumValue() ​

ts
updateEnumValue(
   nodeId, 
   oldName, 
   newName, 
   displayName?): void;

Defined in: packages/visual-editor/src/types.ts:311

Parameters ​

ParameterType
nodeIdstring
oldNamestring
newNamestring
displayName?string

Returns ​

void


validate() ​

ts
validate(): ValidationError[];

Defined in: packages/visual-editor/src/types.ts:289

Returns ​

ValidationError[]

Inherited from ​

CommonFormActions.validate

Core packages released under MIT. Studio app released under FSL-1.1-ALv2.