com.jfimagine.jfgraph.shape.arc
Class AbstractArc

java.lang.Object
  |
  +--com.jfimagine.jfgraph.shape.base.AbstractObject
        |
        +--com.jfimagine.jfgraph.shape.base.AbstractShape
              |
              +--com.jfimagine.jfgraph.shape.arc.AbstractArc

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

JFArc, JFChord, JFPie

public abstract class AbstractArc

extends AbstractShape

AbstractArc class. An arc is part or whole of the curve of a circle.

Version:

$Revision: 1.1 $

Author:

CookieMaker

Field Summary

protected java.awt.geom.Arc2D.Double	doubleArc Because of Graphics.drawArc cannot be applied a double angle, so we use an Arc2D object for drawing double angle arcs.
protected Arc	m_arc arc object for an AbstractArc
protected Arrow	m_arrow arrow format of current line.
protected FillFormat	m_fillFormat fill format of current fill.
protected JFPoint	m_firstNode first node settled while drawing.
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_ARCTYPE A XML string tag represents the type of this arc
static java.lang.String	XML_CONTROLPOINTX A XML string tag represents the controlPoint x coordinate offset of this arc
static java.lang.String	XML_CONTROLPOINTY A XML string tag represents the controlPoint y coordinate offset of this arc
static java.lang.String	XML_ENDPOINTX A XML string tag represents the endPoint x coordinate offset of this arc
static java.lang.String	XML_ENDPOINTY A XML string tag represents the endPoint y coordinate offset of this arc
static java.lang.String	XML_STARTPOINTX A XML string tag represents the startPoint x coordinate offset of this arc
static java.lang.String	XML_STARTPOINTY A XML string tag represents the startPoint y coordinate offset of this arc

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

AbstractArc()
Constructor for AbstractArc

Method Summary

void	addNode(double x, double y) Add a new node for current node list.
Port	addPort(double x, double y) Add a new port to this shape.
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.
void	draw(java.awt.Graphics g, boolean isXorMode) Draw current object on graphic canvas.
void	drawArc(java.awt.Graphics g, boolean isXorMode) Draw an arc on canvas, by specified line format.
protected void	drawArrow(java.awt.Graphics g) Draw current object's arrows.
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	finishMoveNode(Node node, double x, double y, java.awt.Graphics g) finish move/adjust a node of current object.
void	flipBy() Reverse this rectangle by a central y coordinate of this rectangle.
void	flipBy(double baseY) Reverse this rectangle by a y coordinate.
double	getAngle() Get the angle of this arc.
protected java.awt.geom.GeneralPath	getArcPath() Get a general path for drawing this arc.
int	getArcType() Get arc type of this arc.
Arrow	getArrow() Get the arrow format of current object.
Rect	getBounds() Get the bounds of this arc.
JFPoint	getCenterPoint() Get center point of this arc.
JFPoint	getControlPoint() Get control point of this arc.
JFPoint	getEndPoint() Get end point of this arc.
FillFormat	getFillFormat() Get the fill format of current line.
LineFormat	getLineFormat() Get the line format of current arc.
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	getRadius() get radius of current arc.
JFPoint	getStartPoint() Get start point of this arc.
int	hashCode() Returns the hashcode for this Object.
boolean	ifCompleteDrawing() If an arc has been drew.
protected void	initNodes() Init all nodes of this arc.
protected void	initPorts() Init all ports of this shape.
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 rectangle by a central x coordinate of this rectangle.
void	mirrorBy(double baseX) Mirror this rectangle 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	removeLastNode() Remove last node added by addNode method.
void	rotateBy(double theta) Rotate this rectangle 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	setArc(AbstractArc arc) Set the value of current arc.
void	setArc(Arc arc) Set the value of current arc.
void	setArc(JFPoint startPoint, JFPoint endPoint) Set value of current Arc.
void	setArc(JFPoint center, JFPoint startPoint, double angle) Set value of current Arc.
void	setArrow(Arrow arrow) Set the arrow format of current object.
void	setFillFormat(FillFormat fillFormat) Set the fill format of current line.
void	setLineFormat(LineFormat lineFormat) Set the line format of current arc.
void	startMoveNode(Node node) Start move a node.
java.lang.String	toString() Convert this object to String

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

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

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

cloneMe, 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_STARTPOINTX

public static final java.lang.String XML_STARTPOINTX

A XML string tag represents the startPoint x coordinate offset of this arc

See Also:

Constant Field Values

XML_STARTPOINTY

public static final java.lang.String XML_STARTPOINTY

A XML string tag represents the startPoint y coordinate offset of this arc

See Also:

Constant Field Values

XML_ENDPOINTX

public static final java.lang.String XML_ENDPOINTX

A XML string tag represents the endPoint x coordinate offset of this arc

See Also:

Constant Field Values

XML_ENDPOINTY

public static final java.lang.String XML_ENDPOINTY

A XML string tag represents the endPoint y coordinate offset of this arc

See Also:

Constant Field Values

XML_CONTROLPOINTX

public static final java.lang.String XML_CONTROLPOINTX

A XML string tag represents the controlPoint x coordinate offset of this arc

See Also:

Constant Field Values

XML_CONTROLPOINTY

public static final java.lang.String XML_CONTROLPOINTY

A XML string tag represents the controlPoint y coordinate offset of this arc

See Also:

Constant Field Values

XML_ARCTYPE

public static final java.lang.String XML_ARCTYPE

A XML string tag represents the type of this arc

See Also:

Constant Field Values

m_arc

protected Arc m_arc

arc object for an AbstractArc

m_arrow

protected Arrow m_arrow

arrow format of current line.

m_fillFormat

protected FillFormat m_fillFormat

fill format of current fill.

m_lineFormat

protected LineFormat m_lineFormat

line format of current line.

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.

doubleArc

protected java.awt.geom.Arc2D.Double doubleArc

Because of Graphics.drawArc cannot be applied a double angle, so we use an Arc2D object for drawing double angle arcs.

Constructor Detail

AbstractArc

public AbstractArc()

Constructor for AbstractArc

Method Detail

getStartPoint

public JFPoint getStartPoint()

Get start point of this arc.

Returns:

the start point.

getEndPoint

public JFPoint getEndPoint()

Get end point of this arc.

Returns:

the end point.

getControlPoint

public JFPoint getControlPoint()

Get control point of this arc.

Returns:

the control point.

getCenterPoint

public JFPoint getCenterPoint()

Get center point of this arc.

Returns:

the center point.

getAngle

public double getAngle()

Get the angle of this arc.

Returns:

the angle.

getRadius

public double getRadius()

get radius of current arc.

Returns:

the radius.

getArcType

public int getArcType()

Get arc type of this arc. OPEN,CHORD or PIE.

Returns:

The arc type.

getBounds

public Rect getBounds()

Get the bounds of this arc.

Overrides:

getBounds in class AbstractShape

Returns:

The bounds rectangle of current arc.

setArc

public void setArc(AbstractArc arc)

Set the value of current arc.

Parameters:

arc - A new AbstractArc object.

setArc

public void setArc(Arc arc)

Set the value of current arc.

Parameters:

arc - A new arc.

setArc

public void setArc(JFPoint center,
                   JFPoint startPoint,
                   double angle)

Set value of current Arc. Attention: The distance from startPoint to center must equal to the distance from endPoint to center. Otherwise we will make a correction for the difference.

Parameters:

center - The center point of this arc.

startPoint - The start point of this arc.

angle - The angle of this arc.

setArc

public void setArc(JFPoint startPoint,
                   JFPoint endPoint)

Set value of current Arc. We decide an arc by a startpoint and an endpoint. This method is always used while drawing an arc when two end points are decided.

Parameters:

startPoint - The start point of this arc.

endPoint - The end point of this arc.

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.

getFillFormat

public FillFormat getFillFormat()

Get the fill format of current line.

Overrides:

getFillFormat in class AbstractShape

Returns:

The fill format.

setFillFormat

public void setFillFormat(FillFormat fillFormat)

Set the fill format of current line.

Overrides:

setFillFormat in class AbstractShape

Parameters:

fillFormat - A new fill format.

getLineFormat

public LineFormat getLineFormat()

Get the line format of current arc.

Overrides:

getLineFormat in class AbstractShape

Returns:

The line format.

setLineFormat

public void setLineFormat(LineFormat lineFormat)

Set the line format of current arc.

Overrides:

setLineFormat in class AbstractShape

Parameters:

lineFormat - A new line format.

initNodes

protected void initNodes()

Init all nodes of this arc. We will always consider that an arc object has three nodes: startpoint,endpoint and controlpoint. node1 as start point, node2 as end point, node3 as control point

initPorts

protected void initPorts()

Init all ports of this shape. An object will always has its one or more stable ports and some customized ports,

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 an arc 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

drawArrow

protected void drawArrow(java.awt.Graphics g)

Draw current object's arrows.

getArcPath

protected java.awt.geom.GeneralPath getArcPath()

Get a general path for drawing this arc.

Returns:

the path.

drawArc

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

Draw an arc on canvas, by specified line format.

Parameters:

g - A graphic canvas.

isXorMode - If is in xor mode now.

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.

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.

addPort

public Port addPort(double x,
                    double y)

Add a new port to this shape.

Overrides:

addPort in class AbstractShape

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.

startMoveNode

public void startMoveNode(Node node)

Start move a node.

Overrides:

startMoveNode in class AbstractShape

Parameters:

node - The node will be moved.

finishMoveNode

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

finish move/adjust a node of current object.

Overrides:

finishMoveNode in class AbstractShape

Parameters:

node - Currently moving node.

g - current drawing canvas.

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 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.

rotateBy

public void rotateBy(double theta)

Rotate this rectangle by an angle theta.

Specified by:

rotateBy in class AbstractShape

Parameters:

theta - A rotate angle.

mirrorBy

public void mirrorBy()

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

Specified by:

mirrorBy in class AbstractShape

mirrorBy

public void mirrorBy(double baseX)

Mirror this rectangle 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 rectangle by a central y coordinate of this rectangle. We make a up-down flip here.

Specified by:

flipBy in class AbstractShape

flipBy

public void flipBy(double baseY)

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

Specified by:

flipBy in class AbstractShape

Parameters:

baseY - A flip base y coordinate.

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

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