org.tigris.gef.base
Class ModeCreateEdgeAndNode

java.lang.Object
  extended byorg.tigris.gef.base.ModeImpl
      extended byorg.tigris.gef.base.FigModifyingModeImpl
          extended byorg.tigris.gef.base.ModeCreate
              extended byorg.tigris.gef.base.ModeCreateEdgeAndNode
All Implemented Interfaces:
java.util.EventListener, FigModifyingMode, java.awt.event.KeyListener, Mode, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.io.Serializable

public class ModeCreateEdgeAndNode
extends ModeCreate

A Mode to interpret user input while creating an edge. Basically mouse down starts creating an edge from a source port Fig, mouse motion paints a rubberband line, mouse up finds the destination port and finishes creating the edge and makes an FigEdge and sends it to the back of the Layer. The argument "edgeClass" determines the type if edge to suggest that the Editor's GraphModel construct. The GraphModel is responsible for acutally making an edge in the underlying model and connecting it to other model elements.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.tigris.gef.base.ModeCreate
_defaultHeight, _defaultWidth, _newItem, anchorX, anchorY
 
Fields inherited from class org.tigris.gef.base.FigModifyingModeImpl
editor
 
Fields inherited from class org.tigris.gef.base.ModeImpl
_args
 
Constructor Summary
ModeCreateEdgeAndNode()
          The constructor.
ModeCreateEdgeAndNode(Editor ed, java.lang.Object edgeType, java.lang.Object nodeType, boolean post)
          The constructor.
 
Method Summary
 org.tigris.gef.presentation.Fig createNewItem(java.awt.event.MouseEvent me, int snapX, int snapY)
          Create the new item that will be drawn.
 void done()
          When a Mode handles a certain event that indicates that the user wants to exit that Mode (e.g., a mouse up event after a drag in ModeCreateEdge) the Mode calls done to make switching to another Mode possible.
 java.lang.String instructions()
          Reply a string of instructions that should be shown in the statusbar when this mode starts.
 void keyTyped(java.awt.event.KeyEvent ke)
           
 void mouseDragged(java.awt.event.MouseEvent me)
          On mouse drag, resize the new item as the user moves the mouse.
 void mouseMoved(java.awt.event.MouseEvent me)
           
 void mousePressed(java.awt.event.MouseEvent me)
          On mousePressed determine what port the user is dragging from.
 void mouseReleased(java.awt.event.MouseEvent me)
          On mouseReleased, find the destination port, ask the GraphModel to connect the two ports.
protected  void postProcessEdge()
           
 void setup(org.tigris.gef.presentation.FigNode fignode, java.lang.Object port, int x, int y, boolean reverse)
           
 
Methods inherited from class org.tigris.gef.base.ModeCreate
createFig, creationDrag, getInitialCursor, keyPressed, paint
 
Methods inherited from class org.tigris.gef.base.FigModifyingModeImpl
getEditor, isFigEnclosedIn, print, setCursor, setEditor
 
Methods inherited from class org.tigris.gef.base.ModeImpl
canExit, getArg, getArgs, init, keyReleased, leave, mouseClicked, mouseEntered, mouseExited, setArg, setArgs, start
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.tigris.gef.base.Mode
canExit, getArg, getArgs, init, setArg, setArgs, start
 

Constructor Detail

ModeCreateEdgeAndNode

public ModeCreateEdgeAndNode()
The constructor.


ModeCreateEdgeAndNode

public ModeCreateEdgeAndNode(Editor ed,
                             java.lang.Object edgeType,
                             java.lang.Object nodeType,
                             boolean post)
The constructor.

Parameters:
ed - the parent editor of this mode. Each Mode instance belongs to exactly one Editor instance.
edgeType - the class of the edge
nodeType - the class of the node
post - if true, then the edge is postprocessed. See postProcessEdge().
Method Detail

setup

public void setup(org.tigris.gef.presentation.FigNode fignode,
                  java.lang.Object port,
                  int x,
                  int y,
                  boolean reverse)
Parameters:
fignode - the source fignode
port - the port
x - the x to start from
y - the y to start from
reverse - true if the direction is reversed, i.e. from destination to source

instructions

public java.lang.String instructions()
Description copied from class: FigModifyingModeImpl
Reply a string of instructions that should be shown in the statusbar when this mode starts.

Specified by:
instructions in interface FigModifyingMode
Overrides:
instructions in class FigModifyingModeImpl
See Also:
FigModifyingMode.instructions()

createNewItem

public org.tigris.gef.presentation.Fig createNewItem(java.awt.event.MouseEvent me,
                                                     int snapX,
                                                     int snapY)
Create the new item that will be drawn. In this case I would rather create the FigEdge when I am done. Here I just create a rubberband FigLine to show during dragging.

Specified by:
createNewItem in class ModeCreate
See Also:
ModeCreate.createNewItem( java.awt.event.MouseEvent, int, int)

done

public void done()
Description copied from class: ModeImpl
When a Mode handles a certain event that indicates that the user wants to exit that Mode (e.g., a mouse up event after a drag in ModeCreateEdge) the Mode calls done to make switching to another Mode possible.

Specified by:
done in interface Mode
Overrides:
done in class FigModifyingModeImpl
See Also:
Mode.done()

mousePressed

public void mousePressed(java.awt.event.MouseEvent me)
On mousePressed determine what port the user is dragging from. The mousePressed event is sent via ModeSelect.

Specified by:
mousePressed in interface java.awt.event.MouseListener
Overrides:
mousePressed in class ModeCreate
See Also:
MouseListener.mousePressed(java.awt.event.MouseEvent)

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent me)
On mouseReleased, find the destination port, ask the GraphModel to connect the two ports. If that connection is allowed, then construct a new FigEdge and add it to the Layer and send it to the back.

Specified by:
mouseReleased in interface java.awt.event.MouseListener
Overrides:
mouseReleased in class ModeCreate
See Also:
MouseListener.mouseReleased(java.awt.event.MouseEvent)

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent me)
Specified by:
mouseMoved in interface java.awt.event.MouseMotionListener
Overrides:
mouseMoved in class ModeImpl
See Also:
MouseMotionListener.mouseMoved(java.awt.event.MouseEvent)

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent me)
Description copied from class: ModeCreate
On mouse drag, resize the new item as the user moves the mouse. Maybe the Fig createDrag() method should be removed and I should call dragHandle(). That would elimiate one method from each oif several classes, but dragging during creation is not really the same thing as dragging after creation....

Note: _newItem has not been added to any Layer yet. So you cannot use _newItem.damage(), instead use editor.damageAll(_newItem).

Specified by:
mouseDragged in interface java.awt.event.MouseMotionListener
Overrides:
mouseDragged in class ModeCreate
See Also:
MouseMotionListener.mouseDragged(java.awt.event.MouseEvent)

keyTyped

public void keyTyped(java.awt.event.KeyEvent ke)
Specified by:
keyTyped in interface java.awt.event.KeyListener
Overrides:
keyTyped in class ModeImpl
See Also:
KeyListener.keyTyped(java.awt.event.KeyEvent)

postProcessEdge

protected void postProcessEdge()