com.smartgwt.client.widgets.drawing
Class DrawLinePath

java.lang.Object
  com.smartgwt.client.core.BaseClass
      com.smartgwt.client.widgets.drawing.DrawItem
          com.smartgwt.client.widgets.drawing.DrawPath
              com.smartgwt.client.widgets.drawing.DrawLinePath

All Implemented Interfaces:

HasHandlers, HasClickHandlers, HasDragMoveHandlers, HasDragStartHandlers, HasDragStopHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseUpHandlers, HasMovedHandlers, HasResizedHandlers, HasShowContextMenuHandlers

public class DrawLinePath
extends DrawPath

DrawItem subclass to render a connector between two points. If the points are aligned on one axis, this connector will draw as a straight line. If the points are offset on both axes and there is enough space, the connector will draw short horizontal segments from the start and end points, and a diagonal segment connecting the ends of these 'margin' segments.

Field Summary

Fields inherited from class com.smartgwt.client.core.BaseClass

config, id, scClassName

Constructor Summary

DrawLinePath()

DrawLinePath(JavaScriptObject jsObj)

Method Summary

JavaScriptObject	create()
ArrowStyle	getEndArrow() Style of arrowhead to draw at the end of the line or path.
int	getEndLeft() Ending left coordinate of the line.
Point	getEndPoint() End point of the line
int	getEndTop() Ending top coordinate of the line.
static DrawLinePath	getOrCreateRef(JavaScriptObject jsObj)
int	getStartLeft() Starting left coordinate of the line.
Point	getStartPoint() Start point of the line
int	getStartTop() Starting top coordinate of the line.
int	getTailSize() Length of the horizontal "tail" between the start and end points of this LinePath and the diagonal connecting segment
void	moveBy(int left, int top) Move both the start and end points of the line by a relative amount.
void	setEndArrow(ArrowStyle endArrow) Style of arrowhead to draw at the end of the line or path.
void	setEndLeft(int endLeft) Ending left coordinate of the line.
void	setEndPoint(Point endPoint) End point of the line If this method is called after the component has been drawn/initialized: Update the endPoint
void	setEndTop(int endTop) Ending top coordinate of the line.
void	setJavaScriptObject(JavaScriptObject jsObj)
void	setStartLeft(int startLeft) Starting left coordinate of the line.
void	setStartPoint(Point startPoint) Start point of the line If this method is called after the component has been drawn/initialized: Update the startPoint
void	setStartTop(int startTop) Starting top coordinate of the line.
void	setTailSize(int tailSize) Length of the horizontal "tail" between the start and end points of this LinePath and the diagonal connecting segment

Methods inherited from class com.smartgwt.client.widgets.drawing.DrawPath

getPoints, moveTo, setPoints

Methods inherited from class com.smartgwt.client.widgets.drawing.DrawItem

addClickHandler, addDragMoveHandler, addDragStartHandler, addDragStopHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMovedHandler, addResizedHandler, addShowContextMenuHandler, computeAngle, convertToDrawItemArray, destroy, draw, erase, getAttributeAsIntArray, getBoundingBox, getCanDrag, getCenter, getContextMenu, getDestroyed, getDestroying, getDragStartDistance, getDrawGroup, getDrawPane, getFillColor, getFillGradient, getFillOpacity, getKnobs, getLineCap, getLineColor, getLineOpacity, getLinePattern, getLineWidth, getMoveKnobOffset, getMoveKnobPoint, getPageLeft, getPageTop, getRef, getResizeKnobPoints, getRotation, getScale, getShadow, getStartArrow, getSvgString, hide, hideKnobs, isInBounds, isPointInPath, resizeBy, resizeTo, rotateBy, rotateTo, scaleBy, scaleTo, setCanDrag, setContextMenu, setDragStartDistance, setDrawGroup, setDrawPane, setFillColor, setFillGradient, setFillOpacity, setKnobs, setLineCap, setLineColor, setLineOpacity, setLinePattern, setLineWidth, setMoveKnobOffset, setMoveKnobPoint, setResizeKnobPoints, setRotation, setScale, setShadow, setStartArrow, show, showKnobs

Methods inherited from class com.smartgwt.client.core.BaseClass

