Constructor
new ActionGroupComponent()
The component of action queue by groups.
Extends
Members
active :Boolean
Active or deactive component.
Type:
- Boolean
- Overrides:
- Source:
app :THING.App
Get application.
Type:
- Overrides:
- Source:
groups :*
Get the groups.
Type:
- *
Example
let component = new THING.ActionGroupComponent();
component.add('temp');
let ret = component.groups.get('temp');
// @expect(ret.name == 'temp')
object :THING.BaseObject
Get object.
Type:
- Overrides:
- Source:
onActiveChange :OnActiveChangeComponentCallback
When active change callback function.
Type:
- Overrides:
- Source:
onAfterAdd :OnAfterAddComponentCallback
After add.
Type:
- Overrides:
- Source:
onAfterAddChild :OnAddChildComponentCallback
When after add child callback function.
Type:
- Overrides:
- Source:
onAfterRemove :OnAfterRemoveComponentCallback
After remove.
Type:
- Overrides:
- Source:
onAfterRemoveChild :OnRemoveChildComponentCallback
When after remove child callback function.
Type:
- Overrides:
- Source:
onBeforeAdd :OnBeforeAddComponentCallback
Before add.
Type:
- Overrides:
- Source:
onBeforeAddChild :OnAddChildComponentCallback
When before add child callback function.
Type:
- Overrides:
- Source:
onBeforeRemove :OnBeforeRemoveComponentCallback
Before remove.
Type:
- Overrides:
- Source:
onBeforeRemoveChild :OnRemoveChildComponentCallback
When before remove child callback function.
Type:
- Overrides:
- Source:
onCopy :OnCopyComponentCallback
When copy callback function.
Type:
- Overrides:
- Source:
onExport :OnExportComponentCallback
When export data.
Type:
- Overrides:
- Source:
onImport :OnImportComponentCallback
When import data.
Type:
- Overrides:
- Source:
onInit :OnInitComponentCallback
When initialize callback function.
Type:
- Overrides:
- Source:
onLoadResource :OnLoadResourceComponentCallback
When load resource callback function.
Type:
- Overrides:
- Source:
onParentChange :OnParentChangeComponentCallback
When change parent callback function.
Type:
- Overrides:
- Source:
onRefresh :OnRefreshComponentCallback
When refresh callback function.
Type:
- Overrides:
- Source:
onResize :OnResizeComponentCallback
When resize callback function.
Type:
- Overrides:
- Source:
onUnloadResource :OnUnloadResourceComponentCallback
When unload resource callback function.
Type:
- Overrides:
- Source:
onUpdate :OnUpdateComponentCallback
When update callback function.
Type:
- Overrides:
- Source:
onVisibleChange :OnVisibleChangeComponentCallback
When visible change callback function.
Type:
- Overrides:
- Source:
Methods
add(name) → {THING.ActionQueue}
Add group.
Parameters:
Name | Type | Description |
---|---|---|
name |
String | The group name. |
Returns:
- Type
- THING.ActionQueue
Example
let component = new THING.ActionGroupComponent();
let ret = component.add('temp');
// @expect(ret.name == 'temp')
get(name) → {Object}
Get group.
Parameters:
Name | Type | Description |
---|---|---|
name |
String | The group name. |
Returns:
- Type
- Object
Example
let component = new THING.ActionGroupComponent();
component.add('temp');
let ret = component.get('temp');
// @expect(ret.name == 'temp')
onAdd(object)
When add component.
Parameters:
Name | Type | Description |
---|---|---|
object |
THING.BaseObject | The object. |
- Overrides:
- Source:
onRemove()
When remove component.
- Overrides:
- Source:
remove(name)
Remove group.
Parameters:
Name | Type | Description |
---|---|---|
name |
String | The group name. |
Example
let component = new THING.ActionGroupComponent();
let ret = component.add('temp');
component.remove('temp');
// @expect(component.groups.size == 0)
run(name, options) → {Promise.<any>}
Run group.
Parameters:
Name | Type | Description |
---|---|---|
name |
String | The group name. |
options |
Object | The options. |
Returns:
- Type
- Promise.<any>
stop(name, options)
Stop group.
Parameters:
Name | Type | Description |
---|---|---|
name |
String | The group name. |
options |
Object | The options. |