com.inductiveautomation.ignition.designer.designable.tools

Class SelectionTool

java.lang.Object

com.inductiveautomation.ignition.designer.designable.tools.AbstractDesignTool

com.inductiveautomation.ignition.designer.designable.tools.AbstractLayoutTool

com.inductiveautomation.ignition.designer.designable.tools.SelectionTool

All Implemented Interfaces:

IDesignTool, IDesignTool.ToolbarInitializer

Direct Known Subclasses:

AbstractBlockWorkspace.ConnectionTool

public class SelectionTool
extends AbstractLayoutTool
implements IDesignTool.ToolbarInitializer

This tool handles

1. selecting components via click, marquee, and fence selection
2. moving components by dragging

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SelectionTool.DragMode

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.designer.designable.tools.AbstractLayoutTool

AbstractLayoutTool.AbstractAlignmentAction, AbstractLayoutTool.AbstractNudgeAction, AbstractLayoutTool.AbstractZOrderAction, AbstractLayoutTool.AlignEdge, AbstractLayoutTool.CenterAction, AbstractLayoutTool.MoveNudgeAction, AbstractLayoutTool.MoveToTopOrBottomAction, AbstractLayoutTool.MoveUpOrDownAction, AbstractLayoutTool.Rotate90Action, AbstractLayoutTool.RowStackAction, AbstractLayoutTool.ScaleNudgeAction, AbstractLayoutTool.ZOrderChangeUndoAction

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.designer.designable.IDesignTool

IDesignTool.ToolbarInitializer

Field Summary

Fields

Modifier and Type	Field and Description
protected long	lastClick
protected boolean	rotationInstalled
protected boolean	rotationPrimed
static java.awt.Color	SELECTION_COLOR
static java.awt.Color	SELECTION_COLOR_FILL
protected java.util.List<javax.swing.JComponent>	toMove When doing a MOVE drag gesture, these are the objects that will be moved.

Fields inherited from class com.inductiveautomation.ignition.designer.designable.tools.AbstractLayoutTool

ALIGN_AS_ROW, ALIGN_AS_ROW_NORMALIZE, ALIGN_AS_STACK, ALIGN_AS_STACK_NORMALIZE, ALIGN_BOTTOM, ALIGN_CENTER_HORIZONTAL, ALIGN_CENTER_VERTICAL, ALIGN_CENTERSH, ALIGN_CENTERSV, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_TOP, MOVE_BACKWARD, MOVE_FORWARD, MOVE_TO_BACK, MOVE_TO_FRONT, ROTATE_LEFT, ROTATE_RIGHT

Fields inherited from class com.inductiveautomation.ignition.designer.designable.tools.AbstractDesignTool

actionMap, changeSupport, designable, HANDLES_PROPERTY, inputMap, interactionLayer, panel, workspace

Constructor Summary

Constructors

Constructor and Description
SelectionTool()

Method Summary

