module:bajaux/util/SaveCommand

module:bajaux/util/SaveCommand

new (require("bajaux/util/SaveCommand"))()

Description:

  • A Command for saving a Widget.

Source:
Extends:

Extends

Methods

getAccelerator() → {Object}

Description:

  • Return the accelerator for the Command or null if
    nothing is defined.

Source:
Inherited From:
See:
Returns:

The accelerator or null if nothing is defined.

Type
Object

getDescriptionFormat() → {String}

Description:

  • Get the unformatted description of the command.

Source:
Inherited From:
Returns:
Type
String

getDisplayNameFormat() → {String}

Description:

  • Return the format display name of the command.

Source:
Inherited From:
Returns:
Type
String

getFlags() → {Number}

Description:

  • Get this command's flags.

Source:
Inherited From:
Returns:
Type
Number

getFunction() → {function}

Description:

  • Return the raw function associated with this command.

Source:
Inherited From:
Returns:
Type
function

getIcon() → {String}

Description:

  • Return the Command's icon URI

Source:
Inherited From:
Returns:
Type
String

getId()

Description:

  • Return a unique numerical id for the Command.

    This is id unique to every Command object created.

Source:
Inherited From:

hasFlags(flags) → {Boolean}

Description:

  • Check to see if this command's flags match any of the bits of the
    input flags.

Source:
Inherited From:
Parameters:
Name Type Description
flags Number

The flags to check against
Returns:
Type
Boolean

invoke() → {Promise}

Description:

  • Saves the Widget.

Source:
Overrides:
Returns:
Type
Promise

isCommand()

Description:

  • Always returns true.

Source:
Inherited From:

isEnabled() → {Boolean}

Description:

  • Gets this command's enabled status.

Source:
Inherited From:
Returns:
Type
Boolean

isLoading() → {Boolean}

Description:

  • Return true if the Command is still loading.

Source:
Inherited From:
Returns:

true if still loading.

Type
Boolean

isToggleCommand()

Description:

  • Always returns false.

Source:
Inherited From:

jq()

Source:
Overrides:
See:
  • module:/bajaux/commands/Command

loading() → {Promise}

Description:

  • Return the loading promise for the Command.

    The returned promise will be resolved once the Command
    has finished loading.

Source:
Inherited From:
Returns:

The promise used for loading a Command.

Type
Promise

merge(cmd) → {module:bajaux/commands/Command}

Description:

  • Attempt to merge this command with another command, and return a new
    Command that does both tasks. If the two commands are mutually
    incompatible, return a falsy value.

Source:
Inherited From:
Example

Here is an example to show the basic concept. Commands that simply add two numbers together can easily be merged together thanks to the associative property. 

var AddCommand = function AddCommand(inc) {
  this.$inc = inc;
  Command.call(this, {
    displayName: 'Add ' + inc + ' to the given number',
    func: function (num) { return num + inc; }
  });
};
AddCommand.prototype = Object.create(Command.prototype);

AddCommand.prototype.merge = function (cmd) {
  if (cmd instanceof AddCommand) {
    return new AddCommand(this.$inc + cmd.$inc);
  }
};

var addOneCommand = new AddCommand(1),
    addFiveCommand = new AddCommand(5),
    addSixCommand = addOneCommand.merge(addFiveCommand);
addSixCommand.invoke(10)
  .then(function (result) {
    console.log('is 16? ', result === 16);
  });
Parameters:
Name Type Description
cmd module:bajaux/commands/Command
Returns:
Type
module:bajaux/commands/Command

off(eventopt, handleropt)

Description:

  • Unregister a function callback handler for the specified event.

Source:
Inherited From:
Parameters:
Name Type Attributes Description
event String <optional>

The name of the event to unregister.
If name isn't specified, all events for the Command will be unregistered.
handler function <optional>

The function to unregister. If
not specified, all handlers for the event will be unregistered.

on(event, handler)

Description:

  • Register a function callback handler for the specified event.

Source:
Inherited From:
Parameters:
Name Type Description
event String

The event id to register the function for.
handler function

The event handler to be called when the event is fired.

setAccelerator(acc)

Description:

  • Set the accelerator information for the Command.

Source:
Inherited From:
See:
Parameters:
Name Type Description
acc Object | String | Number | null | undefined

The accelerator keyboard information. This can
be a keyCode number, a character (i.e. 'a') or an Object that contains the accelerator information.
If no accelerator should be used the null/undefined should be specified.

Properties
Name Type Attributes Description
keyCode String | Number

The key code of the accelerator. This can be a character
code number or a character (i.e. 'a').
ctrl Boolean <optional>

true if the control key needs to be pressed.
shift Boolean <optional>

true if the shift key needs to be pressed.
alt Boolean <optional>

true if the alt key needs to be pressed.
meta Boolean <optional>

true if a meta key needs to be pressed.

setDescriptionFormat(description)

Description:

  • Set the description format of the command. Triggers a
    bajaux:changecommand event.

Source:
Inherited From:
Parameters:
Name Type Description
description String

the command description - supports baja Format
syntax

setDisplayNameFormat(displayName)

Description:

  • Set the display name format of the command. Triggers a
    bajaux:changecommand event.

Source:
Inherited From:
Parameters:
Name Type Description
displayName String

display name - supports baja Format syntax

setEnabled(enabled)

Description:

  • Sets this command's enabled status. Triggers a
    bajaux:changecommand event.

Source:
Inherited From:
Parameters:
Name Type Description
enabled Boolean

setFlags(flags)

Description:

  • Set this command's flags.

Source:
Inherited From:
Parameters:
Name Type Description
flags Number

setFunction(func)

Description:

  • Set the Command's function handler.

Source:
Inherited From:
Parameters:
Name Type Description
func function

The new function handler for the command.

setIcon(icon)

Description:

  • Sets the icon for this Command. Triggers a bajaux:changecommand event.

Source:
Inherited From:
Parameters:
Name Type Description
icon String

The Command's icon (either a URI or a module:// ORD string)

toDescription() → {Promise}

Description:

  • Access the Command's description.

    In order to access the description, a promise will be returned
    that will be resolved once the command has been loaded and
    the description has been found.

Source:
Inherited From:
Returns:

Promise to be resolved with the description

Type
Promise

toDisplayName() → {Promise}

Description:

  • Access the Command's display name.

    In order to access the display name, a promise will be returned
    that will be resolved once the command has been loaded and
    the display name has been found.

Source:
Inherited From:
Returns:

Promise to be resolved with the display name

Type
Promise

trigger(name)

Description:

  • Triggers an event from this Command.

Source:
Inherited From:
Parameters:
Name Type Description
name String

visit(func)

Description:

  • Visit this Command with the specified function.

Source:
Inherited From:
Parameters:
Name Type Description
func function

Will be invoked with this
Command passed in as an argument.