com.jfimagine.jfgraph.shape.line
Class JFLabelLine

java.lang.Object
  |
  +--com.jfimagine.jfgraph.shape.base.AbstractObject
        |
        +--com.jfimagine.jfgraph.shape.base.AbstractShape
              |
              +--com.jfimagine.jfgraph.shape.line.JFLabelLine

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

JFVHLabelLine

public class JFLabelLine

extends AbstractShape

JFLabelLine class. A JFLabelLine class used to represent a line to describe the size of shapes.

Version:

$Revision: 1.1 $

Author:

CookieMaker

Field Summary

protected Arrow	m_arrow arrow format of current line.
protected JFPoint	m_firstNode first node settled while drawing.
protected LabelLine	m_labelLine Internal LabelLine object.
protected LineFormat	m_lineFormat line format of current line.
protected int	m_nodeAdded while drawing rectangle, how many nodes have been decided. called by addnode method.
static java.lang.String	XML_CTRL1DIRECTION A XML string tag represents the ctrl1Direction
static java.lang.String	XML_CTRL1LEN A XML string tag represents length of the line segment from control point1 to start point
static java.lang.String	XML_CTRL2LEN A XML string tag represents length of the line segment from control point2 to start point
static java.lang.String	XML_CTRL3LEN A XML string tag represents length of the line segment from control point3 to end point
static java.lang.String	XML_CTRL4LEN A XML string tag represents length of the line segment from control point4 to end point
static java.lang.String	XML_ENDX A XML string tag represents the x coordinate of end point
static java.lang.String	XML_ENDY A XML string tag represents the y coordinate of end point
static java.lang.String	XML_LABELLINE A XML string tag represents a Line
static java.lang.String	XML_STARTX A XML string tag represents the x coordinate of start point
static java.lang.String	XML_STARTY A XML string tag represents the y coordinate of start point

Fields inherited from class com.jfimagine.jfgraph.shape.base.AbstractShape

m_boundsNodeList, m_fontFormat, m_label, m_nodeList, m_portList, m_propertyList, XML_DISABLEMODIFYINGPROPERTIES, XML_DISABLEMOTION, XML_DISABLESCALING, XML_INVISIBLE, XML_LABEL, XML_SHOWLABEL

Fields inherited from class com.jfimagine.jfgraph.shape.base.AbstractObject

m_lastError, XML_OBJECTID, XML_OBJECTTYPE

Constructor Summary

JFLabelLine()
Constructor for label Line

JFLabelLine(double x1, double y1, double x2, double y2)
Constructor for label Line

Method Summary

void	addNode(double x, double y) Add a new node for current node list.
protected void	appendChildToDOM(Element element, JFVersion version) Append necessary xml child for current element, this method will be called internally by toDOM.
java.lang.Object	clone() Creates a new object of the same class and with the same contents as this object.
protected AbstractObject	cloneMe() Creates a new AbstractObject of the same class and with the same contents as this object.
void	draw(java.awt.Graphics g, boolean isXorMode) Draw current object on graphic canvas.
protected void	drawArrow(java.awt.Graphics g, JFPoint startPoint, JFPoint endPoint) Draw current object's arrows.
void	drawLabel(java.awt.Graphics g) Draw label of current shape.
void	drawPicked(java.awt.Graphics g, boolean ifRotate) Draw picked state of current object on graphic canvas.
boolean	equals(java.lang.Object obj) Determines whether or not two objects are equal.
protected void	extractChildFromDOM(Element element, JFVersion version) Extract needed xml child from current element, this method will be called internally by fromDOM.
boolean	finishDrawing() Finish drawing object.
void	flipBy() Reverse this object by a central y coordinate of this object.
void	flipBy(double baseY) Reverse this object by a y coordinate.
Arrow	getArrow() Get the arrow format of current object.
LineFormat	getLineFormat() Get the line format of current line.
JFPoint	getMoveNodePos(Node node, JFPoint movePos, int moveCase) When moving a node, in some cases, e.g. ctrl key or shift key pressed to force preserving the form of a shape, or force equilateral shapes, we need to recalculate the actual moving node's position.
double	getRotateAngle() Get the rotate angle of current label line.
int	hashCode() Returns the hashcode for this Object.
boolean	ifCompleteDrawing() If a label line has been drew.
protected void	initLabel() Set the intial position of this internal label.
boolean	intersects(JFPoint pnt) Test if current object intersects with a specified point.
boolean	intersects(Rect rect) Test if current object intersects with a specified rectangle.
void	loadFromStream(JFReader stream, boolean skipHead, JFVersion version) Load object data from a binary stream
void	mirrorBy() Mirror this object by a central x coordinate of this object.
void	mirrorBy(double baseX) Mirror this object by a x coordinate.
void	moveBy(double x, double y) Move current object by an x and y offset.
void	moveNode(Node node, double x, double y, java.awt.Graphics g) Move/adjust a node of current object.
Node	nodeIntersects(JFPoint pnt, int usage) Get which node of current shape that intersects with point pnt.
Node	removeLastNode() Remove last node added by addNode method.
void	rotateBy(double theta) Rotate this object by an angle theta.
void	rotateBy(double baseX, double baseY, double theta) Rotate current object by a specified point and an angle theta.
void	saveToStream(JFWriter stream, JFVersion version) Save this object to a binary stream
void	scaleBy(JFPoint basePoint, double xScale, double yScale) Scale current object by a specified x and y scale.
void	scaleBy(JFPoint basePoint, JFPoint refPoint1, JFPoint refPoint2, double scale) Scale current object by specified points and scale percent.
void	setArrow(Arrow arrow) Set the arrow format of current object.
void	setLineFormat(LineFormat lineFormat) Set the line format of current line.
java.lang.String	toString() Convert this object to String