doAddHandler, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getHandlerCount, getID, getJsObj, getOrCreateJsObj, getScClassName, isCreated, onInit, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setID, setProperty, setProperty, setProperty, setProperty, setScClassName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

DrawLinePath

public DrawLinePath()

DrawLinePath

public DrawLinePath(JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static DrawLinePath getOrCreateRef(JavaScriptObject jsObj)

setJavaScriptObject

public void setJavaScriptObject(JavaScriptObject jsObj)

Overrides:

setJavaScriptObject in class DrawPath

create

public JavaScriptObject create()

Overrides:

create in class DrawPath

setEndArrow

public void setEndArrow(ArrowStyle endArrow)

Style of arrowhead to draw at the end of the line or path.

Overrides:

setEndArrow in class DrawItem

Parameters:

endArrow - endArrow Default value is "open", IRW

getEndArrow

public ArrowStyle getEndArrow()

Style of arrowhead to draw at the end of the line or path.

Overrides:

getEndArrow in class DrawItem

Returns:

ArrowStyle

setEndLeft

public void setEndLeft(int endLeft)
                throws IllegalStateException

Ending left coordinate of the line. Overrides left coordinate of endPoint if both are set.

Parameters:

endLeft - endLeft Default value is 0 , IRW

Throws:

IllegalStateException - this property cannot be changed after the underlying component has been created

getEndLeft

public int getEndLeft()

Ending left coordinate of the line. Overrides left coordinate of endPoint if both are set.

Returns:

int

setEndPoint

public void setEndPoint(Point endPoint)

End point of the line

If this method is called after the component has been drawn/initialized: Update the endPoint

Parameters:

endPoint - left coordinate for end point, in pixels. Default value is [100,100]

getEndPoint

public Point getEndPoint()

End point of the line

Returns:

Point

setEndTop

public void setEndTop(int endTop)
               throws IllegalStateException

Ending top coordinate of the line. Overrides top coordinate of endPoint if both are set.

Parameters:

endTop - endTop Default value is 0 , IRW

Throws:

IllegalStateException - this property cannot be changed after the underlying component has been created

getEndTop

public int getEndTop()

Ending top coordinate of the line. Overrides top coordinate of endPoint if both are set.

Returns:

int

setStartLeft

public void setStartLeft(int startLeft)
                  throws IllegalStateException

Starting left coordinate of the line. Overrides left coordinate of startPoint if both are set.

Parameters:

startLeft - startLeft Default value is 0 , IRW

Throws:

IllegalStateException - this property cannot be changed after the underlying component has been created

getStartLeft

public int getStartLeft()

Starting left coordinate of the line. Overrides left coordinate of startPoint if both are set.

Returns:

int

setStartPoint

public void setStartPoint(Point startPoint)

Start point of the line

If this method is called after the component has been drawn/initialized: Update the startPoint

Parameters:

startPoint - left coordinate for start point, in pixels. Default value is [0,0]

getStartPoint

public Point getStartPoint()

Start point of the line

Returns:

Point

setStartTop

public void setStartTop(int startTop)
                 throws IllegalStateException

Starting top coordinate of the line. Overrides top coordinate of startPoint if both are set.

Parameters:

startTop - startTop Default value is 0 , IRW

Throws:

IllegalStateException - this property cannot be changed after the underlying component has been created

getStartTop

public int getStartTop()

Starting top coordinate of the line. Overrides top coordinate of startPoint if both are set.

Returns:

int

setTailSize

public void setTailSize(int tailSize)
                 throws IllegalStateException

Length of the horizontal "tail" between the start and end points of this LinePath and the diagonal connecting segment

Parameters:

tailSize - tailSize Default value is 30

Throws:

IllegalStateException - this property cannot be changed after the underlying component has been created

getTailSize

public int getTailSize()

Length of the horizontal "tail" between the start and end points of this LinePath and the diagonal connecting segment

Returns:

int

moveBy

public void moveBy(int left,
                   int top)

Move both the start and end points of the line by a relative amount.

Overrides:

moveBy in class DrawPath

Parameters:

left - change to left coordinate in pixels

top - change to top coordinate in pixels