Modifier and Type	Method and Description
protected void	addAlignmentActions(DesignerToolbar toolbar)
protected void	addKeyBinding(int keyCode, int modifiers, javax.swing.Action action)
protected void	addZOrderActions(DesignerToolbar toolbar)
protected java.lang.String	formatLocation(javax.swing.JComponent bean, double x, double y, double width, double height)
java.awt.Cursor	getCursor(java.awt.Point point, int inputEventMask) The cursor to use given the current event mask, which can be used to detect what keys are being held down
IHighlight	getDragHighlight() Called while dragging as an easy way for a tool to install a highlight while dragging.
protected SelectionTool.DragMode	getDragMode(java.awt.Point startPoint, int modifiers, DesignableDelegate delegate, java.util.List<javax.swing.JComponent> selected, javax.swing.JComponent underMouse) Get the drag mode for the given conditions.
java.lang.String	getStatusBarText(java.util.List<javax.swing.JComponent> selection, java.awt.Point point, int inputMask) Calculates the currently applicable status bar text for this tool
IDesignTool.ToolbarInitializer	getToolbarInitializer()
void	initializeToolbar(DesignerToolbar toolbar)
protected void	initKeyboardActions()
boolean	isRelevantFor(javax.swing.JComponent component)
protected ISelectionControl	newRotationControl()
protected ISelectionControl	newScaleControl()
ISelectionControl	newSelectionControl() Gives the tool a chance to create a new selection control object to install handles on the selection.
void	onClick(java.awt.Point p, int modifiers) A normal click will select (or toggle selection - use CTRL) for the component that is under the click.
void	onDoubleClick(java.awt.Point p, int mofidiers) Called when the user double-clicks
void	onDrag(java.awt.Point startPoint, java.awt.Point lastPoint, java.awt.Rectangle r, int modifiers) Called while the user is dragging.
void	onDragEnd(java.awt.Point startPoint, java.awt.Point lastPoint, java.awt.Rectangle r, int modifiers) Called when the user stops dragging.
void	onDragStart(java.awt.Point startPoint, java.awt.Point lastPoint, java.awt.Rectangle r, int modifiers) Starting a drag gesture.
void	onPopupTrigger(java.awt.Point p, int modifiers) Called when the user issues a click that matches the current system's notion of a popup-menu trigger

Methods inherited from class com.inductiveautomation.ignition.designer.designable.tools.AbstractLayoutTool

componentsAreSiblings, convertBoundsToParent, evaluateEnabled, install, removeDescendents

Methods inherited from class com.inductiveautomation.ignition.designer.designable.tools.AbstractDesignTool

addAction, addKeyBinding, addKeyBinding, addPropertyChangeListener, createCursor, findDropContainer, getAction, getOffsettingBounds, getOriginalBounds, isInstalled, itemMovable, movable, newToolbarSpinner, newToolbarSpinner, newToolbarSpinner, onClickAlterSelection, onKeyEvent, onMove, onPress, onRelease, onRightClickSwitchToSelectionTool, removePropertyChangeListener, uninstall

Methods inherited from class java.lang.Object

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

Field Detail

SELECTION_COLOR

public static final java.awt.Color SELECTION_COLOR

SELECTION_COLOR_FILL

public static final java.awt.Color SELECTION_COLOR_FILL

toMove

protected java.util.List<javax.swing.JComponent> toMove

When doing a MOVE drag gesture, these are the objects that will be moved.

rotationPrimed

protected boolean rotationPrimed

rotationInstalled

protected boolean rotationInstalled

lastClick

protected long lastClick

Constructor Detail

SelectionTool

public SelectionTool()

Method Detail

isRelevantFor

public boolean isRelevantFor(javax.swing.JComponent component)

Overrides:

isRelevantFor in class AbstractDesignTool

initKeyboardActions

protected void initKeyboardActions()

addKeyBinding

protected void addKeyBinding(int keyCode,
                             int modifiers,
                             javax.swing.Action action)

getCursor

public java.awt.Cursor getCursor(java.awt.Point point,
                                 int inputEventMask)

Description copied from interface: IDesignTool

The cursor to use given the current event mask, which can be used to detect what keys are being held down

Specified by:

getCursor in interface IDesignTool

Overrides:

getCursor in class AbstractDesignTool

initializeToolbar

public void initializeToolbar(DesignerToolbar toolbar)

Specified by:

initializeToolbar in interface IDesignTool.ToolbarInitializer

addAlignmentActions

protected void addAlignmentActions(DesignerToolbar toolbar)

addZOrderActions

protected void addZOrderActions(DesignerToolbar toolbar)

getToolbarInitializer

public IDesignTool.ToolbarInitializer getToolbarInitializer()

Specified by:

getToolbarInitializer in interface IDesignTool

Overrides:

getToolbarInitializer in class AbstractDesignTool

newSelectionControl

public ISelectionControl newSelectionControl()

Description copied from interface: IDesignTool

Gives the tool a chance to create a new selection control object to install handles on the selection. Called on the active tool when the selection changes or after a tool is first installed.

Specified by:

newSelectionControl in interface IDesignTool

Overrides:

