ilog.views.gantt.graphic.interactor

Class IlvGanttSelectInteractor

java.lang.Object

ilog.views.IlvManagerViewInteractor

ilog.views.interactor.IlvSelectInteractor

ilog.views.gantt.graphic.interactor.IlvGanttSelectInteractor

All Implemented Interfaces:

ManagerSelectionListener, Serializable, EventListener

public class IlvGanttSelectInteractor
extends IlvSelectInteractor

A selection interactor that allows you to select, move and edit the activities, reservations and constraints in a Gantt sheet.

To install the interactor, you call the setInteractor of the IlvGanttSheet.

See Also:

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
IlvGanttSelectInteractor() Creates a new selection interactor for a Gantt sheet.

Method Summary

Modifier and Type	Method and Description
protected void	attach(IlvManagerView v) This method is invoked when the interactor is attached to the manager.
protected boolean	dispatchToSelection(AWTEvent event) Resets the default cursor if the MOUSE_MOVED event is not consumed.
int	getMovementAxis() Returns the movement axis along which the user is allowed to drag activities when the interactor is attached to an IlvScheduleChart.
protected IlvManagerViewInteractor	getMoveSelectionInteractor() This method is called when the interactor needs to move the selected objects.
int	getReservationDuplicationModifier() Returns the reservation duplication modifier.
int	getReservationDuplicationModifierEx() Returns the reservation duplication modifier in extended format, according to the conventions of java.awt.event.InputEvent.getModifiersEx().
boolean	isDuplicationAllowed() Returns whether duplication of selected reservation graphics is allowed with the reservationDuplicationModifier key.
boolean	isMovementDetectionEnabled() Deprecated. Beginning with Perforce JViews 7.5, use getMovementAxis() == AUTO_DETECT instead.
protected boolean	isReservationDuplicationModifierDown(MouseEvent event) Returns whether the specified mouse event exactly contains the primary mouse button and the reservation duplication modifier down.
protected boolean	mouseDown(MouseEvent event) This method is called when a MOUSE_PRESSED event occurs without the multiple selection modifier.
void	setDuplicationAllowed(boolean set) Sets whether duplication of selected reservation graphics is allowed with the reservationDuplicationModifier key.
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	setReservationDuplicationModifier(int modifier) Sets the reservation duplication modifier.

Methods inherited from class ilog.views.interactor.IlvSelectInteractor

deSelectAll, deSelectObject, detach, drawGhostMove, getLineStyle, getMaximumScrollDistance, getMoveSelectionCursor, getMoveSelectionManager, getMoveThreshold, getMultipleSelectionCursor, getMultipleSelectionInteractor, getMultipleSelectionModifier, getMultipleSelectionModifierEx, getObject, getScrollTiming, getSelectedMovingObjects, getSelectionModifier, getSelectionModifierEx, handleExpose, isDragAllowed, isEditionAllowed, isHyperEdgesFollowEndNodes, isLinksFollowEndNodes, isMoveAffectsSingleSubManager, isMoveAllowed, isMultipleSelectionMode, isMultipleSelectionModifierDown, isObjectInteractorEnabled, isOpaqueDragSelection, isOpaqueMove, isOpaquePolyPointsEdition, isOpaqueResize, isProgressiveScroll, isSelectionInsideSubobjectsAllowed, isSelectionModifierDown, isSelectionMovable, isShowingMovingObject, mouseDownMultipleSelection, processFocusEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, selectionChanged, selectObject, setDragAllowed, setEditionAllowed, setHyperEdgesFollowEndNodes, setLineStyle, setLinksFollowEndNodes, setMaximumScrollDistance, setMoveAffectsSingleSubManager, setMoveAllowed, setMoveSelectionCursor, setMoveThreshold, setMultipleSelectionCursor, setMultipleSelectionMode, setMultipleSelectionModifier, setObjectInteractorEnabled, setOpaqueDragSelection, setOpaqueMove, setOpaquePolyPointsEdition, setOpaqueResize, setProgressiveScroll, setScrollTiming, setSelectionInsideSubobjectsAllowed, setSelectionModifier, setShowingMovingObject, setXORGhost

Methods inherited from class ilog.views.IlvManagerViewInteractor

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

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

