org.cesiumjs.cs.widgets

Class Command

java.lang.Object

org.cesiumjs.cs.widgets.Command

@JsType(isNative=true,
        namespace="Cesium",
        name="Command")
public abstract class Command
extends Object

A Command is a function with an extra canExecute observable property to determine whether the command can be executed. When executed, a Command function will check the value of canExecute and throw if false. This type describes an interface and is not intended to be instantiated directly. See Cesium.createCommand(org.cesiumjs.cs.Cesium.Function) to create a command from a function.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Event	afterExecute Gets an event which is raised after the command executes, the event is raised with the return value of the command as its only parameter.
Event	beforeExecute Gets an event which is raised before the command executes, the event is raised with an object containing two properties: a cancel property, which if set to false by the listener will prevent the command from being executed, and an args property, which is the array of arguments being passed to the command.
boolean	canExecute Gets whether this command can currently be executed.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

afterExecute

@JsProperty
public Event afterExecute

Gets an event which is raised after the command executes, the event is raised with the return value of the command as its only parameter. Default: undefined

beforeExecute

@JsProperty
public Event beforeExecute

Gets an event which is raised before the command executes, the event is raised with an object containing two properties: a cancel property, which if set to false by the listener will prevent the command from being executed, and an args property, which is the array of arguments being passed to the command. Default: undefined

canExecute

@JsProperty
public boolean canExecute

Gets whether this command can currently be executed. This property is observable. Default: undefined