|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.nwoods.jgo.JGoObject
com.nwoods.jgo.JGoDrawable
com.nwoods.jgo.JGoStroke
com.nwoods.jgo.JGoLink
com.nwoods.jgo.JGoLabeledLink
JGoLabeledLink is a JGoLink that has optional JGoObject "labels" near the ports and the middle of the link.
By default there are no labels; create and set them. Frequently JGoLinkLabel is used for textual labels, but other JGoObjects can be used as well. You may find you will need to override the label positioning methods, if the default label positions are not to your liking.
Field Summary | |
static int |
ChangedFromLabel
a CHANGED JGoDocumentEvent or JGoViewEvent hint: a text label has changed |
static int |
ChangedGrabChildSelection
a CHANGED JGoDocumentEvent or JGoViewEvent hint: changed whether trying to select a label selects this link instead |
static int |
ChangedMidLabel
a CHANGED JGoDocumentEvent or JGoViewEvent hint: a text label has changed |
static int |
ChangedToLabel
a CHANGED JGoDocumentEvent or JGoViewEvent hint: a text label has changed |
Fields inherited from class com.nwoods.jgo.JGoStroke |
ChangedAddPoint, ChangedAllPoints, ChangedArrowHeads, ChangedArrowLength, ChangedArrowShaftLength, ChangedArrowWidth, ChangedCubic, ChangedHighlight, ChangedModifiedPoint, ChangedRemovePoint, myPoints |
Fields inherited from class com.nwoods.jgo.JGoObject |
Bottom, BottomCenter, BottomLeft, BottomMiddle, BottomRight, Center, CenterLeft, CenterRight, Changed4ResizeHandles, ChangedAutoRescale, ChangedBrush, ChangedDraggable, ChangedDragsNode, ChangedGeometry, ChangedInitializing, ChangedPen, ChangedResizable, ChangedSelectable, ChangedUpdatePartner, ChangedVisible, ChangedZOrder, LastChangedHint, Left, LeftCenter, NoHandle, NoSpot, NumReservedHandles, RepaintAll, Right, RightCenter, SideLeft, SideRight, Top, TopCenter, TopLeft, TopMiddle, TopRight |
Constructor Summary | |
JGoLabeledLink()
Create an unconnected link. |
|
JGoLabeledLink(JGoPort from,
JGoPort to)
Create a link from one port to another. |
Method Summary | |
void |
calculateStroke()
When a link is recalculated, we need to reposition any labels. |
void |
changeValue(JGoDocumentChangedEdit e,
boolean undo)
This method is called by the JGoDocumentChangedEdit.undo and redo methods to actually perform the property value change for a JGoObject. |
void |
copyNewValueForRedo(JGoDocumentChangedEdit e)
This method is called when a JGoDocumentChangedEdit is created for a JGoDocumentEvent.CHANGED event, when a JGoObject has been changed. |
JGoObject |
copyObject(JGoCopyEnvironment env)
Create a copy of the JGoLink, but do not copy or share the links ports. |
JGoObject |
getFromLabel()
Return the label near the source end of the link. |
JGoObject |
getMidLabel()
Return the label near the middle of the link. |
JGoObject |
getToLabel()
Return the label near the destination end of the link. |
boolean |
isGrabChildSelection()
|
void |
layoutMidLabel()
Decide which segment should get the middle label, and call positionMidLabel to perform that positioning. |
protected void |
ownerChange(JGoObjectCollection oldOwner,
JGoObjectCollection newOwner,
JGoObject mainObject)
When a link is "inserted", we need to add any labels to the document (or view). |
protected void |
positionEndLabel(JGoObject lab,
int ax,
int ay,
int bx,
int by,
int cx,
int cy)
Given the two end segment's points, move the label object to an appropriate location near the port. |
void |
positionLabels()
Reposition any existing labels according to the stroke points of this link. |
protected void |
positionMidLabel(JGoObject lab,
int ax,
int ay,
int bx,
int by)
Given the middle line segment's points, move the Mid label object to an appropriate location near the middle of the link. |
void |
setFromLabel(JGoObject lab)
Set the label near the source, the "from" end of the link. |
void |
setGrabChildSelection(boolean bFlag)
|
void |
setMidLabel(JGoObject lab)
Set the label near the middle of the link. |
void |
setToLabel(JGoObject lab)
Set the label near the destination, the "to" end of the link. |
DomNode |
SVGReadObject(DomDoc svgDoc,
JGoDocument jGoDoc,
DomElement svgElement,
DomElement jGoChildElement)
Read this object in from a DomDoc representing a Scalable Vector Graphics (SVG) XML document. |
void |
SVGUpdateReference(java.lang.String attr,
java.lang.Object referencedObject)
This method will be called to fill in object references. |
void |
SVGWriteObject(DomDoc svgDoc,
DomElement jGoElementGroup)
Write this object out to a DomDoc representing a Scalable Vector Graphics (SVG) XML document. |
void |
update(int hint,
int prevInt,
java.lang.Object prevVal)
If this object has changed its relative order in the document or area, change the labels to come right afterwards, i.e., just above it. |
Methods inherited from class com.nwoods.jgo.JGoDrawable |
draw3DRect, draw3DRect, drawEllipse, drawEllipse, drawEllipse, drawLine, drawLine, drawPath, drawPolygon, drawPolygon, drawRect, drawRect, drawRect, drawRoundRect, drawRoundRect, getBrush, getPen, setBrush, setPen, SVGAddPathArgs, SVGReadAttributes, SVGWriteAttributes |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int ChangedFromLabel
public static final int ChangedMidLabel
public static final int ChangedToLabel
public static final int ChangedGrabChildSelection
Constructor Detail |
public JGoLabeledLink()
public JGoLabeledLink(JGoPort from, JGoPort to)
from
- the starting port.to
- the ending port.Method Detail |
public JGoObject copyObject(JGoCopyEnvironment env)
copyObject
in class JGoLink
env
- the environment for the copy operation - keeps track of copied objects.public void setGrabChildSelection(boolean bFlag)
public boolean isGrabChildSelection()
protected void ownerChange(JGoObjectCollection oldOwner, JGoObjectCollection newOwner, JGoObject mainObject)
ownerChange
in class JGoLink
public void calculateStroke()
calculateStroke
in class JGoLink
public void positionLabels()
protected void positionEndLabel(JGoObject lab, int ax, int ay, int bx, int by, int cx, int cy)
If there is only one segment in the link, ax==bx and ay==by.
lab
- the label objectax
- the port link pointay
- the port link pointbx
- the inner point of the end segmentby
- the inner point of the end segmentcx
- the end point of the second line segmentcy
- the end point of the second line segmentpublic void layoutMidLabel()
If there are an odd number of segments in the link's stroke, this calls positionMidLabel with the endpoints of the middle segment. Otherwise with an even number of segments, it uses the longer of the two middle segments.
protected void positionMidLabel(JGoObject lab, int ax, int ay, int bx, int by)
By default this centers the label object in the middle of the middle segment of the link. However for labels that are subclass of JGoText, it places the label a little higher up so that in the case of horizontal links the text does not intersect with the link.
lab
- the Mid label objectax
- the start point of the middle line segmentay
- the start point of the middle line segmentbx
- the end point of the middle line segmentby
- the end point of the middle line segmentpublic void SVGWriteObject(DomDoc svgDoc, DomElement jGoElementGroup)
JGoXMLSaveRestore
This method will be called by com.nwoods.jgo.svg.DefaultDocument.SVGWriteDoc() for every JGoObject contained within a JGoDocument. The following example uses a JGoRectangle to illustrate the format of a generated SVG JGoObject:
<g>
<JGoClass class="com.nwoods.jgo.JGoRectangle"\>
<rect height="75" style="stroke:black;stroke-width:1;fill:rgb(255,0,0);" width="75" x="65" y="71"/>
<JGoClass class="com.nwoods.jgo.JGoDrawable" drawablebrush="jgoid1" drawablepen="jgoid2" embeddedpenbrush="false"/>
<JGoClass class="com.nwoods.jgo.JGoObject" obj_flags="1054"/>
</g>
Note that the entire JGoObject is enclosed in a group (<g>). Each subclass of the JGoObject is described by a <JGoClass> element, starting with the most specific class and moving to the more general. Each <JGoClass> element has a "class" attribute which defines the class name. Each <JGoClass> element may also have several other attributes which uniquely describe that state of that class. Following the <JGoClass> element, each class may also genereate any other elements that are required, including representations of contained objects and standard SVG elements such as the <rect> element shown in the above example. The generation of SVG elements in the output makes it possible for the output to be read by SVG viewers and other SVG aware applications. The information contained in the <JGoClass> elements allows us to accurately save and restore all the information in a particular JGoObject subclass.
If this class contains a reference to another object, call DomDoc.registerReferencingNode() to register that reference. This will cause the element representing the referenced object to be identified with a unique id attribute, and cause the element representing the referring object to have a user defined attribute containing a reference to that id. See DomDoc.registerReferencingNode() for more information.
Typically, an implementation of this method will generate a <JGoClass> element using the DomDoc.createJGoClassElement() method, adding whatever attributes are necessary to describe the class. It will then call its superclass so that the superclass can add its own <JGoClass> element and other information to jGoElementGroup within the DomDoc.
Refer to com.nwoods.jgo.examples.flower.ActivityNode.SVGWriteObject() and com.nwoods.jgo.examples.SimpleNode.SVGWriteObject() for examples using this method.
Refer to the file com.nwoods.jgo.svg\xsvg.dtd for a formal description of JGo extensions to the SVG document type.
SVGWriteObject
in interface JGoXMLSaveRestore
SVGWriteObject
in class JGoLink
public DomNode SVGReadObject(DomDoc svgDoc, JGoDocument jGoDoc, DomElement svgElement, DomElement jGoChildElement)
JGoXMLSaveRestore
This method will be called by com.nwoods.jgo.svg.DefaultDocument.SVGReadDoc() for every <JGoClass> element encountered in a DomDoc. First, an object of the type specified by the class attribute will be created and then the SVGReadObject() method will be called on that newly created object. Refer to SVGWriteObject() for a description of the expected format of the SVG document.
This method may also be called by com.nwoods.jgo.svg.DefaultDocument.SVGReadDoc() when reading any SVG document, including those not generated by JGo and therefore not containing any <JGoClass> elements. In such cases, the DefaultDocument.SVGReadElement() method may be subclassed to examine the SVG element and cause the appropriate JGoObject to be created to represent that element and call SVGReadObject() on that newly created object. By default, standard JGoObjects such as JGoRectangles, JGoStrokes, etc will be created to represent these objects.
If this class contains a reference to another object, call DomDoc.registerReferencingObject() to register that reference. This will cause the JGoObject.SVGUpdateReference() to be called on the referencing object after all the objects have been created, passing in the object befing referenced. See DomDoc.registerReferencingObject() for more information.
Typically, an implementation of this method starts by verifying that the element being read is a <JGoClass> element (which will be true if jGoChildElement is not null). This will always be true unless you have subclassed the DefaultDocument.SVGReadElement() method as described above. It will then read the expected attributes of the <JGoClass> element (as written by SVGReadObject()), call SVGReadObject() on its superclass, and finally return the next element by calling svgElement.getNextSibling().
Refer to com.nwoods.jgo.examples.flower.ActivityNode.SVGReadObject() and com.nwoods.jgo.examples.SimpleNode.SVGReadObject() for examples using this method.
SVGReadObject
in interface JGoXMLSaveRestore
SVGReadObject
in class JGoLink
public void SVGUpdateReference(java.lang.String attr, java.lang.Object referencedObject)
JGoObject
This is called by com.nwoods.jgo.svg.DefaultDocument.SVGReadDoc() after all the objects have been created and if DomDoc.registerReferencingObject() has been previously called by SVGReadObject().
Typically, an implementation of this method will first call the superclass and then fill in the appropriate object reference based on the attr argument.
Refer to com.nwoods.jgo.examples.SimpleNode.SVGWriteObject() for an example using this method.
SVGUpdateReference
in class JGoLink
public JGoObject getFromLabel()
public void setFromLabel(JGoObject lab)
Setting the label will result in a call to positionLabels().
lab
- the new labelpublic JGoObject getMidLabel()
public void setMidLabel(JGoObject lab)
Setting the label will result in a call to positionLabels().
lab
- the new labelpublic JGoObject getToLabel()
public void setToLabel(JGoObject lab)
Setting the label will result in a call to positionLabels().
lab
- the new labelpublic void update(int hint, int prevInt, java.lang.Object prevVal)
update
in class JGoObject
hint
- the flags to be passed through the event to the
listener as the flags to help distinguish the kind of change.prevInt
- a previous value for a changed propertyprevVal
- a previous value for a changed propertypublic void copyNewValueForRedo(JGoDocumentChangedEdit e)
JGoObject
Just as the previous/old value/state information is stored as one or both of an integer and an Object, the new value/state information may be stored as either or both of an integer or an Object.
The responsibility for copying rests with the document event listener rather than the code calling JGoObject.update for efficiency when there is no undo/redo manager.
copyNewValueForRedo
in class JGoLink
public void changeValue(JGoDocumentChangedEdit e, boolean undo)
JGoObject
You will want to override this method to handle changing the additional state of your object subclasses.
changeValue
in class JGoLink
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |