com.nwoods.jgo
Class JGoButton

java.lang.Object
  com.nwoods.jgo.JGoObject
      com.nwoods.jgo.JGoControl
          com.nwoods.jgo.JGoButton

All Implemented Interfaces:

JGoXMLSaveRestore, java.io.Serializable

public class JGoButton

extends JGoControl

A JGoControl containing a Swing JButton. A JGoButton allows a JButton component to be drawn along with other JGoObjects, and allows it be scrolled and scaled.

Clicking on the button will fire a JGoViewEvent.CLICKED event and will call this object's doMouseClick() method.

Note that, like all other JGoControls, the Swing JComponents created to be displayed as the representation of these JGoObjects, will appear in front of (on top of) all other JGoObjects. Thus it is wise to either use these objects as view objects or make sure they don't overlap with other document objects.

See Also:

Serialized Form

Field Summary

static int

ChangedLabel a CHANGED JGoDocumentEvent or JGoViewEvent hint: the button's text label has changed

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

JGoButton()
Constructs a new JGoButton.

JGoButton(java.awt.Point location, java.awt.Dimension size, java.lang.String label)
Construct a JGoControl at a given location with a given size and the given label.

JGoButton(java.awt.Rectangle rect, java.lang.String label)
Create a new button control with the given bounding rectangle and the given label.

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.
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 new instance of this object.
javax.swing.JComponent	createComponent(JGoView view) Return a Swing JButton that will represent this control on the screen.
java.lang.String	getLabel() Return the label for this button.
void	paint(java.awt.Graphics2D g, JGoView view) Cause the Swing JComponent associated with this JGoButton to be drawn in the JGoView.
void	setLabel(java.lang.String newLabel) Set the label for this button.
void	SVGReadAttributes(DomElement svgElement) This method will read attributes from standard SVG elements.
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	SVGWriteAttributes(DomElement svgElement) This method will add attributes to standard SVG elements.
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.JGoControl

geometryChange, getComponent, getIterator, ownerChange, setVisible

Methods inherited from class com.nwoods.jgo.JGoObject

canView, computeBoundingRect, computeMove, computeResize, copy, copyObjectDelayed, copyOldValueForUndo, copyRect, doMouseClick, doMouseDblClick, doUncapturedMouseMove, expandRectByPenWidth, findCommonParent, foredate, gainedSelection, geometryChangeChild, getBoundingRect, getDocument, getDraggingObject, getFlags, getHeight, getLayer, getLeft, getLocation, getLocation, getNearestIntersectionPoint, getParent, getParentJGoNode, getParentNode, getPartner, getRectangleSpotLocation, getSize, getSize, getSpotLocation, getSpotLocation, getToolTipText, 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, partnerUpdate, pick, redirectSelection, remove, set4ResizeHandles, setAutoRescale, setBoundingRect, setBoundingRect, setBoundingRect, setBoundingRectForce, setBoundingRectForce, setBoundingRectInvalid, setBoundsRect, setDraggable, setDragsNode, setFlags, setHeight, setInitializing, setLeft, setLocation, setLocation, setLocationOffset, setLocationOffset, setParent, setPartner, setRectangleSpotLocation, setResizable, setSelectable, setSize, setSize, setSizeKeepingLocation, setSkipsUndoManager, setSpotLocation, setSpotLocation, setSpotLocation, setSpotLocationOffset, setSuspendChildUpdates, setSuspendUpdates, setTop, setTopLeft, setTopLeft, setUpdatePartner, setWidth, showSelectionHandles, spotOpposite, SVGUpdateReference, 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 CHANGED JGoDocumentEvent or JGoViewEvent hint: the button's text label has changed

See Also:

Constant Field Values

Constructor Detail

JGoButton

public JGoButton()

Constructs a new JGoButton.

JGoButton

public JGoButton(java.awt.Rectangle rect,
                 java.lang.String label)

Create a new button control with the given bounding rectangle and the given label.

Parameters:

rect - the bounding rectangle

label - the label on the button

JGoButton

public JGoButton(java.awt.Point location,
                 java.awt.Dimension size,
                 java.lang.String label)

Construct a JGoControl at a given location with a given size and the given label.

Parameters:

location - the upper left corner, in document coordinates

size - the dimensions of the rectangle, in document coordinates

Method Detail

copyObject

public JGoObject copyObject(JGoCopyEnvironment env)

Create a new instance of this object. This copies the label but does not copy any associated component/control.

Overrides:

