Libraries.Interface.Events.MouseProcessor Documentation

This class is used to read MouseEvents from the Mouse and send them to the appropriate MouseListeners, MouseMovementListeners, and MouseWheelListeners which have registered themselves with this processor.

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
AddListener(Libraries.Interface.Events.MouseListener listener)Adds a MouseListener to this MouseProcessor.
AddMovementListener(Libraries.Interface.Events.MouseMovementListener listener)Adds a MouseMovementListener to this MouseProcessor.
AddWheelListener(Libraries.Interface.Events.MouseWheelListener listener)Adds a MouseWheelListener to this MouseProcessor.
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetCurrentEvents()Deletes any old events that may be in the events list, then gets all current events, stores them internally, and returns the list.
GetHashCode()This action gets the hash code for an object.
ProcessEvents()This action will notify all registered listeners of any mouse events stored in the internal events list, which is populated by the GetCurrentEvents action.
RemoveListener(Libraries.Interface.Events.MouseListener listener)Removes a MouseListener from this MouseProcessor.
RemoveMovementListener(Libraries.Interface.Events.MouseMovementListener listener)Removes a MouseMovementListener from this MouseProcessor.
RemoveWheelListener(Libraries.Interface.Events.MouseWheelListener listener)Removes a MouseWheelListener from this MouseProcessor.

Actions Documentation

AddListener(Libraries.Interface.Events.MouseListener listener)

Adds a MouseListener to this MouseProcessor. The listener will be notified of clicked mouse and released mouse events during ProcessEvents.

Parameters

AddMovementListener(Libraries.Interface.Events.MouseMovementListener listener)

Adds a MouseMovementListener to this MouseProcessor. The listener will be notified of moved mouse and dragged mouse events during ProcessEvents.

Parameters

AddWheelListener(Libraries.Interface.Events.MouseWheelListener listener)

Adds a MouseWheelListener to this MouseProcessor. The listener will be notified of scrolled mouse wheel events during ProcessEvents.

Parameters

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: The Compare result, Smaller, Equal, or Larger.

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetCurrentEvents()

Deletes any old events that may be in the events list, then gets all current events, stores them internally, and returns the list.

Return

Libraries.Containers.List:

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

ProcessEvents()

This action will notify all registered listeners of any mouse events stored in the internal events list, which is populated by the GetCurrentEvents action.

RemoveListener(Libraries.Interface.Events.MouseListener listener)

Removes a MouseListener from this MouseProcessor. It will no longer be notified of clicked mouse and released mouse events during ProcessEvents.

Parameters

RemoveMovementListener(Libraries.Interface.Events.MouseMovementListener listener)

Removes a MouseMovementListener from this MouseProcessor. The listener will no longer be notified of moved mouse and dragged mouse events during ProcessEvents.

Parameters

RemoveWheelListener(Libraries.Interface.Events.MouseWheelListener listener)

Removes a MouseWheelListener from this MouseProcessor. The listener will no longer be notified of scrolled mouse wheel events during ProcessEvents.

Parameters