Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.nwoods.jgo
Class JGoIconicNode

    java.lang.Object
      com.nwoods.jgo.JGoObject
          com.nwoods.jgo.JGoArea
              com.nwoods.jgo.JGoNode
                  com.nwoods.jgo.JGoIconicNode

All Implemented Interfaces:
  JGoIdentifiablePart, JGoLabeledPart, JGoObjectCollection, JGoObjectSimpleCollection, JGoXMLSaveRestore, java.io.Serializable

public class JGoIconicNode
extends JGoNode

A JGoIconicNode is a JGoNode that has an icon, a label, and one port. The label is a JGoText, positioned initially at the bottom center of the icon. The one port is small and of style StyleHidden, centered on the icon.

See Also:
  Serialized Form

Field Summary
`static int` | `ChangedDraggableLabel` A JGoDocumentEvent.CHANGED subhint: changed whether the Label is draggable by the user
`static int` | `ChangedIcon` A JGoDocumentEvent.CHANGED subhint: replaced the Icon
`static int` | `ChangedLabel` A JGoDocumentEvent.CHANGED subhint: replaced the Label
`static int` | `ChangedLabelOffset` A JGoDocumentEvent.CHANGED subhint: changed the LabelOffset
`static int` | `ChangedPort` A JGoDocumentEvent.CHANGED subhint: replaced the Port

Fields inherited from class com.nwoods.jgo.JGoNode
`ChangedPartID, ChangedToolTipText, ChangedUserObject, PartsLinks, PartsLinksIn, PartsLinksOut, PartsNodes, PartsNodesIn, PartsNodesOut, PartsNotSelf, PartsPorts`

Fields inherited from class com.nwoods.jgo.JGoArea
`ChangedPickableBackground`