copyObject in class JGoObject

Parameters:

env - the environment for the copy operation - keeps track of copied objects.

Returns:

a newly allocated copy of this object, or null

createComponent

public javax.swing.JComponent createComponent(JGoView view)

Return a Swing JButton that will represent this control on the screen. Create the JButton if not already created.

The JButton, when clicked, will automatically invoke the view's listeners with JGoViewEvent.CLICKED.

Specified by:

createComponent in class JGoControl

Parameters:

view - the view for which this control should be created

Returns:

the Swing JComponent that will represent this control

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 JGoObject

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 JGoObject

SVGWriteAttributes

public void SVGWriteAttributes(DomElement svgElement)

Description copied from class: JGoObject

This method will add attributes to standard SVG elements.

Call this method from SVGWriteObject() if standard SVG elements are generated by this class or if this class may be subclassed and it should contribute arguments to SVG elements. For example, the JGoDrawable class implements this method to add standard SVG attributes for stroke, fill, and width. The JGoRectangle class calls this method to add all appropriate attributes to the <rect> element it generates. It is not necessary to implement this method if this class does not contribute any attributes to standard SVG elements. It is not necessary to call this method from SVGWriteObject() if this class does not generate any standard SVG elements.

Typically, an implementation of this method will first call the superclass and then call DomElement.setAttribute() to add attributes for this class.

Overrides:

SVGWriteAttributes in class JGoObject

Parameters:

svgElement - the DomElement to which to add attributes

See Also:

JGoObject.SVGWriteObject(com.nwoods.jgo.DomDoc, com.nwoods.jgo.DomElement), JGoObject.SVGReadObject(com.nwoods.jgo.DomDoc, com.nwoods.jgo.JGoDocument, com.nwoods.jgo.DomElement, com.nwoods.jgo.DomElement), JGoObject.SVGWriteAttributes(com.nwoods.jgo.DomElement), JGoObject.SVGReadAttributes(com.nwoods.jgo.DomElement), JGoObject.SVGUpdateReference(java.lang.String, java.lang.Object), DomDoc, DomNode, DomElement, DomText

SVGReadAttributes

public void SVGReadAttributes(DomElement svgElement)

Description copied from class: JGoObject

This method will read attributes from standard SVG elements.

Call this method from SVGReadObject() if standard SVG elements are being read by this class or if this class may be subclassed and it should read arguments from SVG elements. For example, the JGoDrawable class implements this method to read standard SVG attributes for stroke, fill, and width. The JGoRectangle class calls this method to read all appropriate attributes from the <rect> element it is reading. It is not necessary to implement this method if this class does not read any attributes from standard SVG elements. It is not necessary to call this method from SVGReadObject() if this class does not read any standard SVG elements.

Typically, an implementation of this method will first call the superclass and then call DomElement.getAttribute() to read the attributes for this class.

Overrides:

SVGReadAttributes in class JGoObject

Parameters:

svgElement - the DomElement from which to read attributes

See Also:

JGoObject.SVGWriteObject(com.nwoods.jgo.DomDoc, com.nwoods.jgo.DomElement), JGoObject.SVGReadObject(com.nwoods.jgo.DomDoc, com.nwoods.jgo.JGoDocument, com.nwoods.jgo.DomElement, com.nwoods.jgo.DomElement), JGoObject.SVGWriteAttributes(com.nwoods.jgo.DomElement), JGoObject.SVGReadAttributes(com.nwoods.jgo.DomElement), JGoObject.SVGUpdateReference(java.lang.String, java.lang.Object), DomDoc, DomNode, DomElement, DomText

paint

public void paint(java.awt.Graphics2D g,
                  JGoView view)

Cause the Swing JComponent associated with this JGoButton to be drawn in the JGoView.

Overrides:

paint in class JGoControl

Parameters:

g - this Graphics should be ignored, because it is transformed

view - the view in which this control should be drawn

getLabel

public java.lang.String getLabel()

Return the label for this button.

Returns:

the label for this button.

setLabel

public void setLabel(java.lang.String newLabel)

Set the label for this button.

Parameters:

newLabel - the label for this button.

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 JGoObject

Parameters:

e - the UndoableEdit that also remembers the kind of change and any appropriate new state that should be copied in

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 JGoObject

Parameters:

e - the UndoableEdit that also remembers the kind of change and any appropriate old and new state for performing an undo or redo

undo - if true, this method should restore the old state/value, otherwise this method should restore the new state/value