IlvGanttSelectInteractor

public IlvGanttSelectInteractor()

Creates a new selection interactor for a Gantt sheet.

Method Detail

attach

protected void attach(IlvManagerView v)

This method is invoked when the interactor is attached to the manager.

Overrides:

attach in class IlvSelectInteractor

Parameters:

v - The manager view.

See Also:

IlvManagerViewInteractor.detach()

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:

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:

isMovementDetectionEnabled()

getReservationDuplicationModifier

public int getReservationDuplicationModifier()

Returns the reservation duplication modifier. The default modifier is the ALT key.

Returns:

The duplication modifier.

Since:

JViews 7.5

See Also:

getReservationDuplicationModifierEx(), setReservationDuplicationModifier(int), isReservationDuplicationModifierDown(java.awt.event.MouseEvent)

getReservationDuplicationModifierEx

public final int getReservationDuplicationModifierEx()

Returns the reservation duplication modifier in extended format, according to the conventions of java.awt.event.InputEvent.getModifiersEx(). This mask is computed from getReservationDuplicationModifier().

Returns:

The duplication modifier in extended format.

Since:

JViews 7.5

See Also:

getReservationDuplicationModifier(), setReservationDuplicationModifier(int), isReservationDuplicationModifierDown(java.awt.event.MouseEvent)

setReservationDuplicationModifier

public void setReservationDuplicationModifier(int modifier)

Sets the reservation duplication modifier. This is used by the interactor to determine if a mouse press within a reservation graphic initiates duplication of the reservation.

Note: Although Input.XXX_MASK constants are accepted, it is preferable to use the Input.XXX_DOWN_MASK constants available in JDK 1.4 and later. This is to avoid any ambiguity between ALT_MASK and BUTTON2_MASK which share the same value, and between META_MASK and BUTTON3_MASK which share the same value.

Parameters:

modifier - The modifier applied to the mouse press used to determine if the interaction should be initiated.

Since:

JViews 7.5

See Also:

getReservationDuplicationModifier(), getReservationDuplicationModifierEx(), isReservationDuplicationModifierDown(java.awt.event.MouseEvent)

isReservationDuplicationModifierDown

protected boolean isReservationDuplicationModifierDown(MouseEvent event)

Returns whether the specified mouse event exactly contains the primary mouse button and the reservation duplication modifier down. This is used by the interactor to determine if a mouse press within a reservation graphic initiates duplication of the reservation.

Parameters:

event - The mouse event.

Returns:

Indicates whether the duplication modifier is pressed.

Since:

JViews 7.5

See Also:

getReservationDuplicationModifier(), setReservationDuplicationModifier(int)

isDuplicationAllowed

public boolean isDuplicationAllowed()

Returns whether duplication of selected reservation graphics is allowed with the reservationDuplicationModifier key. The default value is true.

Returns:

Whether duplication of selected reservation graphics is allowed.

See Also:

setDuplicationAllowed(boolean)

setDuplicationAllowed

public void setDuplicationAllowed(boolean set)

Sets whether duplication of selected reservation graphics is allowed with the reservationDuplicationModifier key.

Parameters:

set - Indicates whether reservation duplication is allowed.

See Also:

isDuplicationAllowed()

getMoveSelectionInteractor

protected IlvManagerViewInteractor getMoveSelectionInteractor()

This method is called when the interactor needs to move the selected objects. It returns an instance of IlvActivityGraphicMoveInteractor.

Overrides:

getMoveSelectionInteractor in class IlvSelectInteractor

Returns:

The interactor.

See Also:

IlvSelectInteractorMoveSelection

mouseDown

protected boolean mouseDown(MouseEvent event)

This method is called when a MOUSE_PRESSED event occurs without the multiple selection modifier.

Overrides:

mouseDown in class IlvSelectInteractor

Parameters:

event - The mouse event.

Returns:

Indicates whether the event was used.

dispatchToSelection

protected boolean dispatchToSelection(AWTEvent event)

Resets the default cursor if the MOUSE_MOVED event is not consumed.

Overrides:

dispatchToSelection in class IlvSelectInteractor

Parameters:

event - The event.

Returns:

True if the event was used.