java.lang.Object

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

com.inductiveautomation.factorypmi.designer.workspace.tools.AbstractShapeTool

All Implemented Interfaces:: IDesignTool

Direct Known Subclasses:: AbstractRectangularShapeTool, ArrowTool, PathEditorTool, PolygonTool

public abstract class AbstractShapeTool extends AbstractDesignTool

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

protected static class

AbstractShapeTool.AbstractShapeControls

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

Fields

Modifier and Type

Field

Description

protected PathBasedVisionShape

addingShape

protected Cursor

cursor

protected JComponent

dropContainer

Fields inherited from class com.inductiveautomation.ignition.designer.designable.tools.AbstractDesignTool
actionMap, changeSupport, designable, HANDLES_PROPERTY, inputMap, interactionLayer, panel, workspace
Constructor Summary

Constructors

Constructor

Description

AbstractShapeTool()
Method Summary

Modifier and Type

Method

Description

protected abstract Cursor

createCursor()

protected void

disableToolbar()

Cursor

getCursor(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

protected abstract Class<? extends ShapeDelegate>

getDelegateType()

protected abstract String

getNewShapeName()

protected PathBasedVisionShape

getShape()

protected boolean

handlesShape(ShapeDelegate shape)

void

install(DesignPanel panel)

Installs the tool for the given panel.

boolean

isRelevantFor(JComponent component)

ISelectionControl

newSelectionControl()

Gives the tool a chance to create a new selection control object to install handles on the selection.

protected abstract ISelectionControl

newShapeControl()

protected abstract ShapeDelegate

newShapeDelegate(Rectangle2D rect)

void

onClick(Point p, int modifiers)

Called when the user clicks in the design space.

void

onDrag(Point startPoint, Point lastPoint, Rectangle r, int modifiers)

Called while the user is dragging.

void

onDragEnd(Point startPoint, Point lastPoint, Rectangle r, int modifiers)

Called when the user stops dragging.

void

onDragStart(Point startPoint, Point lastPoint, Rectangle r, int modifiers)

Called when the user start's dragging while this tool is active.

void

onPress(Point move, int modifiers)

Called when the user presses the mouse in the design space.

protected static String

tt(String key)

Shortcut for:

void

uninstall()

Uninstalls the tool.

protected void

updateToolbar(PathBasedVisionShape shape)

protected void

updateToolbar(List<JComponent> selection)

protected boolean

validSelection(List<JComponent> selection)

Methods inherited from class com.inductiveautomation.ignition.designer.designable.tools.AbstractDesignTool
addAction, addKeyBinding, addKeyBinding, addPropertyChangeListener, createCursor, findDropContainer, getAction, getDragHighlight, getOffsettingBounds, getOriginalBounds, getStatusBarText, getToolbarInitializer, isInstalled, itemMovable, movable, newToolbarSpinner, newToolbarSpinner, newToolbarSpinner, onClickAlterSelection, onDoubleClick, onKeyEvent, onMove, onPopupTrigger, onRelease, onRightClickSwitchToSelectionTool, removePropertyChangeListener

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- dropContainer
  
  protected JComponent dropContainer
- addingShape
  
  protected PathBasedVisionShape addingShape
- cursor
  
  protected Cursor cursor
Constructor Details
- AbstractShapeTool
  
  public AbstractShapeTool()
Method Details
- tt
  
  protected static String tt(String key)
  Shortcut for:
  
  "<html>" + BundleUtil.get().getString("fpmi." + key);
- install
  
  public void install(DesignPanel panel)
  
  Description copied from interface: IDesignTool
  
  Installs the tool for the given panel. Tools are built to be re-used by repeatedly being installed and then uninstalled as tools get switched out.
  
  Specified by:
  
  install in interface IDesignTool
  
  Overrides:
  
  install in class AbstractDesignTool
- uninstall
  
  public void uninstall()
  
  Description copied from interface: IDesignTool
  
  Uninstalls the tool.
  
  Specified by:
  
  uninstall in interface IDesignTool
  
  Overrides:
  
  uninstall in class AbstractDesignTool
- isRelevantFor
  
  public boolean isRelevantFor(JComponent component)
  
  Overrides:
  
  isRelevantFor in class AbstractDesignTool
- getShape
  
  protected PathBasedVisionShape getShape()
- updateToolbar
  
  protected void updateToolbar(List<JComponent> selection)
- updateToolbar
  
  protected void updateToolbar(PathBasedVisionShape shape)
- disableToolbar
  
  protected void disableToolbar()
- createCursor
  
  protected abstract Cursor createCursor()
- onPress
  
  public void onPress(Point move, int modifiers)
  
  Description copied from interface: IDesignTool
  
  Called when the user presses the mouse in the design space.
  
  Specified by:
  
  onPress in interface IDesignTool
  
  Overrides:
  
  onPress in class AbstractDesignTool
  
  Parameters:
  
  move - The point at which they pressed. Relative to the designable container.
  
  modifiers - A bitmask of modifiers. Comes from InputEvent.getModifiersEx()
- onClick
  
  public void onClick(Point p, int modifiers)
  
  Description copied from interface: IDesignTool
  
  Called when the user clicks in the design space.
  
  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()
- getCursor
  
  public Cursor getCursor(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
- onDragStart
  
  public void onDragStart(Point startPoint, Point lastPoint, Rectangle r, int modifiers)
  
  Description copied from class: AbstractDesignTool
  
  Called when the user start's dragging while this tool is active. All coordinates are relative to the interaction panel and are in zoomed space.
  
  Specified by:
  
  onDragStart in interface IDesignTool
  
  Overrides:
  
  onDragStart in class AbstractDesignTool
- onDrag
  
  public void onDrag(Point startPoint, Point lastPoint, 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(Point startPoint, Point lastPoint, 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
- 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
- validSelection
  
  protected boolean validSelection(List<JComponent> selection)
- handlesShape
  
  protected boolean handlesShape(ShapeDelegate shape)
- newShapeControl
  
  protected abstract ISelectionControl newShapeControl()
- getDelegateType
  
  protected abstract Class<? extends ShapeDelegate> getDelegateType()
- newShapeDelegate
  
  protected abstract ShapeDelegate newShapeDelegate(Rectangle2D rect)
- getNewShapeName
  
  protected abstract String getNewShapeName()

Class AbstractShapeTool

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Details

dropContainer

addingShape

cursor

Constructor Details

AbstractShapeTool

Method Details

tt

install

uninstall

isRelevantFor

getShape

updateToolbar

updateToolbar

disableToolbar

createCursor

onPress

onClick

getCursor

onDragStart

onDrag

onDragEnd

newSelectionControl

validSelection

handlesShape

newShapeControl

getDelegateType

newShapeDelegate

getNewShapeName