quadbase.util
Interface IMouseEventSet

public interface IMouseEventSet

This interface is used to customize modifiers and clicks for performing common mouse operations like dragging and resizing of a chart, hyperlinks, zooming, etc.

The mouse modifier is an integer comprising one or more of the following masks :

1. MouseEvent.SHIFT_MASK : This corresponds to the shift key being pressed.
2. MouseEvent.CTRL_MASK : This corresponds to the CTRL key being pressed.
3. MouseEvent.META_MASK : This corresponds to the right mouse key being pressed.
4. MouseEvent.ALT_MASK : This corresponds to the ALT key being pressed.

Note : The mouse event customization is not persistent, and must be set each time a chart is loaded.

Method Summary

boolean	areZoomEventsEnabled() Returns the enable/disable status of mouse events for date/time based zooming operations.
int	getBackLinkClickCount() Returns the mouse click count for jumping back from a hyperlink to the previous chart.
int	getBackLinkModifier() Sets the mouse modifier for jumping back from a hyperlink to the previous chart.
int	getDragClickCount() Returns the mouse click count for dragging of chart, legend, etc.
int	getDragModifier() Returns the mouse modifier for dragging of chart, legend, etc.
int	getForwardLinkClickCount() Returns the mouse click count for jumping to a hyperlink associated with a data point.
int	getForwardLinkModifier() Returns the mouse modifier for jumping to a hyperlink associated with a data point.
int	getResizeCanvasClickCount() Returns the mouse click count for resizing a canvas
int	getResizeCanvasModifier() Returns the mouse modifier for starting a canvas resize operation.
int	getResizeClickCount() Returns the mouse click count for resizing a chart
int	getResizeModifier() Returns the mouse modifier for starting a chart resize operation.
int	getUndoZoomClickCount() Returns the mouse click count for undoing a zooming operation
int	getUndoZoomModifier() Returns the mouse modifier for undoing a zooming operation.
int	getZoomClickCount() Returns the mouse click count for starting a zooming operation
int	getZoomModifier() Returns the mouse modifier for starting a zooming operation.
boolean	isBackLinkEnabled() Returns true if backward link is enabled.
boolean	isDragEnabled() Returns true if dragging of the chart,legend, etc.
boolean	isForwardLinkEnabled() Returns true if forward link is enabled.
boolean	isResizeCanvasEnabled() Returns true if resizing of the canvas is enabled.
boolean	isResizeEnabled() Returns true if resizing of the chart is enabled.
void	setBackLinkClickCount(int c) Sets the mouse click count for jumping back from a hyperlink to the previous chart.
void	setBackLinkEnabled(boolean b) Sets the status of the backward link depending on the value of parameter b.
void	setBackLinkModifier(int m) Sets the mouse modifier for jumping back from a hyperlink to the previous chart.
void	setDragClickCount(int c) Returns the mouse click count for dragging of chart, legend, etc.
void	setDragEnabled(boolean b) Sets the status of the dragging of the chart, legend, etc.
void	setDragModifier(int m) Sets the mouse modifier for dragging of chart, legend, etc.
void	setForwardLinkClickCount(int c) Sets the mouse click count for jumping to a hyperlink associated with a data point.
void	setForwardLinkEnabled(boolean b) Sets the status of the foward link depending on the value of parameter b.
void	setForwardLinkModifier(int m) Sets the mouse modifier for jumping to a hyperlink associated with a data point.
void	setResizeCanvasClickCount(int c) Returns the mouse click count for starting a canvas resize operation.
void	setResizeCanvasEnabled(boolean b) Sets the status of the resizing of the canvas depending on the value of parameter b.
void	setResizeCanvasModifier(int m) Sets the mouse modifier for starting a canvas resize operation.
void	setResizeClickCount(int c) Returns the mouse click count for starting a chart resize operation.
void	setResizeEnabled(boolean b) Sets the status of the resizing of the chart depending on the value of parameter b.
void	setResizeModifier(int m) Sets the mouse modifier for starting a chart resize operation.
void	setUndoZoomClickCount(int c) Returns the mouse click count for undoing a zooming operation.
void	setUndoZoomModifier(int m) Sets the mouse modifier for undoing a zoom operation.
void	setZoomClickCount(int c) Returns the mouse click count for starting a zooming operation.
void	setZoomEventsEnabled(boolean b) Enables/Disables handling of mouse events for date/time based zooming operations.
void	setZoomModifier(int m) Sets the mouse modifier for starting a zooming operation.

Method Detail

isDragEnabled

public boolean isDragEnabled()

Returns true if dragging of the chart,legend, etc. is enabled.

setDragEnabled

public void setDragEnabled(boolean b)

Sets the status of the dragging of the chart, legend, etc. depending on the value of parameter b.

See Also:

isDragEnabled()

getDragModifier

public int getDragModifier()

Returns the mouse modifier for dragging of chart, legend, etc.

setDragModifier

public void setDragModifier(int m)

Sets the mouse modifier for dragging of chart, legend, etc. The default modifier is 0 (left mouse button).

getDragClickCount

public int getDragClickCount()

Returns the mouse click count for dragging of chart, legend, etc.

setDragClickCount

public void setDragClickCount(int c)

Returns the mouse click count for dragging of chart, legend, etc. Setting the click count to 0 disables the operation.

isResizeEnabled

public boolean isResizeEnabled()

Returns true if resizing of the chart is enabled.

setResizeEnabled

public void setResizeEnabled(boolean b)

Sets the status of the resizing of the chart depending on the value of parameter b.

See Also:

isResizeEnabled()

getResizeModifier

public int getResizeModifier()

Returns the mouse modifier for starting a chart resize operation.

setResizeModifier

public void setResizeModifier(int m)

Sets the mouse modifier for starting a chart resize operation. The default modifier is MouseEvent.META_MASK (right mouse button).

getResizeClickCount

public int getResizeClickCount()

Returns the mouse click count for resizing a chart

setResizeClickCount

public void setResizeClickCount(int c)

Returns the mouse click count for starting a chart resize operation. The default click count is 1. Setting the value to 0 disables the operation.

isResizeCanvasEnabled

public boolean isResizeCanvasEnabled()

Returns true if resizing of the canvas is enabled.

setResizeCanvasEnabled

public void setResizeCanvasEnabled(boolean b)

Sets the status of the resizing of the canvas depending on the value of parameter b.

See Also:

isResizeCanvasEnabled()

getResizeCanvasModifier

public int getResizeCanvasModifier()

Returns the mouse modifier for starting a canvas resize operation.

setResizeCanvasModifier

public void setResizeCanvasModifier(int m)

Sets the mouse modifier for starting a canvas resize operation. Sets the mouse modifier for starting a chart resize operation. The default modifier is MouseEvent.META_MASK | MouseEvent.ALT_MASK

getResizeCanvasClickCount

public int getResizeCanvasClickCount()

Returns the mouse click count for resizing a canvas

setResizeCanvasClickCount

public void setResizeCanvasClickCount(int c)

Returns the mouse click count for starting a canvas resize operation. The default click count is 1. Setting the value to 0 disables the operation.

isForwardLinkEnabled

public boolean isForwardLinkEnabled()

Returns true if forward link is enabled.

setForwardLinkEnabled

public void setForwardLinkEnabled(boolean b)

Sets the status of the foward link depending on the value of parameter b.

getForwardLinkModifier

public int getForwardLinkModifier()

Returns the mouse modifier for jumping to a hyperlink associated with a data point.

setForwardLinkModifier

public void setForwardLinkModifier(int m)

Sets the mouse modifier for jumping to a hyperlink associated with a data point. The default modifier is 0 (left mouse button).

getForwardLinkClickCount

public int getForwardLinkClickCount()

Returns the mouse click count for jumping to a hyperlink associated with a data point.

setForwardLinkClickCount

public void setForwardLinkClickCount(int c)

Sets the mouse click count for jumping to a hyperlink associated with a data point. The default click count is 2. Setting the value to 0 disables the operation.

isBackLinkEnabled

public boolean isBackLinkEnabled()

Returns true if backward link is enabled.

setBackLinkEnabled

public void setBackLinkEnabled(boolean b)

Sets the status of the backward link depending on the value of parameter b.

getBackLinkModifier

public int getBackLinkModifier()

Sets the mouse modifier for jumping back from a hyperlink to the previous chart. The default modifier is 0 (left mouse button).

setBackLinkModifier

public void setBackLinkModifier(int m)

Sets the mouse modifier for jumping back from a hyperlink to the previous chart. The default modifier is MouseEvent.META_MASK (right mouse button).

getBackLinkClickCount

public int getBackLinkClickCount()

Returns the mouse click count for jumping back from a hyperlink to the previous chart.

setBackLinkClickCount

public void setBackLinkClickCount(int c)

Sets the mouse click count for jumping back from a hyperlink to the previous chart. The default click count is 2. Setting the value to 0 disables the operation.

areZoomEventsEnabled

public boolean areZoomEventsEnabled()

Returns the enable/disable status of mouse events for date/time based zooming operations.

Returns:

true if handling of user mouse/key events for date/time based zooming is enabled, false otherwise.

setZoomEventsEnabled

public void setZoomEventsEnabled(boolean b)

Enables/Disables handling of mouse events for date/time based zooming operations.

Parameters:

b - set to true to enable handling of user mouse/key events for date/time based zooming.

getZoomModifier

public int getZoomModifier()

Returns the mouse modifier for starting a zooming operation.

setZoomModifier

public void setZoomModifier(int m)

Sets the mouse modifier for starting a zooming operation. The default modifier is MouseEvent.CTRL_MASK.

getZoomClickCount

public int getZoomClickCount()

Returns the mouse click count for starting a zooming operation

setZoomClickCount

public void setZoomClickCount(int c)

Returns the mouse click count for starting a zooming operation. Setting the click count to 0 disables the operation.

getUndoZoomModifier

public int getUndoZoomModifier()

Returns the mouse modifier for undoing a zooming operation.

setUndoZoomModifier

public void setUndoZoomModifier(int m)

Sets the mouse modifier for undoing a zoom operation. The default modifier is MouseEvent.CTRL_MASK.

getUndoZoomClickCount

public int getUndoZoomClickCount()

Returns the mouse click count for undoing a zooming operation

setUndoZoomClickCount

public void setUndoZoomClickCount(int c)

Returns the mouse click count for undoing a zooming operation. Setting the click count to 0 disables the operation.