Skip to content
Last updated

API / geotoolkit / controls / tools / editors / commands / ReplaceNode / ReplaceNode

Class: ReplaceNode

commands.ReplaceNode.ReplaceNode

Command for replace node in scene by another instance

Hierarchy

Table of contents

Constructors
  • [new ReplaceNode(fromNode, toNode)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.controls.tools.editors.commands.replacenode.replacenode.md#new replacenode(fromnode, tonode))
Methods

Contents

Constructors

new ReplaceNode(fromNode, toNode)

• new ReplaceNode(fromNode, toNode)

Parameters

Name Type Description
fromNodeShapecurrent node
toNodeShapenew node

Overrides

AbstractCommand.constructor

Methods

createInverse

▸ createInverse(): AbstractCommand

Returns inverse command

Returns

AbstractCommand

Inherited from

AbstractCommand.createInverse


getClassName

▸ getClassName(): string

Returns

string

Inherited from

AbstractCommand.getClassName


getEventName

▸ getEventName(): string

Returns event to be fired when command is applied

Returns

string

Inherited from

AbstractCommand.getEventName


getFromShape

▸ getFromShape(): Shape

Returns node's instance before replacement was applied

Returns

Shape


getNode

▸ getNode(): Node | Node[]

Returns target command node

Returns

Node | Node[]

Inherited from

AbstractCommand.getNode


getOptions

▸ getOptions(): Record<string, any&gt;

Returns command options

Returns

Record<string, any&gt;

Inherited from

AbstractCommand.getOptions


getToShape

▸ getToShape(): Shape

Returns new node's instance after replacement will be applied

Returns

Shape


isRejected

▸ isRejected(): boolean

Returns rejected state

Returns

boolean

the state

Inherited from

AbstractCommand.isRejected


isSeparate

▸ isSeparate(): boolean

Returns true if command is separate, false otherwise

Returns

boolean

Inherited from

AbstractCommand.isSeparate


merge

▸ merge(command): boolean

Tries to merge current with another command. If successful, return true and second command won't be stored in history. Returns false otherwise.

Parameters

Name Type Description
commandAbstractCommandcommand to merge

Returns

boolean

Inherited from

AbstractCommand.merge


reject

▸ reject(): ReplaceNode

Rejects action

Returns

ReplaceNode

this

Inherited from

AbstractCommand.reject


setNode

▸ setNode(node): ReplaceNode

Sets target node for the command

Parameters

Name Type Description
nodeNode | Node[]node(s) for applying the command

Returns

ReplaceNode

this

Inherited from

AbstractCommand.setNode


setOptions

▸ setOptions(options): ReplaceNode

Sets extra options to be stored in command

Parameters

Name Type Description
optionsRecord<string, any&gt;some extra options for the command to store

Returns

ReplaceNode

this

Inherited from

AbstractCommand.setOptions


setSeparate

▸ setSeparate(isSeparate): ReplaceNode

Sets command to be separate or not (true by default). Not separate commands are ignored by history undo/redo actions and considered as a part of the last separate command.

Parameters

Name Type Description
isSeparatebooleantrue if command should be considered as a separate operation (in undo/redo history), false otherwise

Returns

ReplaceNode

this

Inherited from

AbstractCommand.setSeparate


getClassName

▸ Static getClassName(): string

Returns

string

Inherited from

AbstractCommand.getClassName