Slots

acceleratorSource

Key? accelerator

Accelerator of the command or null.

assocDialogSource

internal Dialog? assocDialog

enabledSource

Bool enabled := true

The enable state of the command automatically controls the enabled state of all the registered widgets.

iconSource

Image? icon

Icon of the command or null. Typically a 16x16.

invokeSource

virtual Void invoke(Event? event)

Invoke the command. If the user event is known then is passed, otherwise it might be null.

makeSource

new make(Str? name := null, Image? icon := null, |Event|? onInvoke := null)

Construct a command with the specified onInvoke function. If onInvoke is not specified, then the invoke method must be overridden to execute the command.

makeLocaleSource

new makeLocale(Pod pod, Str keyBase, |Event|? onInvoke := null)

Construct a localized command using the specified pod name and keyBase. The command is initialized from the following localized properties:

• "{keyBase}.name.{plat}": text string for the command
• "{keyBase}.icon.{plat}": uri for the icon image
• "{keyBase}.accelerator.{plat}": string representation of Key

The {plat} string comes from Desktop.platform. If the paltform specific key is not found, then we attempt to fallback to a generic key. For example:

back.name=Back
back.accelerator=Alt+Left
back.accelerator.mac=Command+[

On all platforms the command name would be "Back". On Macs the accelerator would be Command+[, and all others it would be Alt+Left. If running on a Mac and an explicit ".mac" property was not specified, then automatically swizzle Ctrl to Command.

modeSource

CommandMode mode := CommandMode.push

The command mode determines who associated widgets are visualized. The CommandMode maps to the ButtonMode and MenuItemMode. The default is push.

nameSource

Str name

Name of the command.

onInvokeSource

readonly EventListeners onInvoke := EventListeners()

The function to invoke when the command is executed. If empty, then invoke must be overridden.

redoSource

virtual Void redo()

This method is invoked when the command invoked as a redo. It is not called on the first invocation. Default calls invoke with a null event.

registerSource

Void register(Widget w)

Register a widget with this command. This is done automatically by the widget. You only need to call this method if you are developing a custom widget.

registrySource

private Widget[] registry := Widget[,]

selectedSource

Bool selected := false

If this command is using toggle mode, then set the selected state and update all the registered widgets.

toStrSource

override Str toStr()

Overrides sys::Obj.toStr

Return name.

undoSource

virtual Void undo()

This method is invoked to undo the command. This method is only used if undoable returns true.

undoableSource

virtual Bool undoable()

Return if the command can be undone. Default implementation returns true is the undo method has been overridden.

unregisterSource

Void unregister(Widget w)

Unregister a widget with this command. This is done automatically by the widget. You only need to call this method if you are developing a custom widget.

widgetsSource

Widget[] widgets()

Get the associated widgets with this command. Widgets are automatically associated with their command field is set.

windowSource

Window? window()

Get the window associated with this command. If this command is being used as the action of a dialog, then return the dialog. Otherwise try to map to a window via one of the widgets bound to this command. Return null if no associated window can be found.