com.bbn.openmap.omGraphics
Class EditableOMLine

java.lang.Object
  extended by com.bbn.openmap.event.MapMouseAdapter
      extended by com.bbn.openmap.omGraphics.EditableOMGraphic
          extended by com.bbn.openmap.omGraphics.EditableOMAbstractLine
              extended by com.bbn.openmap.omGraphics.EditableOMLine
All Implemented Interfaces:
MapMouseListener, NonRegional

public class EditableOMLine
extends EditableOMAbstractLine
implements NonRegional

The EditableOMLine encompasses an OMLine, providing methods for modifying or creating it.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.bbn.openmap.omGraphics.EditableOMGraphic
EditableOMGraphic.OMGraphicUndoEvent
 
Field Summary
static int ENDING_POINT_INDEX
           
protected  GrabPoint gp1
           
protected  GrabPoint gp2
           
protected  OffsetGrabPoint gpm
           
protected  OffsetGrabPoint gpo
           
protected  OMLine line
           
static int OFFSET_POINT_INDEX
           
static int STARTING_POINT_INDEX
           
 
Fields inherited from class com.bbn.openmap.omGraphics.EditableOMAbstractLine
arrowheadMenu
 
Fields inherited from class com.bbn.openmap.omGraphics.EditableOMGraphic
actionMask, canGrabGraphic, DEBUG, DEBUG_DETAIL, gPoints, GRAB_POINT_DRAWING_ATTRIBUTES_ATTRIBUTE, holder, i18n, lastMouseEvent, listeners, mouseModeServiceList, movingPoint, popupIsUp, projection, SELECTED_GRAB_POINT_DRAWING_ATTRIBUTES_ATTRIBUTE, showGUI, stateMachine, undoStack, xorRendering
 
Constructor Summary
EditableOMLine()
          Create the EditableOMLine, setting the state machine to create the line off of the gestures.
EditableOMLine(GraphicAttributes ga)
          Create an EditableOMLine with the lineType and renderType parameters in the GraphicAttributes object.
EditableOMLine(OMLine oml)
          Create the EditableOMLine with an OMLine already defined, ready for editing.
 
Method Summary
 void assertGrabPoints()
          Check to make sure the grab points are not null.
 void attachToMovingGrabPoint(OffsetGrabPoint gp)
          Attach to the Moving OffsetGrabPoint so if it moves, it will move this EditableOMGraphic with it.
 void createGraphic(GraphicAttributes ga)
          Create and set the graphic within the state machine.
 void detachFromMovingGrabPoint(OffsetGrabPoint gp)
          Detach from a Moving OffsetGrabPoint.
 boolean generate(Projection proj)
          Use the current projection to place the graphics on the screen.
 OMGraphic getGraphic()
          Get the OMGraphic being created/modified by the EditableOMLine.
 void init()
          Create and initialize the state machine that interprets the modifying gestures/commands, as well as initialize the grab points.
 void move(java.awt.event.MouseEvent e)
          Called to set the OffsetGrabPoint to the current mouse location, and update the OffsetGrabPoint with all the other GrabPoint locations, so everything can shift smoothly.
 void regenerate(Projection proj)
          Given a new projection, the grab points may need to be repositioned off the current position of the graphic.
 void render(java.awt.Graphics graphics)
          Draw the EditableOMLine parts into the java.awt.Graphics object.
 void setGrabPoints()
          Take the current location of the GrabPoints, and modify the location parameters of the OMLine with them.
 void setGrabPoints(OMGraphic graphic)
          Set the grab points for the graphic provided, setting them on the extents of the graphic.
 void setGraphic(OMGraphic graphic)
          Set the graphic within the state machine.
 void setMovingPoint(GrabPoint gp)
          Set the GrabPoint that is in the middle of being modified, as a result of a mouseDragged event, or other selection process.
 
Methods inherited from class com.bbn.openmap.omGraphics.EditableOMAbstractLine
createArrowIcon, getArrowHeadMenu, getGUI
 
Methods inherited from class com.bbn.openmap.omGraphics.EditableOMGraphic
_getMovingPoint, addEOMGListener, cleanMap, createAttributePanel, createUndoEventForCurrentState, finalize, fireEvent, fireEvent, fireEvent, fireEvent, getActionMask, getCanGrabGraphic, getGrabPoint, getGrabPoints, getGUI, getMouseModeServiceList, getMovingPoint, getMovingPoint, getProjection, getProjectionPoint, getShowGUI, getStateMachine, getUndoStack, handleInitialMouseEvent, isMouseEventTouching, isMouseEventTouchingTheEdge, isPopupIsUp, isXorRendering, modifyOMGraphicForEditRender, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mouseMoved, mousePressed, mouseReleased, redraw, redraw, redraw, removeEOMGListener, repaint, repaintRender, reset, resetOMGraphicAfterEditRender, setActionMask, setCanGrabGraphic, setGrabPoint, setGrabPoints, setMouseModeServiceList, setPopupIsUp, setProjection, setShowGUI, setStateMachine, setUndoStack, setXorRendering, updateCurrentState
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