Methods inherited from class com.jfimagine.jfgraph.shape.base.AbstractShape

addNode, addPort, attachPort, attachRealPort, attachRealPort, clearAccessTimes, detachPort, drawInvisibleBounds, drawLabelPicked, drawPort, fetchSubObjects, finishMoveLabel, finishMoveNode, getAccessTimes, getBounds, getFillFormat, getFontFormat, getLabel, getNodeByIndex, getNodeByObjectId, getNodeCount, getNodeList, getPortByIndex, getPortByObjectId, getPortCount, getPortList, getPropertyByIndex, getPropertyByObjectId, getPropertyCount, getPropertyList, incAccessTimes, initBoundsNodeList, isDisableModifyingProperties, isDisableMotion, isDisableScaling, isInvisible, isOpenShape, isRotatable, labelIntersects, labelIntersects, movePort, moveRelationalPorts, pickPort, portIntersects, removePort, rotateNode, setDisableModifyingProperties, setDisableMotion, setDisableScaling, setFillFormat, setFontFormat, setInvisible, setLabel, setNodeList, setObjectId, setParent, setPortList, setZoomScale, startMoveLabel, startMoveNode, unboundBrokenPorts

Methods inherited from class com.jfimagine.jfgraph.shape.base.AbstractObject

fromDOM, getLastError, getMaxObjectId, getObjectId, getObjectType, getXMLTag, getZoomScale, isShowDesign, setLastError, setObjectType, setShowDesign, setValue, setXMLTag, toDOM

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

XML_LABELLINE

public static final java.lang.String XML_LABELLINE

A XML string tag represents a Line

See Also:

Constant Field Values

XML_STARTX

public static final java.lang.String XML_STARTX

A XML string tag represents the x coordinate of start point

See Also:

Constant Field Values

XML_STARTY

public static final java.lang.String XML_STARTY

A XML string tag represents the y coordinate of start point

See Also:

Constant Field Values

XML_ENDX

public static final java.lang.String XML_ENDX

A XML string tag represents the x coordinate of end point

See Also:

Constant Field Values

XML_ENDY

public static final java.lang.String XML_ENDY

A XML string tag represents the y coordinate of end point

See Also:

Constant Field Values

XML_CTRL1DIRECTION

public static final java.lang.String XML_CTRL1DIRECTION

A XML string tag represents the ctrl1Direction

See Also:

Constant Field Values

XML_CTRL1LEN

public static final java.lang.String XML_CTRL1LEN

A XML string tag represents length of the line segment from control point1 to start point

See Also:

Constant Field Values

XML_CTRL2LEN

public static final java.lang.String XML_CTRL2LEN

A XML string tag represents length of the line segment from control point2 to start point

See Also:

Constant Field Values

XML_CTRL3LEN

public static final java.lang.String XML_CTRL3LEN

A XML string tag represents length of the line segment from control point3 to end point

See Also:

Constant Field Values

XML_CTRL4LEN

public static final java.lang.String XML_CTRL4LEN

A XML string tag represents length of the line segment from control point4 to end point

See Also:

Constant Field Values

m_arrow

protected Arrow m_arrow

arrow format of current line.

m_lineFormat

protected LineFormat m_lineFormat

line format of current line.

m_labelLine

protected LabelLine m_labelLine

Internal LabelLine object.

m_firstNode

protected JFPoint m_firstNode

first node settled while drawing.

m_nodeAdded

protected int m_nodeAdded

