Constructor
new BubbleController(view)
Parameters:
Name | Type | Description |
---|---|---|
view |
Help4.widget.tour.View |
Properties:
Name | Type | Description |
---|---|---|
_view |
Help4.widget.tour.View |
- Source:
Extends
Methods
(protected) ____defineStaticProperties()
auto define all to be cleaned properties
- Overrides:
- Source:
Throws:
Error
(protected) ____getClassConfig() → {Help4.jscore.Base.Params}
- Overrides:
- Source:
Returns:
(protected) ____mergeDerivedParam(level0, type, value)
Parameters:
Name | Type | Description |
---|---|---|
level0 |
Help4.jscore.Base.Params | |
type |
string | |
value |
* |
- Overrides:
- Source:
Throws:
Error
(protected) ____mergeDerivedParams(level0, level1)
Parameters:
Name | Type | Description |
---|---|---|
level0 |
Help4.jscore.Base.Params | |
level1 |
Help4.jscore.Base.Params |
- Overrides:
- Source:
Throws:
Error
(protected) ____resolveDerivedParams(classConfig)
Parameters:
Name | Type | Description |
---|---|---|
classConfig |
Help4.jscore.Base.Params |
- Overrides:
- Source:
(protected) _destroyControl(…keys)
destroys class properties
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
keys |
string |
<repeatable> |
- Overrides:
- Source:
(protected) _fireEvent(event) → {Help4.jscore.Base}
fires an event that can be observed from outside
Parameters:
Name | Type | Description |
---|---|---|
event |
Object | the event to be fired |
- Overrides:
- Source:
Returns:
- Type
- Help4.jscore.Base
(async, protected) _fireEvent2(event) → {Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>}
fires an event that can be observed from outside
Parameters:
Name | Type | Description |
---|---|---|
event |
Object | the event to be fired |
- Overrides:
- Source:
Returns:
- Type
- Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>
(protected) _fireEventSync(event) → {Array.<Help4.EmbeddedEvent.EventResponse>}
fires an event that can be observed from outside
Parameters:
Name | Type | Description |
---|---|---|
event |
Object | the event to be fired |
- Overrides:
- Source:
Returns:
- Type
- Array.<Help4.EmbeddedEvent.EventResponse>
addListener(eventType, listener) → {Help4.jscore.Base}
add an event listener
Parameters:
Name | Type | Description |
---|---|---|
eventType |
string | Array.<string> | event type to be observed |
listener |
Help4.EmbeddedEvent.Listener | the callback function |
- Overrides:
- Source:
Returns:
- Type
- Help4.jscore.Base
addListenerSync(eventType, listener) → {Help4.jscore.Base}
add an event listener
Parameters:
Name | Type | Description |
---|---|---|
eventType |
string | Array.<string> | event type to be observed |
listener |
Help4.EmbeddedEvent.Listener | the callback function |
- Overrides:
- Source:
Returns:
- Type
- Help4.jscore.Base
(async) create(reasonopt) → {Promise.<void>}
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
reason |
string |
<optional> |
'next' |
- Source:
Returns:
- Type
- Promise.<void>
destroy()
destroy instance
- Overrides:
- Source:
get(tileIdopt, nullable) → (nullable) {Help4.widget.tour.BubbleControl}
get bubble control
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
tileId |
string |
<optional> <nullable> |
- Source:
Returns:
invalidate() → {boolean}
called after navigate to an unknown screen
- Source:
Returns:
- Type
- boolean
isDestroyed() → {boolean}
whether instance is destroyed
- Overrides:
- Source:
Returns:
- Type
- boolean
removeListener(eventType, listener) → {Help4.jscore.Base}
remove an event listener
Parameters:
Name | Type | Description |
---|---|---|
eventType |
string | Array.<string> | |
listener |
Help4.EmbeddedEvent.Listener |
- Overrides:
- Source:
Returns:
- Type
- Help4.jscore.Base
update() → {Help4.widget.tour.BubbleController}
- Source: