Last updated

API / geotoolkit / controls / tools / editors / commands / PropertyChange / PropertyChange

Class: PropertyChange

commands.PropertyChange.PropertyChange

Command for changing node's property

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new PropertyChange(name, value)

new PropertyChange(name, value)

Parameters

Name Type Description
namestringproperty name to change
valueanynew property value

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


getName

getName(): string

Returns changing property name

Returns

string


getNode

getNode(): Node | Node[]

Returns target command node

Returns

Node | Node[]

Inherited from

AbstractCommand.getNode


getOptions

getOptions(): Record<string, any>

Returns command options

Returns

Record<string, any>

Inherited from

AbstractCommand.getOptions


getValue

getValue(): any

Returns new changing property value

Returns

any


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(): PropertyChange

Rejects action

Returns

PropertyChange

this

Inherited from

AbstractCommand.reject


setNode

setNode(node): PropertyChange

Sets target node for the command

Parameters

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

Returns

PropertyChange

this

Inherited from

AbstractCommand.setNode


setOptions

setOptions(options): PropertyChange

Sets extra options to be stored in command

Parameters

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

Returns

PropertyChange

this

Inherited from

AbstractCommand.setOptions


setSeparate

setSeparate(isSeparate): PropertyChange

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

PropertyChange

this

Inherited from

AbstractCommand.setSeparate


getClassName

Static getClassName(): string

Returns

string

Inherited from

AbstractCommand.getClassName