while drawing rectangle, how many nodes have been decided. called by addnode method.

Constructor Detail

JFLabelLine

public JFLabelLine()

Constructor for label Line

JFLabelLine

public JFLabelLine(double x1,
                   double y1,
                   double x2,
                   double y2)

Constructor for label Line

Method Detail

getArrow

public Arrow getArrow()

Get the arrow format of current object.

Overrides:

getArrow in class AbstractShape

Returns:

The arrow format.

setArrow

public void setArrow(Arrow arrow)

Set the arrow format of current object.

Overrides:

setArrow in class AbstractShape

Parameters:

arrow - A new arrow format object.

getLineFormat

public LineFormat getLineFormat()

Get the line format of current line.

Overrides:

getLineFormat in class AbstractShape

Returns:

The line format.

setLineFormat

public void setLineFormat(LineFormat lineFormat)

Set the line format of current line.

Overrides:

setLineFormat in class AbstractShape

Parameters:

lineFormat - A new line format.

nodeIntersects

public Node nodeIntersects(JFPoint pnt,
                           int usage)

Get which node of current shape that intersects with point pnt.

Overrides:

nodeIntersects in class AbstractShape

Parameters:

pnt - A JFPoint used to test intersection.

usage - Purpose to get a node intersected, e.g. move or rotate.

Returns:

A node of current shape.

drawPicked

public void drawPicked(java.awt.Graphics g,
                       boolean ifRotate)

Draw picked state of current object on graphic canvas.

Overrides:

drawPicked in class AbstractShape

Parameters:

g - A graphic canvas.

ifRotate - If user's operation or other actions force objects to be rotated.

getRotateAngle

public double getRotateAngle()

Get the rotate angle of current label line.

Returns:

The rotate angle.

initLabel

protected void initLabel()

Set the intial position of this internal label.

Overrides:

initLabel in class AbstractShape

drawLabel

public void drawLabel(java.awt.Graphics g)

Draw label of current shape.

Overrides:

drawLabel in class AbstractShape

Parameters:

g - A graphic canvas.

addNode

public void addNode(double x,
                    double y)

Add a new node for current node list. here this method will always be called by DrawState class or any drawing class.

Overrides:

addNode in class AbstractShape

removeLastNode

public Node removeLastNode()

Remove last node added by addNode method.

Overrides:

removeLastNode in class AbstractShape

Returns:

Last node that remained.

ifCompleteDrawing

public boolean ifCompleteDrawing()

If a label line has been drew.

Overrides:

ifCompleteDrawing in class AbstractShape

Returns:

True when complete, false otherwise.

finishDrawing

public boolean finishDrawing()

Finish drawing object.

Overrides:

finishDrawing in class AbstractShape

intersects

public boolean intersects(JFPoint pnt)

Test if current object intersects with a specified point.

Specified by:

intersects in class AbstractShape

Parameters:

pnt - A JFPoint used to test intersection.

intersects

public boolean intersects(Rect rect)

Test if current object intersects with a specified rectangle.

Specified by:

intersects in class AbstractShape

Parameters:

rect - A Rect used to test intersection.

scaleBy

public void scaleBy(JFPoint basePoint,
                    JFPoint refPoint1,
                    JFPoint refPoint2,
                    double scale)

Scale current object by specified points and scale percent. We only support a concurrent width-height scale here, suppose width as the length from basePoint to refPoint1, height as the length from basePoint to refPoint2, and one scale percent acts on both width and height.

Specified by:

scaleBy in class AbstractShape

Parameters:

basePoint - A base point that is unmovable.

refPoint1 - A 'width' reference point.

refPoint2 - A 'height' reference point.

scale - A reference scale percent.

scaleBy

public void scaleBy(JFPoint basePoint,
                    double xScale,
                    double yScale)

Scale current object by a specified x and y scale.
This is a special scale method used to scale a shape in arbitrary x and y scale.
Please see AbstractShape.scaleBy for detailed description.

Specified by:

scaleBy in class AbstractShape

Parameters:

basePoint - A base scale point for scaling reference.

xScale - A scale percentage in x coordinate, default to 1.0

yScale - A scale percentage in y coordinate, default to 1.0

moveBy

public void moveBy(double x,
                   double y)

Move current object by an x and y offset.

Specified by:

moveBy in class AbstractShape

rotateBy

public void rotateBy(double theta)

Rotate this object by an angle theta.

Specified by:

rotateBy in class AbstractShape

Parameters:

theta - A rotate angle.

rotateBy

public void rotateBy(double baseX,
                     double baseY,
                     double theta)

Rotate current object by a specified point and an angle theta.

