AbstractIndicator (JGo API Reference)

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.instruments
Class AbstractIndicator

java.lang.Object
  com.nwoods.jgo.JGoObject
      com.nwoods.jgo.JGoDrawable
          com.nwoods.jgo.instruments.AbstractIndicator

All Implemented Interfaces:: JGoActionObject, JGoXMLSaveRestore, java.io.Serializable

Direct Known Subclasses:: IndicatorBar, IndicatorKnob, IndicatorNeedle, IndicatorSlider

public abstract class AbstractIndicator
extends JGoDrawable
implements JGoActionObject

An abstract class designed to visually represent a specific quantitative value.

AbstractIndicator provides a basis for indicators designed to interact with an implementation of GraduatedScale to indicate values that correspond to specific graphical points, determined by the GraduatedScale. However, it is possible to create an AbstractIndicator that does not rely on an instance of GraduatedScale, and the information needed to indicate specific values would be contained internally. This would be useful when the value system does not correspond to graphical points, such as a color scale system.

See Also:: Serialized Form

Field Summary
`static int`	`ChangedActionEnabled` This is a JGoObject update subhint.
`static int`	`ChangedQuantBase` This is a JGoObject update subhint.
`static int`	`ChangedQuantized` This is a JGoObject update subhint.
`static int`	`ChangedQuantUnit` This is a JGoObject update subhint.
`static int`	`ChangedScale` This is a JGoObject update subhint.
`static int`	`ChangedValue` This is a JGoObject update subhint.

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
`protected`	`AbstractIndicator()` The constructor changes the default JGoDrawable brush of Indicators to JGoBrush.red and makes it not Selectable.

Method Summary
`void`	`changeValue(JGoDocumentChangedEdit e, boolean undo)` Handle undo and redo changes.
`protected void`	`computePath(java.awt.geom.GeneralPath path)` Compute a GeneralPath used to paint this AbstractIndicator
`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)` Copy the field values and the internal data structures to avoid sharing references
`boolean`	`doUncapturedMouseMove(int flags, java.awt.Point dc, java.awt.Point vc, JGoView view)` Change the cursor to Cursors.Hand if the user can modify the value of this indicator interactively.
`void`	`expandRectByPenWidth(java.awt.Rectangle rect)` Take into account the bounds of the GeneralPath.
`void`	`generateSVGOutput(DomDoc svgDoc, DomElement jGoElementGroup)`
`protected void`	`geometryChange(java.awt.Rectangle old)` Whenever the size and/or position is changed, we need to recalculate the GeneralPath.
`JGoObject`	`getPartner()` Sometimes it is convenient to be able to associate an object with another object, without any predetermined knowledge about the class.
`java.awt.geom.GeneralPath`	`getPath()`
`double`	`getQuantizeBase()` Gets the base value which is allowed when AbstractIndicator.Quantized is true.
`double`	`getQuantizeUnit()` Gets the difference between two consecutive allowed values when AbstractIndicator.Quantized is true.
`GraduatedScale`	`getScale()` Gets the scale with which the indicator is associated.
`double`	`getValue()` Gets the value that will be indicated, relative to the associated GraduatedScale.
`double`	`getValueForPoint(java.awt.Point dc)` This method is called by onActionAdjusted and onAction to get the proposed new value for the given mouse point.
`boolean`	`isActionActivated()` Gets whether the object's Action is about to be invoked, normally by a mouse button being pressed.
`boolean`	`isActionEnabled()` Gets whether the user can adjust the indicators value.
`boolean`	`isQuantized()` Gets whether the indicator is forced to have discrete values.
`java.awt.geom.GeneralPath`	`makePath()` Make sure that whenever we reconstruct the main GeneralPath for this shape, we call computePath.
`void`	`onAction(JGoView view, int modifiers, java.awt.Point dc, java.awt.Point vc)` This method is called by JGoView to perform the object's action, normally by a mouse button being released.
`void`	`onActionAdjusted(JGoView view, int modifiers, java.awt.Point dc, java.awt.Point vc, int event)` This method is called by JGoView as the user is adjusting the object, normally by a mouse drag or move.
`void`	`onActionCancelled(JGoView view)` Just restore the original value of this indicator, as remembered when this indicator was activated.
`void`	`paint(java.awt.Graphics2D g, JGoView view)` Paint this object to a view, using a GeneralPath determined by a call to computePath.
`double`	`quantizeValue(double val)` A function used to ensure valid values within the quantized value system.
`protected void`	`resetPath()`
`void`	`setActionActivated(boolean value)` Sets whether the object's Action is about to be invoked, normally by a mouse button being pressed.
`void`	`setActionEnabled(boolean value)` Sets whether the user can adjust the indicators value.
`void`	`setPartner(JGoObject value)` Sometimes it is convenient to be able to associate an object with another object, without any predetermined knowledge about the class.
`void`	`setQuantizeBase(double value)` Sets the base value which is allowed when AbstractIndicator.Quantized is true.
`void`	`setQuantized(boolean value)` Sets whether the indicator is forced to have discrete values.
`void`	`setQuantizeUnit(double value)` Sets the difference between two consecutive allowed values when AbstractIndicator.Quantized is true.
`void`	`setScale(GraduatedScale value)` Sets the scale with which the indicator is associated.
`void`	`setValue(double value)` Sets the value that will be indicated, relative to the associated GraduatedScale.
`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.
`double`	`validValue(double val)` A function used to check the validity of the given value.

Methods inherited from class com.nwoods.jgo.JGoDrawable

draw3DRect, draw3DRect, drawEllipse, drawEllipse, drawEllipse, drawLine, drawLine, drawPath, drawPolygon, drawPolygon, drawRect, drawRect, drawRect, drawRoundRect, drawRoundRect, getBrush, getNearestIntersectionPoint, getPen, setBrush, setPen, SVGAddPathArgs, SVGReadAttributes, SVGWriteAttributes

Methods inherited from class com.nwoods.jgo.JGoObject

canView, computeBoundingRect, computeMove, computeResize, copy, copyObjectDelayed, copyOldValueForUndo, copyRect, doMouseClick, doMouseDblClick, findCommonParent, foredate, gainedSelection, geometryChangeChild, getBoundingRect, getDocument, getDraggingObject, getFlags, getHeight, getLayer, getLeft, getLocation, getLocation, getParent, getParentJGoNode, getParentNode, 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, ownerChange, partnerUpdate, pick, redirectSelection, remove, set4ResizeHandles, setAutoRescale, setBoundingRect, setBoundingRect, setBoundingRect, setBoundingRectForce, setBoundingRectForce, setBoundingRectInvalid, setBoundsRect, setDraggable, setDragsNode, setFlags, setHeight, setInitializing, setLeft, setLocation, setLocation, setLocationOffset, setLocationOffset, setParent, setRectangleSpotLocation, setResizable, setSelectable, setSize, setSize, setSizeKeepingLocation, setSkipsUndoManager, setSpotLocation, setSpotLocation, setSpotLocation, setSpotLocationOffset, setSuspendChildUpdates, setSuspendUpdates, setTop, setTopLeft, setTopLeft, setUpdatePartner, setVisible, setWidth, showSelectionHandles, spotOpposite, update, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail