mike-jumper commented on a change in pull request #613:
URL: https://github.com/apache/guacamole-client/pull/613#discussion_r642151263
##########
File path: guacamole-common-js/src/main/webapp/modules/Mouse.js
##########
@@ -503,16 +425,355 @@ Guacamole.Mouse.State = function State(template) {
};
+/**
+ * All mouse buttons that may be represented by a
+ * {@link Guacamole.Mouse.State}.
+ *
+ * @readonly
+ * @enum
+ */
+Guacamole.Mouse.State.Buttons = {
+
+ /**
+ * The name of the {@link Guacamole.Mouse.State} property representing the
+ * left mouse button.
+ *
+ * @constant
+ * @type {String}
+ */
+ LEFT : 'left',
+
+ /**
+ * The name of the {@link Guacamole.Mouse.State} property representing the
+ * middle mouse button.
+ *
+ * @constant
+ * @type {String}
+ */
+ MIDDLE : 'middle',
+
+ /**
+ * The name of the {@link Guacamole.Mouse.State} property representing the
+ * right mouse button.
+ *
+ * @constant
+ * @type {String}
+ */
+ RIGHT : 'right',
+
+ /**
+ * The name of the {@link Guacamole.Mouse.State} property representing the
+ * up mouse button (the fourth mouse button, clicked when the mouse scroll
+ * wheel is scrolled up).
+ *
+ * @constant
+ * @type {String}
+ */
+ UP : 'up',
+
+ /**
+ * The name of the {@link Guacamole.Mouse.State} property representing the
+ * down mouse button (the fifth mouse button, clicked when the mouse scroll
+ * wheel is scrolled up).
+ *
+ * @constant
+ * @type {String}
+ */
+ DOWN : 'down'
+
+};
+
+/**
+ * Base event type for all mouse events. The mouse producing the event may be
+ * the user's local mouse (as with {@link Guacamole.Mouse}) or an emulated
+ * mouse (as with {@link Guacamole.Mouse.Touchpad}).
+ *
+ * @constructor
+ * @augments Guacamole.Event.DOMEvent
+ * @param {String} type
+ * The type name of the event ("mousedown", "mouseup", etc.)
+ *
+ * @param {Guacamole.Mouse.State} state
+ * The current mouse state.
+ *
+ * @param {Event|Event[]} [events=[]]
+ * The DOM events that are related to this event, if any.
+ */
+Guacamole.Mouse.Event = function MouseEvent(type, state, events) {
+
+ Guacamole.Event.DOMEvent.call(this, type, events);
+
+ /**
+ * The name of the event handler used by the Guacamole JavaScript API for
+ * this event prior to the migration to Guacamole.Event.Target.
+ *
+ * @private
+ * @constant
+ * @type {String}
+ */
+ var legacyHandlerName = 'on' + this.type;
+
+ /**
+ * The current mouse state at the time this event was fired.
+ *
+ * @type {Guacamole.Mouse.State}
+ */
+ this.state = state;
+
+ /**
+ * @inheritdoc
+ */
+ this.invokeLegacyHandler = function invokeLegacyHandler(target) {
+ if (target[legacyHandlerName]) {
+
+ this.preventDefault();
+ this.stopPropagation();
+
+ target[legacyHandlerName](this.state);
+
+ }
+ };
+
+};
+
+/**
+ * An object which can dispatch {@link Guacamole.Mouse.Event} objects
+ * representing mouse events. These mouse events may be produced from an actual
+ * mouse device (as with {@link Guacamole.Mouse}), from an emulated mouse
+ * device (as with {@link Guacamole.Mouse.Touchpad}, or may be programmatically
+ * generated (using functions like [dispatch()]{@link
Guacamole.Mouse.Event.Target#dispatch},
+ * [press()]{@link Guacamole.Mouse.Event.Target#press}, and
+ * [release()]{@link Guacamole.Mouse.Event.Target#release}).
+ *
+ * @constructor
+ * @augments Guacamole.Event.Target
+ */
+Guacamole.Mouse.Event.Target = function MouseEventTarget() {
+
+ Guacamole.Event.Target.call(this);
+
+ /**
+ * The current mouse state. The properties of this state are updated when
+ * mouse events fire. This state object is also passed in as a parameter to
+ * the handler of any mouse events.
+ *
+ * @type {Guacamole.Mouse.State}
+ */
+ this.currentState = new Guacamole.Mouse.State();
+
+ /**
+ * Fired whenever a mouse button is effectively pressed. Depending on the
+ * object dispatching the event, this can be due to a true mouse button
+ * press ({@link Guacamole.Mouse}), an emulated mouse button press from a
+ * touch gesture ({@link Guacamole.Mouse.Touchpad} and
+ * {@link Guacamole.Mouse.Touchscreen}), or may be programmatically
+ * generated through [dispatch()]{@link
Guacamole.Mouse.Event.Target#dispatch},
+ * [press()]{@link Guacamole.Mouse.Event.Target#press}, or
+ * [click()]{@link Guacamole.Mouse.Event.Target#click}.
+ *
+ * @event Guacamole.Mouse.Event.Target#mousedown
+ * @param {Guacamole.Mouse.Event} event
+ * The mousedown event that was fired.
+ */
+
Review comment:
Yep, that's correct. These will be picked up by JSDoc and documented as
events.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