Fields inherited from class com.nwoods.jgo.JGoObject
`Bottom, BottomCenter, BottomLeft, BottomMiddle, BottomRight, Center, CenterLeft, CenterRight, Changed4ResizeHandles, ChangedAutoRescale, ChangedBrush, ChangedDraggable, ChangedDragsNode, ChangedGeometry, ChangedGrabChildSelection, 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
`JGoIconicNode()` Create an JGoIconicNode with no parts.
`JGoIconicNode(java.lang.String s)` Create a JGoIconicNode with a port and a label displaying the string S, but with an empty image as the icon.

Method Summary
`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.
`protected void` | `copyChildren(JGoArea newarea, JGoCopyEnvironment env)` The default implementation for copying child objects is to just add a copy of each child to the new area.
`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` | `createIcon(java.lang.String s)` Create and initialize the icon, which is normally an empty JGoImage that is not Selectable or Resizable.
`JGoText` | `createLabel(java.lang.String s)` Create and initialize a text label displaying the given string.
`JGoPort` | `createPort()` Create and initialize the node's port, which is normally not visible and at the middle of the icon.
`JGoObject` | `getIcon()` Return the JGoObject that serves as the icon for this node.
`JGoImage` | `getImage()` For convenience, this casts the Icon as a JGoImage if possible, or else returns null.
`JGoText` | `getLabel()` Return the JGoText object that displays the text string.
`java.awt.Dimension` | `getLabelOffset()` Return the offset of the label relative to the icon.
`java.awt.Point` | `getLocation(java.awt.Point result)` Return the location of this object.
`JGoPort` | `getPort()` Return the JGoPort object for this node.
`java.lang.String` | `getText()` Return the text string associated with this object.
`boolean` | `isDraggableLabel()` True when the user can drag the label around relative to the icon.
`void` | `layoutChildren(JGoObject childchanged)` Keep the parts of a JGoIconicNode positioned relative to each other by setting their locations using some of the standard spots of any JGoObject.
`JGoObject` | `removeObjectAtPos(JGoListPosition pos)` When an object is removed, make sure there are no more references from fields.
`void` | `setDraggableLabel(boolean d)` Change whether the user can drag around the label, thereby changing the LabelOffset interactively.
`void` | `setIcon(JGoObject icon)` Change the icon for this node.
`void` | `setLabel(JGoText lab)` Change the label for this node.
`void` | `setLabelOffset(java.awt.Dimension d)` This just calls setLabelOffset(d.width, d.height)
`void` | `setLabelOffset(int w, int h)` Change the position of the label relative to the icon.
`void` | `setLocation(int x, int y)` Sets the location of this object to the given point.
`void` | `setPort(JGoPort p)` Change the port for this node.
`void` | `setText(java.lang.String s)` Change the Label's text string.
`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.

Methods inherited from class com.nwoods.jgo.JGoNode
`copyObject, findAll, getPartID, getToolTipText, getUserObject, setPartID, setToolTipText, setUserObject`

Methods inherited from class com.nwoods.jgo.JGoArea
`addCollection, addCollection, addObjectAtHead, addObjectAtTail, bringObjectToFront, computeBoundingRect, expandRectByPenWidth, findObject, geometryChange, geometryChangeChild, getFirstObjectPos, getLastObjectPos, getNearestIntersectionPoint, getNextObjectPos, getNextObjectPosAtTop, getNumObjects, getObjectAtPos, getPrevObjectPos, insertObjectAfter, insertObjectBefore, isEmpty, isPickableBackground, moveChildren, paint, pick, pickObject, pickObjects, removeObject, rescaleChildren, sendObjectToBack, setPickableBackground`

Methods inherited from class com.nwoods.jgo.JGoObject
`canView, computeMove, computeResize, copy, copyObjectDelayed, copyOldValueForUndo, copyRect, doMouseClick, doMouseDblClick, doUncapturedMouseMove, findCommonParent, foredate, gainedSelection, getBoundingRect, getDocument, getDraggingObject, getFlags, getHeight, getLayer, getLeft, getLocation, getParent, getParentJGoNode, getParentNode, getPartner, getRectangleSpotLocation, getSize, getSize, getSpotLocation, getSpotLocation, getTop, getTopLeft, getTopLeft, getTopLevelObject, getView, getWidth, growRect, handleMove, handleResize, hideSelectionHandles, is4ResizeHandles, isAutoRescale, isBoundingRectInvalid, isChildOf, isDraggable, isDragsNode, isInitializing, isPointInObj, isResizable, isSelectable, isSkipsUndoManager, isSuspendChildUpdates, isSuspendUpdates, isTopLevel, isUpdatePartner, isVisible, lostSelection, ownerChange, partnerUpdate, redirectSelection, remove, set4ResizeHandles, setAutoRescale, setBoundingRect, setBoundingRect, setBoundingRect, setBoundingRectForce, setBoundingRectForce, setBoundingRectInvalid, setBoundsRect, setDraggable, setDragsNode, setFlags, setHeight, setInitializing, setLeft, setLocation, setLocationOffset, setLocationOffset, setParent, setPartner, setRectangleSpotLocation, setResizable, setSelectable, setSize, setSize, setSizeKeepingLocation, setSkipsUndoManager, setSpotLocation, setSpotLocation, setSpotLocation, setSpotLocationOffset, setSuspendChildUpdates, setSuspendUpdates, setTop, setTopLeft, setTopLeft, setUpdatePartner, setVisible, setWidth, showSelectionHandles, spotOpposite, SVGReadAttributes, SVGWriteAttributes, update, update`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### ChangedLabel

    public static final int ChangedLabel

  A JGoDocumentEvent.CHANGED subhint: replaced the Label

  See Also:
    Constant Field Values

### ChangedIcon

    public static final int ChangedIcon

  A JGoDocumentEvent.CHANGED subhint: replaced the Icon

  See Also:
    Constant Field Values

### ChangedPort

    public static final int ChangedPort

  A JGoDocumentEvent.CHANGED subhint: replaced the Port

  See Also:
    Constant Field Values

### ChangedLabelOffset

    public static final int ChangedLabelOffset

  A JGoDocumentEvent.CHANGED subhint: changed the LabelOffset

  See Also:
    Constant Field Values

### ChangedDraggableLabel

    public static final int ChangedDraggableLabel

  A JGoDocumentEvent.CHANGED subhint: changed whether the Label is draggable by the user

  See Also:
    Constant Field Values

Constructor Detail

### JGoIconicNode

    public JGoIconicNode()

  Create an JGoIconicNode with no parts.

  You will need to initialize this object manually, by setting the Icon, Label, and Port properties, perhaps to the values returned by createIcon, createLabel, and createPort. The Icon image will probably need additional initialization so as to display the desired Image.

### JGoIconicNode

    public JGoIconicNode(java.lang.String s)

  Create a JGoIconicNode with a port and a label displaying the string S, but with an empty image as the icon.

  You will need to call getImage().loadImage(...) with a URL or filename to initialize the image. Or you can replace the JGoImage icon with any other object of your choosing by calling setIcon(...).

Method Detail

### createIcon

    public JGoObject createIcon(java.lang.String s)

  Create and initialize the icon, which is normally an empty JGoImage that is not Selectable or Resizable.

  You should explicitly create the icon (typically a JGoImage) and call setIcon. Or you can override this method to create the appropriate icon automatically given the string argument, and thereby avoid having to call getImage().loadImage(...) or setIcon(...) later.

  Parameters:
    `s` - the same string as passed to the constructor and that is used by createLabel

### createPort

    public JGoPort createPort()

  Create and initialize the node's port, which is normally not visible and at the middle of the icon.

  The port has no FromSpot or ToSpot and its PortObject is set to the Icon.

### createLabel

    public JGoText createLabel(java.lang.String s)

  Create and initialize a text label displaying the given string.

  By default the JGoText object is not Selectable, but is Editable.

### copyChildren

    protected void copyChildren(JGoArea newarea,
                                JGoCopyEnvironment env)

  Description copied from class: `JGoArea`
  The default implementation for copying child objects is to just add a copy of each child to the new area.

  You may wish to override this in order to keep track of the children or do other bookkeeping. Remember that JGoObject.copyObject will return null if the object has already been copied. We suggest using JGoCopyEnvironment.copy instead: `newobj.myObjRef = env.copy(myObjRef);`

  Or call super.copyChildren first and just refer to the copied objects that are remembered in the copy environment: `newobj.myObjRef = (JGoObject)env.get(myObjRef);`

  Overrides:
    `copyChildren` in class `JGoArea`
  Parameters:
    `newarea` - the area newly created by copyObject() to which we need to add copies of the children of this area
    `env` - the environment for the copy operation - keeps track of copied objects.

### removeObjectAtPos

    public JGoObject removeObjectAtPos(JGoListPosition pos)

  When an object is removed, make sure there are no more references from fields.

  Specified by:
    `removeObjectAtPos` in interface `JGoObjectCollection`
  Overrides:
    `removeObjectAtPos` in class `JGoArea`

### getLocation

    public java.awt.Point getLocation(java.awt.Point result)

  Description copied from class: `JGoObject`
  Return the location of this object.

  Defaults to the value of getTopLeft(), but may be overridden by various objects that have a different natural notion of what their location is, with respect to the top-left corner. If you override this method, you should also override setLocation().

  Overrides:
    `getLocation` in class `JGoObject`
  Parameters:
    `result` - a Point that will be modified to have the object's natural location in document coordinates; if result is null a Point will be allocated
  Returns:
    the location of the object, in document coordinates; this is the modified argument result or else a newly allocated Point

### setLocation

    public void setLocation(int x,
                            int y)

  Description copied from class: `JGoObject`
  Sets the location of this object to the given point.

  By default the location is the top-left corner. Override this method to change the default behavior, to match any override of getLocation().

  Overrides:
    `setLocation` in class `JGoObject`
  Parameters:
    `x` - the new X position for the object's location
    `y` - the new Y position for the object's location

### layoutChildren

    public void layoutChildren(JGoObject childchanged)

  Keep the parts of a JGoIconicNode positioned relative to each other by setting their locations using some of the standard spots of any JGoObject.

  Overrides:
    `layoutChildren` in class `JGoArea`
  Parameters:
    `childchanged` - the child JGoObject that was moved or changed size; this may be null, indicating that everything should be reconsidered
  See Also:
    `JGoArea.geometryChange(java.awt.Rectangle)`, `JGoArea.geometryChangeChild(com.nwoods.jgo.JGoObject, java.awt.Rectangle)`

### getLabelOffset

    public java.awt.Dimension getLabelOffset()

  Return the offset of the label relative to the icon.

  This is used by layoutChildren to make sure the label maintains its position relative to the icon. The default value tells layoutChildren to ignore this value and instead position the label centered below the icon.

### setLabelOffset

    public void setLabelOffset(int w,
                               int h)

  Change the position of the label relative to the icon.

### setLabelOffset

    public void setLabelOffset(java.awt.Dimension d)

  This just calls setLabelOffset(d.width, d.height)

### isDraggableLabel

    public boolean isDraggableLabel()

  True when the user can drag the label around relative to the icon.

  When this property is true and the position of the label is changed, layoutChildren will remember the new offset relative to the icon.

### setDraggableLabel

    public void setDraggableLabel(boolean d)

  Change whether the user can drag around the label, thereby changing the LabelOffset interactively.

  Changing this value also changes correspondingly the Selectable and DragsNode properties of the label.

### getIcon

    public JGoObject getIcon()

  Return the JGoObject that serves as the icon for this node.

### setIcon

    public void setIcon(JGoObject icon)

  Change the icon for this node.

  You might want to override the createIcon method if you want to create a different kind of JGoImage when constructing this kind of node.

### getLabel

    public JGoText getLabel()

  Return the JGoText object that displays the text string.

  Specified by:
    `getLabel` in interface `JGoLabeledPart`
  Overrides:
    `getLabel` in class `JGoNode`

### setLabel

    public void setLabel(JGoText lab)

  Change the label for this node.

  You might want to override the createLabel method if you want to create a different kind of JGoText when constructing this kind of node.

  Overrides:
    `setLabel` in class `JGoNode`

### getPort

    public JGoPort getPort()

  Return the JGoPort object for this node.

### setPort

    public void setPort(JGoPort p)

  Change the port for this node.

  You might want to override the createPort method if you want to create a different kind of JGoPort when constructing this kind of node.

### getImage

    public JGoImage getImage()

  For convenience, this casts the Icon as a JGoImage if possible, or else returns null.

### getText

    public java.lang.String getText()

  Description copied from interface: `JGoLabeledPart`
  Return the text string associated with this object.

  This property is normally implemented to return the Label's Text string. This would return null if there is no Label. You may wish to implement this differently if there is no Label but there is a string naturally associated with the object, or if the desired string might be different than the label's text string.

  Specified by:
    `getText` in interface `JGoLabeledPart`
  Overrides:
    `getText` in class `JGoNode`

### setText

    public void setText(java.lang.String s)

  Description copied from class: `JGoNode`
  Change the Label's text string.

  This does nothing if getLabel() returns null.

  Overrides:
    `setText` in class `JGoNode`

### SVGUpdateReference

    public void SVGUpdateReference(java.lang.String attr,
                                   java.lang.Object referencedObject)

  Description copied from class: `JGoObject`
  This method will be called to fill in object references.

  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.

  Overrides:
    `SVGUpdateReference` in class `JGoNode`

### SVGWriteObject

    public void SVGWriteObject(DomDoc svgDoc,
                               DomElement jGoElementGroup)

  Description copied from interface: `JGoXMLSaveRestore`
  Write this object out to a DomDoc representing a Scalable Vector Graphics (SVG) XML document.

  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.

  Specified by:
    `SVGWriteObject` in interface `JGoXMLSaveRestore`
  Overrides:
    `SVGWriteObject` in class `JGoNode`

### SVGReadObject

    public DomNode SVGReadObject(DomDoc svgDoc,
                                 JGoDocument jGoDoc,
                                 DomElement svgElement,
                                 DomElement jGoChildElement)

  Description copied from interface: `JGoXMLSaveRestore`
  Read this object in from a DomDoc representing a Scalable Vector Graphics (SVG) XML document.

  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.

  Specified by:
    `SVGReadObject` in interface `JGoXMLSaveRestore`
  Overrides:
    `SVGReadObject` in class `JGoNode`

### copyNewValueForRedo

    public void copyNewValueForRedo(JGoDocumentChangedEdit e)

  Description copied from class: `JGoObject`
  This method is called when a JGoDocumentChangedEdit is created for a JGoDocumentEvent.CHANGED event, when a JGoObject has been changed. In order for the JGoDocumentChangedEdit to be able to perform a redo, it needs to remember the new property value or state. However, the JGoObject.update method does not provide such a new value. The value must be taken from this object and copied into the JGoDocumentChangedEdit by calling setNewValue and/or setNewValueInt.

  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.

  Overrides:
    `copyNewValueForRedo` in class `JGoNode`

### changeValue

    public void changeValue(JGoDocumentChangedEdit e,
                            boolean undo)

  Description copied from class: `JGoObject`
  This method is called by the JGoDocumentChangedEdit.undo and redo methods to actually perform the property value change for a JGoObject.

  You will want to override this method to handle changing the additional state of your object subclasses.

  Overrides:
    `changeValue` in class `JGoNode`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD