ilog.views.gantt.graphic.interactor

Class IlvActivityGraphicMoveInteractor

java.lang.Object

ilog.views.IlvManagerViewInteractor

ilog.views.gantt.graphic.interactor.IlvGanttSheetInteractor

ilog.views.gantt.graphic.interactor.IlvActivityGraphicMoveInteractor

All Implemented Interfaces:

Serializable

public class IlvActivityGraphicMoveInteractor
extends IlvGanttSheetInteractor

The interactor used to move activity graphics and reservation graphics selected by the IlvGanttSelectInteractor.

See Also:

IlvGanttSelectInteractor.getMoveSelectionInteractor(), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO_DETECT Identifies that the activity movement axis, either horizontal or vertical, will be determined automatically when the user starts dragging the mouse.
static int	BOTH Identifies that activity movement is allowed on both the horizontal and vertical axes.
static int	HORIZONTAL Identifies that activity movement is allowed on the horizontal axis.
static int	VERTICAL Identifies that activity movement is allowed on the vertical axis.

Constructor Summary

Constructors

Constructor and Description
IlvActivityGraphicMoveInteractor(IlvGanttSelectInteractor inter) Creates a new IlvActivityGraphicMoveInteractor object.

Method Summary

Modifier and Type	Method and Description
void	abort() This function is called when the user presses the Esc key to abort the current interaction.
protected void	attach(IlvManagerView v) This method is called when the interactor is attached to the specified manager view.
protected void	detach() This method is called when the interactor is detached from the specified manager view.
void	drawGhost(Graphics g) Draws the ghost.
Cursor	getCursor() Returns the cursor used for edition.
int	getMovementAxis() Returns the movement axis along which the user is allowed to drag activities when the interactor is attached to an IlvScheduleChart.
void	init() Initializes the interactor.
boolean	isMovementDetectionEnabled() Deprecated. Beginning with Perforce JViews 7.5, use getMovementAxis() == AUTO_DETECT instead.
boolean	isSnapGhostToRowsEnabled() Returns whether ghost graphics are snapped to the nearest row when the mouse is dragged vertically and the IlvGanttSelectInteractor that created this interactor is in Ghost Move mode.
protected void	processKeyEvent(KeyEvent e) Processes the key events.
protected void	processMouseEvent(MouseEvent event) Processes mouse events.
protected void	processMouseMotionEvent(MouseEvent event) Processes mouse motion events.
void	setCursor(Cursor cursor) Changes the cursor used for edition.
void	setMovementAxis(int axis) Sets the movement axis along which the user is allowed to drag activities when the interactor is attached to an IlvScheduleChart.
void	setMovementDetectionEnabled(boolean detect) Deprecated. Beginning with Perforce JViews 7.5, use setMovementAxis(detect ? AUTO_DETECT : BOTH) instead.
void	setSnapGhostToRowsEnabled(boolean enable) Sets whether ghost graphics are snapped to the nearest row when the mouse is dragged vertically and the IlvGanttSelectInteractor that created this interactor is in Ghost Move mode.

Methods inherited from class ilog.views.gantt.graphic.interactor.IlvGanttSheetInteractor

getGanttModel, getGanttSheet

Methods inherited from class ilog.views.IlvManagerViewInteractor

addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, allowEnsureVisible, allowEnsureVisible, disableEvents, drawGhost, enableEvents, ensureVisible, ensureVisible, getManager, getManagerView, getTransformer, handleExpose, isXORGhost, processEvent, processFocusEvent, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, setXORGhost

Methods inherited from class java.lang.Object

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

Field Detail

BOTH

public static final int BOTH

Identifies that activity movement is allowed on both the horizontal and vertical axes.

Since:

JViews 7.5

See Also:

HORIZONTAL, VERTICAL, AUTO_DETECT, getMovementAxis(), setMovementAxis(int), Constant Field Values

HORIZONTAL

public static final int HORIZONTAL

Identifies that activity movement is allowed on the horizontal axis.

Since:

JViews 7.5

See Also:

BOTH, VERTICAL, AUTO_DETECT, getMovementAxis(), setMovementAxis(int), Constant Field Values

VERTICAL

public static final int VERTICAL

Identifies that activity movement is allowed on the vertical axis.

Since:

JViews 7.5

See Also:

HORIZONTAL, BOTH, AUTO_DETECT, getMovementAxis(), setMovementAxis(int), Constant Field Values

AUTO_DETECT

public static final int AUTO_DETECT

Identifies that the activity movement axis, either horizontal or vertical, will be determined automatically when the user starts dragging the mouse.

Since:

JViews 7.5

See Also:

VERTICAL, HORIZONTAL, BOTH, getMovementAxis(), setMovementAxis(int), Constant Field Values

Constructor Detail

IlvActivityGraphicMoveInteractor

public IlvActivityGraphicMoveInteractor(IlvGanttSelectInteractor inter)

Creates a new IlvActivityGraphicMoveInteractor object. An IlvActivityGraphicMoveInteractor is usually created by the method getMoveSelectionInteractor of IlvGanttSelectInteractor.

Parameters:

inter - the IlvGanttSelectInteractor that creates the interactor.

See Also:

IlvGanttSelectInteractor.getMoveSelectionInteractor()

Method Detail

init

public void init()

Initializes the interactor.

getMovementAxis

public int getMovementAxis()

Returns the movement axis along which the user is allowed to drag activities when the interactor is attached to an IlvScheduleChart. This value is ignored when the interactor is attached to an IlvGanttChart because only horizontal movement along the time axis is allowed. The value will be one of BOTH, HORIZONTAL, VERTICAL, or AUTO_DETECT. The default value is BOTH.

Returns:

The movement axis.

Since:

JViews 7.5

See Also:

setMovementAxis(int)

setMovementAxis

public void setMovementAxis(int axis)

Sets the movement axis along which the user is allowed to drag activities when the interactor is attached to an IlvScheduleChart. This value is ignored when the interactor is attached to an IlvGanttChart because only horizontal movement along the time axis is allowed.

Parameters:

axis - The movement axis. The value must be one of BOTH, HORIZONTAL, VERTICAL, or AUTO_DETECT.

Since:

JViews 7.5

See Also:

getMovementAxis()

isMovementDetectionEnabled

@Deprecated
public boolean isMovementDetectionEnabled()

Deprecated. Beginning with Perforce JViews 7.5, use getMovementAxis() == AUTO_DETECT instead.

Returns whether the interactor should detect the preferred movement when the mouse begins to drag. If set to true, the interactor detects the most favorite mouse movement, either horizontally or vertically. The default value is false.

Returns:

Whether the interactor should detect the preferred movement when the mouse begins to drag.

See Also:

IlvGanttSelectInteractor.isMovementDetectionEnabled(), IlvGanttSelectInteractor.setMovementDetectionEnabled(boolean)

setMovementDetectionEnabled

@Deprecated
public void setMovementDetectionEnabled(boolean detect)

Deprecated. Beginning with Perforce JViews 7.5, use setMovementAxis(detect ? AUTO_DETECT : BOTH) instead.

Sets whether the interactor should detect the preferred movement when the mouse begins to drag. If set to true, the interactor detects the most favorite mouse movement, either horizontally or vertically. If set to false, movement is allowed along both the horizontal and vertical axes.

Parameters:

detect - The state of the movement detection.

See Also:

IlvGanttSelectInteractor.isMovementDetectionEnabled(), IlvGanttSelectInteractor.setMovementDetectionEnabled(boolean)

isSnapGhostToRowsEnabled

public boolean isSnapGhostToRowsEnabled()

Returns whether ghost graphics are snapped to the nearest row when the mouse is dragged vertically and the IlvGanttSelectInteractor that created this interactor is in Ghost Move mode. If false, ghost graphics smoothly track vertical mouse movement, just as they do horizontal mouse movement. The default value is true.

Returns:

Whether ghost graphics are snapped to the nearest row when the mouse is dragged vertically.

Since:

JViews 6.0

See Also:

setSnapGhostToRowsEnabled(boolean)

setSnapGhostToRowsEnabled

public void setSnapGhostToRowsEnabled(boolean enable)

Sets whether ghost graphics are snapped to the nearest row when the mouse is dragged vertically and the IlvGanttSelectInteractor that created this interactor is in Ghost Move mode. If false, ghost graphics smoothly track vertical mouse movement, just as they do horizontal mouse movement.

Parameters:

enable - Enable or disable ghost graphics to snap to rows.

Since:

JViews 6.0

See Also:

isSnapGhostToRowsEnabled()

attach

protected void attach(IlvManagerView v)

This method is called when the interactor is attached to the specified manager view.

Overrides:

attach in class IlvManagerViewInteractor

Parameters:

v - The manager view.

See Also:

IlvManagerViewInteractor.detach()

detach

protected void detach()

This method is called when the interactor is detached from the specified manager view.

Overrides:

detach in class IlvManagerViewInteractor

See Also:

IlvManagerViewInteractor.attach(ilog.views.IlvManagerView)

getCursor

public Cursor getCursor()

Returns the cursor used for edition.

Returns:

The Cursor.

setCursor

public void setCursor(Cursor cursor)

Changes the cursor used for edition.

Parameters:

cursor - The Cursor.

processMouseEvent

protected void processMouseEvent(MouseEvent event)

Processes mouse events.

Overrides:

processMouseEvent in class IlvManagerViewInteractor

Parameters:

event - The MouseEvent.

See Also:

IlvManagerViewInteractor.addMouseListener(java.awt.event.MouseListener)

processMouseMotionEvent

protected void processMouseMotionEvent(MouseEvent event)

Processes mouse motion events.

Overrides:

processMouseMotionEvent in class IlvManagerViewInteractor

Parameters:

event - The MouseEvent.

See Also:

IlvManagerViewInteractor.addMouseMotionListener(java.awt.event.MouseMotionListener)

processKeyEvent

protected void processKeyEvent(KeyEvent e)

Processes the key events. If Esc is pressed then the interaction will be aborted.

Overrides:

processKeyEvent in class IlvManagerViewInteractor

Parameters:

e - The KeyEvent

See Also:

abort()

abort

public void abort()

This function is called when the user presses the Esc key to abort the current interaction.

drawGhost

public void drawGhost(Graphics g)

Draws the ghost.

Overrides:

drawGhost in class IlvManagerViewInteractor

Parameters:

g - The graphics context.

See Also:

IlvManagerViewInteractor.handleExpose(java.awt.Graphics), IlvManagerViewInteractor.setXORGhost(boolean)