newSelectionControl in class AbstractDesignTool

newScaleControl

protected ISelectionControl newScaleControl()

newRotationControl

protected ISelectionControl newRotationControl()

getStatusBarText

public java.lang.String getStatusBarText(java.util.List<javax.swing.JComponent> selection,
                                         java.awt.Point point,
                                         int inputMask)

Description copied from interface: IDesignTool

Calculates the currently applicable status bar text for this tool

Specified by:

getStatusBarText in interface IDesignTool

Overrides:

getStatusBarText in class AbstractDesignTool

formatLocation

protected java.lang.String formatLocation(javax.swing.JComponent bean,
                                          double x,
                                          double y,
                                          double width,
                                          double height)

onClick

public void onClick(java.awt.Point p,
                    int modifiers)

A normal click will select (or toggle selection - use CTRL) for the component that is under the click. Holding ALT will have the selection step down through the Z-order so that selecting things in the background is easier.

Specified by:

onClick in interface IDesignTool

Overrides:

onClick in class AbstractDesignTool

Parameters:

p - The point at which they clicked. Relative to the designable container.

modifiers - A bitmask of modifiers. Comes from InputEvent.getModifiersEx()

onDoubleClick

public void onDoubleClick(java.awt.Point p,
                          int mofidiers)

Description copied from interface: IDesignTool

Called when the user double-clicks

Specified by:

onDoubleClick in interface IDesignTool

Overrides:

onDoubleClick in class AbstractDesignTool

onPopupTrigger

public void onPopupTrigger(java.awt.Point p,
                           int modifiers)

Description copied from interface: IDesignTool

Called when the user issues a click that matches the current system's notion of a popup-menu trigger

Specified by:

onPopupTrigger in interface IDesignTool

Overrides:

onPopupTrigger in class AbstractDesignTool

onDragStart

public void onDragStart(java.awt.Point startPoint,
                        java.awt.Point lastPoint,
                        java.awt.Rectangle r,
                        int modifiers)

Starting a drag gesture. Many different permutations of current state and key_down masks affect what the drag gesture means:

 1. If the mouse is over a non-container, and SHIFT is not down, the under-mouse object will be MOVED.
 2. If the current item selection is movable, and ALT is down, the current selection will be MOVED.
 3. Otherwise a SELECTION DRAG will start. ALT will turn the drag into FENCE SELECTION at any time, otherwise
    it will be a MARQUEE selection.
 

Specified by:

onDragStart in interface IDesignTool

Overrides:

onDragStart in class AbstractDesignTool

getDragMode

protected SelectionTool.DragMode getDragMode(java.awt.Point startPoint,
                                             int modifiers,
                                             DesignableDelegate delegate,
                                             java.util.List<javax.swing.JComponent> selected,
                                             javax.swing.JComponent underMouse)

Get the drag mode for the given conditions. Note, if the drag mode is Move, it also must fill the "toMove" collection

onDrag

public void onDrag(java.awt.Point startPoint,
                   java.awt.Point lastPoint,
                   java.awt.Rectangle r,
                   int modifiers)

Description copied from class: AbstractDesignTool

Called while the user is dragging. All coordinates are relative to the interaction panel and are in zoomed space.

Specified by:

onDrag in interface IDesignTool

Overrides:

onDrag in class AbstractDesignTool

onDragEnd

public void onDragEnd(java.awt.Point startPoint,
                      java.awt.Point lastPoint,
                      java.awt.Rectangle r,
                      int modifiers)

Description copied from class: AbstractDesignTool

Called when the user stops dragging. All coordinates are relative to the interaction panel and are in zoomed space.

Specified by:

onDragEnd in interface IDesignTool

Overrides:

onDragEnd in class AbstractDesignTool

getDragHighlight

public IHighlight getDragHighlight()

Description copied from interface: IDesignTool

Called while dragging as an easy way for a tool to install a highlight while dragging.

Specified by:

getDragHighlight in interface IDesignTool

Overrides:

getDragHighlight in class AbstractDesignTool