com.nwoods.jgo
Class JGoScrollBar

java.lang.Object
  extended bycom.nwoods.jgo.JGoObject
      extended bycom.nwoods.jgo.JGoControl
          extended bycom.nwoods.jgo.JGoScrollBar
All Implemented Interfaces:
JGoXMLSaveRestore, java.io.Serializable

public class JGoScrollBar
extends JGoControl

A JGoControl containing an SWT Slider widget. A JGoButton allows a Slider control 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 SWT Controls 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 ChangedScrollBar
          a CHANGED JGoDocumentEvent or JGoViewEvent hint: many of the scroll bar properties may have changed.
static int ChangedScrollBarValue
          a CHANGED JGoDocumentEvent or JGoViewEvent hint, by default sent to the Parent of the JGoScrollBar: the scroll bar's value has changed
static int ChangedScrollBarVertical
          a CHANGED JGoDocumentEvent or JGoViewEvent hint: the orientation of the scroll bar 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
JGoScrollBar()
          Constructs a new JGoScrollBar
JGoScrollBar(org.eclipse.swt.graphics.Point location, Dimension size, boolean vertical)
          Construct a scroll bar at a given location with a given size.
JGoScrollBar(org.eclipse.swt.graphics.Rectangle rect, boolean vertical)
          Create a new scroll bar control with the given bounding rectangle.
 
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.
 org.eclipse.swt.widgets.Control createControl(JGoView view)
          Each JGoControl subclass is responsible for representing the JGoControl with a Control that will be added to the JGoView's canvas.
 int getBlockIncrement()
          Return the amount that the current value will increase or decrease when the user clicks on the scroll bar between the "thumb" or "slider" and the "up"/"down" buttons.
 int getExtent()
          Return the number of values to be shown as "visible", starting at getValue().
 int getMaximum()
          Return the maximum possible value for the scroll bar.
 int getMinimum()
          Return the minimum possible value for the scroll bar.
 int getUnitIncrement()
          Return the amount that the current value will increase or decrease when the user clicks on the scroll bar buttons.
 int getValue()
          Return the "current value" for the scroll bar.
 boolean isVertical()
          Return whether the scroll bar is oriented vertically instead of horizontally.
 void setValue(int newvalue)
          Set the "current value" for the scroll bar
 void setValues(int val, int ext, int min, int max, int unit, int block)
          Set all the scroll bar values at once.
 void setVertical(boolean v)
          Control whether the scroll bar is oriented vertically instead of horizontally.
 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.
 void valueChanged(int newvalue, JGoView view)
          This method is called when the scrollbar's value changes, from the Slider's SelectionListener.
 
Methods inherited from class com.nwoods.jgo.JGoControl
geometryChange, getControl, getIterator, ownerChange, paint, 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, isSuspendUpdates, isTopLevel, isUpdatePartner, isVisible, lostSelection, partnerUpdate, pick, redirectSelection, remove, set4ResizeHandles, setAutoRescale, setBoundingRect, setBoundingRect, setBoundingRect, 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, 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

ChangedScrollBar

public static final int ChangedScrollBar
a CHANGED JGoDocumentEvent or JGoViewEvent hint: many of the scroll bar properties may have changed.

See Also:
Constant Field Values

ChangedScrollBarValue

public static final int ChangedScrollBarValue
a CHANGED JGoDocumentEvent or JGoViewEvent hint, by default sent to the Parent of the JGoScrollBar: the scroll bar's value has changed

See Also:
Constant Field Values

ChangedScrollBarVertical

public static final int ChangedScrollBarVertical
a CHANGED JGoDocumentEvent or JGoViewEvent hint: the orientation of the scroll bar has changed

See Also:
Constant Field Values
Constructor Detail

JGoScrollBar

public JGoScrollBar()
Constructs a new JGoScrollBar


JGoScrollBar

public JGoScrollBar(org.eclipse.swt.graphics.Rectangle rect,
                    boolean vertical)
Create a new scroll bar control with the given bounding rectangle.

Parameters:
rect - the bounding rectangle

JGoScrollBar

public JGoScrollBar(org.eclipse.swt.graphics.Point location,
                    Dimension size,
                    boolean vertical)
Construct a scroll bar at a given location with a given size.

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.

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

createControl

public org.eclipse.swt.widgets.Control createControl(JGoView view)
Description copied from class: JGoControl
Each JGoControl subclass is responsible for representing the JGoControl with a Control that will be added to the JGoView's canvas.

You may wish to return null when no Control is desired for this JGoControl, perhaps just for the given view.

Specified by:
createControl in class JGoControl
Parameters:
view - the view for which this control should be created
Returns:
a Control

isVertical

public boolean isVertical()
Return whether the scroll bar is oriented vertically instead of horizontally. By default the scroll bar is vertical.


setVertical

public void setVertical(boolean v)
Control whether the scroll bar is oriented vertically instead of horizontally.


setValues

public void setValues(int val,
                      int ext,
                      int min,
                      int max,
                      int unit,
                      int block)
Set all the scroll bar values at once.

Parameters:
val - the new "current value" for the scroll bar
ext - the number of values to be shown as "visible", starting at VAL
min - the minimum possible value for the scroll bar
max - the maximum possible value for the scroll bar
unit - the amount to increment or decrement the current value when the user clicks on the scroll bar buttons
block - the amount to increment or decrement the current value when the user clicks on the scroll bar between the "thumb" or "slider" and the "up"/"down" buttons

getValue

public int getValue()
Return the "current value" for the scroll bar.


setValue

public void setValue(int newvalue)
Set the "current value" for the scroll bar


getExtent

public int getExtent()
Return the number of values to be shown as "visible", starting at getValue().


getMinimum

public int getMinimum()
Return the minimum possible value for the scroll bar.


getMaximum

public int getMaximum()
Return the maximum possible value for the scroll bar.


getUnitIncrement

public int getUnitIncrement()
Return the amount that the current value will increase or decrease when the user clicks on the scroll bar buttons.


getBlockIncrement

public int getBlockIncrement()
Return the amount that the current value will increase or decrease when the user clicks on the scroll bar between the "thumb" or "slider" and the "up"/"down" buttons.


valueChanged

public void valueChanged(int newvalue,
                         JGoView view)
This method is called when the scrollbar's value changes, from the Slider's SelectionListener. By default this calls setValue inside a document transaction.


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

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