API / geotoolkit / widgets / overlays / AbstractOverlay / AbstractOverlay
overlays.AbstractOverlay.AbstractOverlay
Defines an abstract implementation of a widget overlay. Abstract overlay supports ...
| Name | Type |
|---|---|
T | extends BaseWidget = BaseWidget |
↳
AbstractOverlay
Constructors
Methods
Constructors
• new AbstractOverlay<T>(widget)
| Name | Type |
|---|---|
T | extends BaseWidget<T> = BaseWidget |
| Name | Type | Description |
|---|---|---|
widget | T | widget to create overlay |
EventDispatcher.constructor
Methods
▸ dispose(): void
Disposes this node, once disposes a node should not be used anymore.
Clear all listeners, and disconnect styles to avoid memory leaks.
Also aggressively 'cleanup' this node by setting some of its members to null.
void
▸ getClassName(): string
string
▸ getEnabled(): boolean
Return enabled state
boolean
enabled state
▸ getVisible(): boolean
Return visibility state
boolean
visible state
▸ getWidget(): T
Returns widget
T
widget
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
EventDispatcher.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): AbstractOverlay<T>
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | AbstractOverlay<BaseWidget> | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): AbstractOverlay<T>
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: AbstractOverlay<T>, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): AbstractOverlay<T>
Attach listener on event that will be called whenever the specified event is delivered to the target
If the callback function is already in the list of event listeners for this target, the function is not added a second time.
If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: AbstractOverlay<T>, args: EventMap[E]) => void | to be called |
this
▸ Protected onStateChanged(state): AbstractOverlay<T>
| Name | Type | Description |
|---|---|---|
state | "Visible" | "Enabled" | state |
▸ setEnabled(enabled): AbstractOverlay<T>
Set enabled state
| Name | Type | Description |
|---|---|---|
enabled | boolean | enable or disable tools |
this
▸ setSilent(bool): AbstractOverlay<T>
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setVisible(visible): AbstractOverlay<T>
Set visibility state
| Name | Type | Description |
|---|---|---|
visible | boolean | visibility of overlay |
this
▸ Static getClassName(): string
string