gp1

protected GrabPoint gp1

gp2

protected GrabPoint gp2

gpo

protected OffsetGrabPoint gpo

gpm

protected OffsetGrabPoint gpm

line

protected OMLine line

STARTING_POINT_INDEX

public static final int STARTING_POINT_INDEX
See Also:
Constant Field Values

ENDING_POINT_INDEX

public static final int ENDING_POINT_INDEX
See Also:
Constant Field Values

OFFSET_POINT_INDEX

public static final int OFFSET_POINT_INDEX
See Also:
Constant Field Values
Constructor Detail

EditableOMLine

public EditableOMLine()
Create the EditableOMLine, setting the state machine to create the line off of the gestures.


EditableOMLine

public EditableOMLine(GraphicAttributes ga)
Create an EditableOMLine with the lineType and renderType parameters in the GraphicAttributes object.


EditableOMLine

public EditableOMLine(OMLine oml)
Create the EditableOMLine with an OMLine already defined, ready for editing.

Parameters:
oml - OMLine that should be edited.
Method Detail

init

public void init()
Create and initialize the state machine that interprets the modifying gestures/commands, as well as initialize the grab points. Also allocates the grab point array needed by the EditableOMLine.


setGraphic

public void setGraphic(OMGraphic graphic)
Set the graphic within the state machine. If the graphic is null, then one shall be created, and located off screen until the gestures driving the state machine place it on the map.

Specified by:
setGraphic in class EditableOMGraphic
Parameters:
graphic - OMGraphic.

createGraphic

public void createGraphic(GraphicAttributes ga)
Create and set the graphic within the state machine. The GraphicAttributes describe the type of line to create.

Specified by:
createGraphic in class EditableOMGraphic
Parameters:
ga - GraphicAttributes, describing the graphic to be created.

getGraphic

public OMGraphic getGraphic()
Get the OMGraphic being created/modified by the EditableOMLine.

Specified by:
getGraphic in class EditableOMGraphic

setMovingPoint

public void setMovingPoint(GrabPoint gp)
Set the GrabPoint that is in the middle of being modified, as a result of a mouseDragged event, or other selection process.

Overrides:
setMovingPoint in class EditableOMGraphic

attachToMovingGrabPoint

public void attachToMovingGrabPoint(OffsetGrabPoint gp)
Attach to the Moving OffsetGrabPoint so if it moves, it will move this EditableOMGraphic with it. EditableOMGraphic version doesn't do anything, each subclass has to decide which of its OffsetGrabPoints should be attached to it.

Overrides:
attachToMovingGrabPoint in class EditableOMGraphic

detachFromMovingGrabPoint

public void detachFromMovingGrabPoint(OffsetGrabPoint gp)
Detach from a Moving OffsetGrabPoint. The EditableOMGraphic version doesn't do anything, each subclass should remove whatever GrabPoint it would have attached to an OffsetGrabPoint.

Overrides:
detachFromMovingGrabPoint in class EditableOMGraphic

assertGrabPoints

public void assertGrabPoints()
Check to make sure the grab points are not null. If they are, allocate them, and them assign them to the array.


setGrabPoints

public void setGrabPoints(OMGraphic graphic)
Set the grab points for the graphic provided, setting them on the extents of the graphic. Called when you want to set the grab points off the location of the graphic.


setGrabPoints

public void setGrabPoints()
Take the current location of the GrabPoints, and modify the location parameters of the OMLine with them. Called when you want the graphic to change according to the grab points.

Specified by:
setGrabPoints in class EditableOMGraphic

move

public void move(java.awt.event.MouseEvent e)
Called to set the OffsetGrabPoint to the current mouse location, and update the OffsetGrabPoint with all the other GrabPoint locations, so everything can shift smoothly. Should also set the OffsetGrabPoint to the movingPoint. Should be called only once at the beginning of the general movement, in order to set the movingPoint. After that, redraw(e) should just be called, and the movingPoint will make the adjustments to the graphic that are needed.

Specified by:
move in class EditableOMGraphic

generate

public boolean generate(Projection proj)
Use the current projection to place the graphics on the screen. Has to be called to at least assure the graphics that they are ready for rendering. Called when the graphic position changes.

Specified by:
generate in class EditableOMGraphic
Parameters:
proj - com.bbn.openmap.proj.Projection
Returns:
true

regenerate

public void regenerate(Projection proj)
Given a new projection, the grab points may need to be repositioned off the current position of the graphic. Called when the projection changes.

Specified by:
regenerate in class EditableOMGraphic

render

public void render(java.awt.Graphics graphics)
Draw the EditableOMLine parts into the java.awt.Graphics object. The grab points are only rendered if the line machine state is LineSelectedState.LINE_SELECTED.

Specified by:
render in class EditableOMGraphic
Parameters:
graphics - java.awt.Graphics.


Copyright (C) BBNT Solutions LLC; See http://openmap.bbn.com/ for details