MouseTransform (jPicEdt 1.4.1_03 API documentation)

All Known Implementing Classes:

AbstractMouseTransform, AbstractMouseTransformFactory.HelpMessageMouseTransform, AbstractMouseTransformFactory.InvalidMouseTransform, AbstractMouseTransformFactory.SelectAreaTransform, EditElementMouseTransformFactory._MoveControlPointTransform, EditElementMouseTransformFactory._MoveElementTransform, EditElementMouseTransformFactory.MoveControlPointTransform, EditElementMouseTransformFactory.MoveElementTransform, EditElementMouseTransformFactory.SelectElementsInAreaTransform, EditElementMouseTransformFactory.UnselectTransform, EditPointMouseTransformFactory.EditSmoothCoeffTransform, EditPointMouseTransformFactory.RemovePointTransform, EditPointMouseTransformFactory.SelectElementTransform, EditPointMouseTransformFactory.SelectPointsInAreaTransform, EditPointMouseTransformFactory.SplitSegmentTransform, EditPointMouseTransformFactory.UnSelectPointTransform
```
public interface MouseTransform
```
an interface that specifies behaviours shared by mouse-driven object-editing actions, especially when driven by SelectionTool. Sequence order is : mouse-press : start() mouse-dragged : process() mouse-released : next() ? no => end() mouse-moved : process() mouse-pressed : next() ? no => end() etc...

Since:

jpicedt 1.3.2

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.awt.Cursor`	`getCursor()`	Return the cursor for this MouseTransform
`java.lang.String`	`getHelpMessage()`	Return a help-message for the UI, that makes sense with this transform.
`boolean`	`next(PEMouseEvent e)`	Called when the left mouse-button changes state.
`void`	`paint(java.awt.Graphics2D g, java.awt.geom.Rectangle2D allocation, double scale)`	Allows the MouseTransform to do specific graphic rendering when it's operating.
`void`	`process(PEMouseEvent e)`	Called when the mouse is dragged/moved after the first mouse-pressed event.
`void`	`start(PEMouseEvent e)`	Called when the mouse is pressed.

- Method Detail
  - start
```
void start(PEMouseEvent e)
```
    Called when the mouse is pressed. The transform should do the initialization work here.
    
    Since:
    
    jpicedt 1.3.2
  - process
```
void process(PEMouseEvent e)
```
    Called when the mouse is dragged/moved after the first mouse-pressed event. Element geometry update should occur here.
    
    Since:
    
    jpicedt 1.3.2
  - next
```
boolean next(PEMouseEvent e)
```
    Called when the left mouse-button changes state.
    
    Returns:
    
    true if there's another task in the sequence, false if mouse-transform has completed with this mouse-event.
  - getCursor
```
java.awt.Cursor getCursor()
```
    Return the cursor for this MouseTransform
    
    Since:
    
    jpicedt 1.3.2
  - paint
```
void paint(java.awt.Graphics2D g,
           java.awt.geom.Rectangle2D allocation,
           double scale)
```
    Allows the MouseTransform to do specific graphic rendering when it's operating.
    
    Since:
    
    jpicedt 1.3.2
  - getHelpMessage
```
java.lang.String getHelpMessage()
```
    Return a help-message for the UI, that makes sense with this transform.