Specified by:

rotateBy in class AbstractShape

Parameters:

theta - A rotate angle.

mirrorBy

public void mirrorBy()

Mirror this object by a central x coordinate of this object. We make a left-right flip here.

Specified by:

mirrorBy in class AbstractShape

mirrorBy

public void mirrorBy(double baseX)

Mirror this object by a x coordinate. We make a left-right mirror here.

Specified by:

mirrorBy in class AbstractShape

Parameters:

baseX - A mirror base x coordinate.

flipBy

public void flipBy()

Reverse this object by a central y coordinate of this object. We make a up-down flip here.

Specified by:

flipBy in class AbstractShape

flipBy

public void flipBy(double baseY)

Reverse this object by a y coordinate. We make a up-down flip here.

Specified by:

flipBy in class AbstractShape

Parameters:

baseY - A flip base y coordinate.

drawArrow

protected void drawArrow(java.awt.Graphics g,
                         JFPoint startPoint,
                         JFPoint endPoint)

Draw current object's arrows.

draw

public void draw(java.awt.Graphics g,
                 boolean isXorMode)

Draw current object on graphic canvas.

Specified by:

draw in class AbstractShape

Parameters:

g - A graphic canvas.

isXorMode - If is in xor mode now.

getMoveNodePos

public JFPoint getMoveNodePos(Node node,
                              JFPoint movePos,
                              int moveCase)

When moving a node, in some cases, e.g. ctrl key or shift key pressed to force preserving the form of a shape, or force equilateral shapes, we need to recalculate the actual moving node's position.

Overrides:

getMoveNodePos in class AbstractShape

Parameters:

movePos - Desire moving position of a node.

moveCase - Move case of a node, normal, shift key pressed or ctrl key pressed

Returns:

The actual moving position of a node.

moveNode

public void moveNode(Node node,
                     double x,
                     double y,
                     java.awt.Graphics g)

Move/adjust a node of current object.

Overrides:

moveNode in class AbstractShape

Parameters:

node - Currently moving node.

g - current drawing canvas.

toString

public java.lang.String toString()

Convert this object to String

Overrides:

toString in class AbstractShape

Returns:

An string represents the content of the object

cloneMe

protected AbstractObject cloneMe()
                          throws java.lang.CloneNotSupportedException

Creates a new AbstractObject of the same class and with the same contents as this object. This method implements the method defined in AbstractObject.

Specified by:

cloneMe in class AbstractObject

Returns:

A clone of this class.

java.lang.CloneNotSupportedException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates a new object of the same class and with the same contents as this object.

Overrides:

clone in class AbstractShape

Returns:

A clone of this instance.

java.lang.CloneNotSupportedException

hashCode

public int hashCode()

Returns the hashcode for this Object.

Overrides:

hashCode in class AbstractShape

Returns:

hash code for this Point2D.

equals

public boolean equals(java.lang.Object obj)

Determines whether or not two objects are equal.

Overrides:

equals in class AbstractShape

Parameters:

obj - an object to be compared with this object

Returns:

true if the object to be compared is an instance of Port and has the same values; false otherwise.

appendChildToDOM

protected void appendChildToDOM(Element element,
                                JFVersion version)

Append necessary xml child for current element, this method will be called internally by toDOM.

Overrides:

appendChildToDOM in class AbstractShape

Parameters:

element - A XML element to append child xml nodes

version - A file version notification so this object can obey the rules to save data.

extractChildFromDOM

protected void extractChildFromDOM(Element element,
                                   JFVersion version)

Extract needed xml child from current element, this method will be called internally by fromDOM.

Overrides:

extractChildFromDOM in class AbstractShape

Parameters:

element - An element used to extract needed xml child

version - A file version notification so this object can obey the rules to fetch data.

saveToStream

public void saveToStream(JFWriter stream,
                         JFVersion version)
                  throws java.io.IOException

Save this object to a binary stream

Overrides:

saveToStream in class AbstractShape

Parameters:

stream - An binary output stream

version - A file version notification so this object can obey the rules to save data.

Throws:

java.io.IOException

loadFromStream

public void loadFromStream(JFReader stream,
                           boolean skipHead,
                           JFVersion version)
                    throws java.io.IOException

Load object data from a binary stream

Overrides:

loadFromStream in class AbstractShape

Parameters:

stream - An binary input stream

skipHead - Skip head 'TYPE' check, an shape object should always has its own shape-type stored, if this shape-type has already been readed, this loadFromStream should/could not read the type anymore.

version - A file version notification so this object can obey the rules to fetch data.

Throws:

java.io.IOException