You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| name | <code>string</code> | text that will be displayed in the UI to represent command |
35
+
| id | <code>string</code> ||
36
+
| commandFn | <code>function</code> | the function that is called when the command is executed. TODO: where should this be triggered, The Command or Exports? |
37
+
|[options]|||
38
+
39
+
<aname="Command+getID"></a>
40
+
41
+
### command.getID() ⇒ <code>string</code>
42
+
Get command id
43
+
44
+
**Kind**: instance method of [<code>Command</code>](#Command)
45
+
<aname="Command+execute"></a>
46
+
47
+
### command.execute() ⇒ <code>$.Promise</code>
48
+
Executes the command. Additional arguments are passed to the executing function
49
+
50
+
**Kind**: instance method of [<code>Command</code>](#Command)
51
+
**Returns**: <code>$.Promise</code> - a jQuery promise that will be resolved when the command completes.
52
+
<aname="Command+getEnabled"></a>
53
+
54
+
### command.getEnabled() ⇒ <code>boolean</code>
55
+
Is command enabled?
56
+
57
+
**Kind**: instance method of [<code>Command</code>](#Command)
58
+
<aname="Command+setEnabled"></a>
59
+
60
+
### command.setEnabled(enabled)
61
+
Sets enabled state of Command and dispatches "enabledStateChange"
62
+
when the enabled state changes.
63
+
64
+
**Kind**: instance method of [<code>Command</code>](#Command)
65
+
66
+
| Param | Type |
67
+
| --- | --- |
68
+
| enabled | <code>boolean</code> |
69
+
70
+
<aname="Command+setChecked"></a>
71
+
72
+
### command.setChecked(checked)
73
+
Sets enabled state of Command and dispatches "checkedStateChange"
74
+
when the enabled state changes.
75
+
76
+
**Kind**: instance method of [<code>Command</code>](#Command)
77
+
78
+
| Param | Type |
79
+
| --- | --- |
80
+
| checked | <code>boolean</code> |
81
+
82
+
<aname="Command+getChecked"></a>
83
+
84
+
### command.getChecked() ⇒ <code>boolean</code>
85
+
Is command checked?
86
+
87
+
**Kind**: instance method of [<code>Command</code>](#Command)
88
+
<aname="Command+setName"></a>
89
+
90
+
### command.setName(name)
91
+
Sets the name of the Command and dispatches "nameChange" so that
92
+
UI that reflects the command name can update.
93
+
94
+
Note, a Command name can appear in either HTML or native UI
95
+
so HTML tags should not be used. To add a Unicode character,
96
+
use \uXXXX instead of an HTML entity.
97
+
98
+
**Kind**: instance method of [<code>Command</code>](#Command)
99
+
100
+
| Param | Type |
101
+
| --- | --- |
102
+
| name | <code>string</code> |
103
+
104
+
<aname="Command+getName"></a>
105
+
106
+
### command.getName() ⇒ <code>string</code>
107
+
Get command name
108
+
109
+
**Kind**: instance method of [<code>Command</code>](#Command)
0 commit comments