pureweb.ui

Class PureWebMouseEventArgs

java.lang.Object

pureweb.ui.PureWebInputEventArgs

pureweb.ui.PureWebMouseEventArgs

All Implemented Interfaces:

EventArgs

public class PureWebMouseEventArgs
extends PureWebInputEventArgs

The PureWebMouseEventArgs class represents the data defining a mouse event.

Constructor Summary

Constructors

Constructor and Description
PureWebMouseEventArgs() Constructs a new instance of the PureWebMouseEventArgs class.
PureWebMouseEventArgs(java.lang.String viewName, MouseEventType eventType, double x, double y, double delta, MouseButtons changedButton, java.util.EnumSet buttons, java.util.EnumSet modifiers) Constructs a new instance of the PureWebMouseEventArgs class.
PureWebMouseEventArgs(java.util.UUID sessionId, java.lang.String viewName, MouseEventType eventType, double x, double y, double delta, MouseButtons changedButton, java.util.EnumSet buttons, java.util.EnumSet modifiers) Constructs a new instance of the PureWebMouseEventArgs class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Checks if the current instance is equal or not to the specified other object.
java.util.EnumSet	getButtons() Returns an EnumSet<MouseButtons> of the mouse button that were pressed during the event.
MouseButtons	getChangedButton() Returns the mouse button that changed during the event.
double	getDelta() Returns a signed count of the number of detents the mouse wheel has rotated.
MouseEventType	getEventType() Returns the mouse event type.
java.util.List	getFiltered() Returns the list of mouse events of the same type as the current instance that were filtered out of the message loop.
java.util.List	getFilteredEventsBySession(java.util.UUID sessionId) Returns a list of filtered events, where the events in the list originate from the specified session.
double	getX() Returns the X position of the mouse cursor relative to the view client area.
double	getY() Returns the Y position of the mouse cursor relative to the view client area.
int	hashCode() Returns this instance expressed as a hashcode.
void	setButtons(java.util.EnumSet buttons) Sets the EnumSet<MouseButtons> of the mouse button that were pressed during the event.
void	setChangedButton(MouseButtons changedButton) Sets the mouse button that changed during the event.
void	setDelta(double delta) Sets a signed count of the number of detents the mouse wheel has rotated.
void	setEventType(MouseEventType eventType) Sets the mouse event type.
void	setFiltered(java.util.List filtered) Sets the list of mouse events of the same type as the current instance that were filtered out of the message loop.
void	setX(double x) Sets the X position of the mouse cursor relative to the view client area.
void	setY(double y) Sets the Y position of the mouse cursor relative to the view client area.

Methods inherited from class pureweb.ui.PureWebInputEventArgs

getModifiers, getSessionId, getViewName, setHandled, setModifiers, wasHandled

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PureWebMouseEventArgs

public PureWebMouseEventArgs()

Constructs a new instance of the PureWebMouseEventArgs class.

PureWebMouseEventArgs

public PureWebMouseEventArgs(java.util.UUID sessionId,
                             java.lang.String viewName,
                             MouseEventType eventType,
                             double x,
                             double y,
                             double delta,
                             MouseButtons changedButton,
                             java.util.EnumSet buttons,
                             java.util.EnumSet modifiers)

Constructs a new instance of the PureWebMouseEventArgs class.

Parameters:

sessionId - The unique identifier of the originating session.

viewName - The name of the view where the event took place.

eventType - The type of mouse event.

x - The X position of the mouse cursor relative to the view client area.

y - The Y position of the mouse cursor relative to the view client area.

delta - A signed count of the number of detents the mouse wheel has rotated.

changedButton - The mouse button that changed during the event.

buttons - An EnumSet<MouseButtons> of the mouse button that were pressed during the event.

modifiers - The modifiers in effect at the time of the event.

PureWebMouseEventArgs

public PureWebMouseEventArgs(java.lang.String viewName,
                             MouseEventType eventType,
                             double x,
                             double y,
                             double delta,
                             MouseButtons changedButton,
                             java.util.EnumSet buttons,
                             java.util.EnumSet modifiers)

Constructs a new instance of the PureWebMouseEventArgs class.

Parameters:

viewName - The name of the view where the event took place.

eventType - The type of mouse event.

x - The X position of the mouse cursor relative to the view client area.

y - The Y position of the mouse cursor relative to the view client area.

delta - A signed count of the number of detents the mouse wheel has rotated.

changedButton - The mouse button that changed during the event.

buttons - An EnumSet<MouseButtons> of the mouse button that were pressed during the event.

modifiers - The modifiers in effect at the time of the event.

Method Detail

getEventType

public MouseEventType getEventType()

Returns the mouse event type.

setEventType

public void setEventType(MouseEventType eventType)

Sets the mouse event type.

getX

public double getX()

Returns the X position of the mouse cursor relative to the view client area.

setX

public void setX(double x)

Sets the X position of the mouse cursor relative to the view client area.

getY

public double getY()

Returns the Y position of the mouse cursor relative to the view client area.

setY

public void setY(double y)

Sets the Y position of the mouse cursor relative to the view client area.

getDelta

public double getDelta()

Returns a signed count of the number of detents the mouse wheel has rotated. A detent is one notch of the mouse wheel.

setDelta

public void setDelta(double delta)

Sets a signed count of the number of detents the mouse wheel has rotated.

getChangedButton

public MouseButtons getChangedButton()

Returns the mouse button that changed during the event.

setChangedButton

public void setChangedButton(MouseButtons changedButton)

Sets the mouse button that changed during the event.

getButtons

public java.util.EnumSet getButtons()

Returns an EnumSet<MouseButtons> of the mouse button that were pressed during the event.

setButtons

public void setButtons(java.util.EnumSet buttons)

Sets the EnumSet<MouseButtons> of the mouse button that were pressed during the event.

getFiltered

public java.util.List getFiltered()

Returns the list of mouse events of the same type as the current instance that were filtered out of the message loop. Will be null if no events were filtered. The current instance will also appear as the last element in the list, if it exists. Currently, filtering is applied for mouse move and mouse wheel events. (See DefaultCommandFilter

For mouse wheel events, the current instance delta will represent the cumulative delta of all the filtered wheel events in the list. The last element in the list, which corresponds to the current instance, will not have the cumulative delta value. Therefore, if an application needs to process the filtered list, it should ignore the current instance, and just process the events in the filtered list.

setFiltered

public void setFiltered(java.util.List filtered)

Sets the list of mouse events of the same type as the current instance that were filtered out of the message loop. Will be null if no events were filtered.

getFilteredEventsBySession

public java.util.List getFilteredEventsBySession(java.util.UUID sessionId)

Returns a list of filtered events, where the events in the list originate from the specified session. Will be null if no events were filtered.

equals

public boolean equals(java.lang.Object obj)

Checks if the current instance is equal or not to the specified other object. Returns true if they are equal, otherwise returns false.

Overrides:

equals in class PureWebInputEventArgs

hashCode

public int hashCode()

Returns this instance expressed as a hashcode.

Overrides:

hashCode in class PureWebInputEventArgs