Packageorg.hasseg.externalMouseWheel
Classpublic final class ExternalMouseWheelSupport

Implements mouse wheel support for OS X. This is done by catching mouse wheel events in JavaScript through the ExternalInterface and dispatching them as ExternalMouseWheelEvents. The objects that the mouse wheel support should be enabled for have to be registered with this class, and the registration can be handled automatically (all InteractiveObjects on Stage) or manually (see registerAutomatically).

See also

org.hasseg.externalMouseWheel.ExternalMouseWheelEvent

Public Properties
 PropertyDefined by
  instance : ExternalMouseWheelSupport
[static][read-only] Reference to the singleton instance of this class
ExternalMouseWheelSupport
  manuallyRegisteredObjects : Array
[read-only] Gets all of the manually registered objects
ExternalMouseWheelSupport
  registerAutomatically : Boolean
[static] Whether or not to try and handle the registration of objects automatically (note: automatic registration is a bit experimental / buggy)
ExternalMouseWheelSupport
Public Methods
 MethodDefined by
  
registerObject(aObject:Object):Boolean
Registers an object to dispatch mouse wheel events also in OS X when the mouse cursor is hovering on top of it and the wheel is used
ExternalMouseWheelSupport
  
registerObjects(aObjects:Array):void
Registers several objects to dispatch mouse wheel events also in OS X when the mouse cursor is hovering on top of them and the wheel is used
ExternalMouseWheelSupport
  
unRegisterObject(aObject:Object):Boolean
Unregisters objects so that they will no longer dispatch mouse wheel events in OS X
ExternalMouseWheelSupport
Property detail
instanceproperty
instance:ExternalMouseWheelSupport  [read-only]

Reference to the singleton instance of this class

Implementation
    public static function get instance():ExternalMouseWheelSupport
manuallyRegisteredObjectsproperty 
manuallyRegisteredObjects:Array  [read-only]

Gets all of the manually registered objects

Implementation
    public function get manuallyRegisteredObjects():Array
registerAutomaticallyproperty 
registerAutomatically:Boolean  [read-write]

Whether or not to try and handle the registration of objects automatically (note: automatic registration is a bit experimental / buggy)

Implementation
    public static function get registerAutomatically():Boolean
    public function set registerAutomatically(value:Boolean):void

See also

org.hasseg.ExternalMouseWheel.registerObject
org.hasseg.ExternalMouseWheel.registerObjects
org.hasseg.ExternalMouseWheel.unRegisterObject
Method detail
registerObject()method
public function registerObject(aObject:Object):Boolean

Registers an object to dispatch mouse wheel events also in OS X when the mouse cursor is hovering on top of it and the wheel is used

Parameters
aObject:Object — The object to register

Returns
Boolean — True if object has been successfully registered, false if it already is registered

See also

org.hasseg.ExternalMouseWheel.registerAutomatically
org.hasseg.ExternalMouseWheel.registerObjects
org.hasseg.ExternalMouseWheel.unRegisterObject
registerObjects()method 
public function registerObjects(aObjects:Array):void

Registers several objects to dispatch mouse wheel events also in OS X when the mouse cursor is hovering on top of them and the wheel is used

Parameters
aObjects:Array — An Array of objects to register

See also

org.hasseg.ExternalMouseWheel.registerObject
org.hasseg.ExternalMouseWheel.registerAutomatically
org.hasseg.ExternalMouseWheel.unRegisterObject
unRegisterObject()method 
public function unRegisterObject(aObject:Object):Boolean

Unregisters objects so that they will no longer dispatch mouse wheel events in OS X

Parameters
aObject:Object — The object to unregister

Returns
Boolean — True if the object has been successfully unregistered, false if it was not registered in the first place

See also

org.hasseg.ExternalMouseWheel.registerObject
org.hasseg.ExternalMouseWheel.registerObjects
org.hasseg.ExternalMouseWheel.registerAutomatically