class InteractiveIcon
package openfl.desktop
extends Icon › EventDispatcher
extended by DockIcon, SystemTrayIcon
Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS
The InteractiveIcon class is the base class for the operating system icons associated with applications.
Use the icon property of the NativeApplication object to get an instance
of the application icon. The icon type will be one of the subclasses of
InteractiveIcon, either DockIcon on macOS or SystemTrayIcon on Windows and
Linux.
You cannot instantiate the InteractiveIcon class directly. Calls to the
new InteractiveIcon() constructor will throw an ArgumentError exception.
Constructor
Variables
@:value(0)read onlyheight:Int = 0
The current display height of the icon in pixels.
Some icon contexts support dynamic sizes. The height property
indicates the height of the icon chosen from the bitmaps array for the
current context. The actual display height may be different if the
operating system has scaled the icon.
@:value(0)read onlywidth:Int = 0
The current display width of the icon in pixels.
Some icon contexts support dynamic sizes. The width property indicates
the width of the icon chosen from the bitmaps array for the current
context. The actual display width may be different if the operating
system has scaled the icon.
Inherited Variables
Defined by Icon
@:value([])bitmaps:Array<BitmapData> = []
The icon image as an array of BitmapData objects of different sizes.
When an icon is displayed in a given operating system context, the bitmap in the array closest to the displayed size is used (and scaled if necessary). Common sizes include 16x16, 32x32, 48x48, and 128x128. (512x512 pixel icons may be used for some operating system icons in the near future.)
In some contexts, the operating system may use a default system icon if nothing has been assigned to the bitmaps property. In other contexts, no icon appears.
To set or change the icon appearance, assign an array of BitmapData
objects to the bitmaps property:
icon.bitmaps = new Array(icon16x16.bitmapData, icon128x128.bitmapData);Modifying the bitmaps array directly has no effect.
To clear the icon image, assign an empty array to the bitmaps property.
Note: When loading image files for an icon, the PNG file format generally provides the best alpha blending. The GIF format supports only on or off transparency (no blending). The JPG format does not support transparency at all.
Inherited Methods
Defined by EventDispatcher
@:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.
After you successfully register an event listener, you cannot change
its priority through additional calls to addEventListener().
To change a listener's priority, you must first call
removeListener(). Then you can register the listener again
with the new priority level.
Keep in mind that after the listener is registered, subsequent calls to
addEventListener() with a different type or
useCapture value result in the creation of a separate
listener registration. For example, if you first register a listener with
useCapture set to true, it listens only during
the capture phase. If you call addEventListener() again using
the same listener object, but with useCapture set to
false, you have two separate listeners: one that listens
during the capture phase and another that listens during the target and
bubbling phases.
You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.
If you no longer need an event listener, remove it by calling
removeEventListener(), or memory problems could result. Event
listeners are not automatically removed from memory because the garbage
collector does not remove the listener as long as the dispatching object
exists(unless the useWeakReference parameter is set to
true).
Copying an EventDispatcher instance does not copy the event listeners attached to it.(If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.
If the event listener is being registered on a node while an event is being processed on this node, the event listener is not triggered during the current phase but can be triggered during a later phase in the event flow, such as the bubbling phase.
If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again(unless registered again for future processing).
Parameters:
type | The type of event. |
|---|---|
useCapture | Determines whether the listener works in the
capture phase or the target and bubbling phases.
If |
priority | The priority level of the event listener. The priority is designated by a signed 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0. |
useWeakReference | Determines whether the reference to the listener is strong or weak. A strong reference(the default) prevents your listener from being garbage-collected. A weak reference does not. Class-level member functions are not subject to
garbage collection, so you can set
Weak references are supported on some OpenFL targets only, including html5, cpp, and flash/air. On other targets, this parameter is ignored, and the reference will be strong instead. |
Throws:
ArgumentError | The |
|---|
dispatchEvent(event:Event):Bool
Dispatches an event into the event flow. The event target is the
EventDispatcher object upon which the dispatchEvent() method
is called.
Parameters:
event | The Event object that is dispatched into the event flow. If
the event is being redispatched, a clone of the event is
created automatically. After an event is dispatched, its
|
|---|
Returns:
A value of true if the event was successfully
dispatched. A value of false indicates failure or
that preventDefault() was called on the event.
Throws:
Error | The event dispatch recursion limit has been reached. |
|---|
hasEventListener(type:String):Bool
Checks whether the EventDispatcher object has any listeners registered for
a specific type of event. This allows you to determine where an
EventDispatcher object has altered handling of an event type in the event
flow hierarchy. To determine whether a specific event type actually
triggers an event listener, use willTrigger().
The difference between hasEventListener() and
willTrigger() is that hasEventListener()
examines only the object to which it belongs, whereas
willTrigger() examines the entire event flow for the event
specified by the type parameter.
When hasEventListener() is called from a LoaderInfo
object, only the listeners that the caller can access are considered.
Parameters:
type | The type of event. |
|---|
Returns:
A value of true if a listener of the specified type
is registered; false otherwise.
@:value({ useCapture : false })removeEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false):Void
Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.
Parameters:
type | The type of event. |
|---|---|
useCapture | Specifies whether the listener was registered for the
capture phase or the target and bubbling phases. If the
listener was registered for both the capture phase and
the target and bubbling phases, two calls to
|
willTrigger(type:String):Bool
Checks whether an event listener is registered with this EventDispatcher
object or any of its ancestors for the specified event type. This method
returns true if an event listener is triggered during any
phase of the event flow when an event of the specified type is dispatched
to this EventDispatcher object or any of its descendants.
The difference between the hasEventListener() and the
willTrigger() methods is that hasEventListener()
examines only the object to which it belongs, whereas the
willTrigger() method examines the entire event flow for the
event specified by the type parameter.
When willTrigger() is called from a LoaderInfo object,
only the listeners that the caller can access are considered.
Parameters:
type | The type of event. |
|---|
Returns:
A value of true if a listener of the specified type
will be triggered; false otherwise.