IndicatorBar (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 IndicatorBar

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

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

Direct Known Subclasses:: IndicatorBarElliptical

public class IndicatorBar
extends AbstractIndicator

An AbstractIndicator that represents its value as a bar beginning at a set start point and extending to an end point which represents a specific value.

See Also:: Serialized Form

Field Summary
`static int`	`ChangedStartOffset` This is a JGoObject update subhint.
`static int`	`ChangedThickness` This is a JGoObject update subhint.
`static int`	`InsertedPhase` This is a JGoObject update subhint.
`static int`	`RemovedPhase` This is a JGoObject update subhint.
`static int`	`ReplacedPhase` This is a JGoObject update subhint.

Fields inherited from class com.nwoods.jgo.instruments.AbstractIndicator

ChangedActionEnabled, ChangedQuantBase, ChangedQuantized, ChangedQuantUnit, ChangedScale, ChangedValue

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
`IndicatorBar()` This constructor creates an IndicatorBar with all default properties.

Method Summary
`void`	`addPhase(Phase p)` Add a Phase to the IndicatorBar's phase collection.
`void`	`changeValue(JGoDocumentChangedEdit e, boolean undo)` Handle undo and redo changes.
`protected void`	`computePath(java.awt.geom.GeneralPath path)` Returns 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
`void`	`generateSVGOutput(DomDoc svgDoc, DomElement jGoElementGroup)`
`Phase`	`getPhase(int i)` Returns the phase located at the given index of the IndicatorBar's phase collection.
`int`	`getPhaseCount()` Gets the number of phases currently in the IndicatorBar's phase collection.
`void`	`getPhasePath(java.awt.geom.GeneralPath path, double min, double max)` Compute a GeneralPath corresponding to a specific phase of the IndicatorBar.
`java.awt.Dimension`	`getStartOffset()` Gets the offset of this bar's starting point relative to the scale's point for the minimum value.
`float`	`getThickness()` Gets the thickness of the IndicatorBar.
`void`	`insertPhase(int i, Phase p)` Insert a phase to a specific index of the phase collection.
`boolean`	`isPointInObj(java.awt.Point p)` Returns true if the point is close to the end of the bar.
`void`	`paint(java.awt.Graphics2D g, JGoView view)` Render this object to a Graphics object.
`void`	`paintPhase(java.awt.Graphics2D g, JGoView view, Phase phase, java.awt.geom.GeneralPath path)` Used to paint a given Phase.
`void`	`removePhase(int i)` Remove a Phase from the IndicatorBar's phase collection.
`void`	`removePhase(Phase p)` Remove a Phase from the IndicatorBar's phase collection.
`void`	`setPhase(int i, Phase p)` Replace a phase at a specific index of the phase collection.
`void`	`setStartOffset(java.awt.Dimension value)` Sets the offset of this bar's starting point relative to the scale's point for the minimum value.
`void`	`setThickness(float value)` Sets the thickness of the IndicatorBar.
`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.instruments.AbstractIndicator

doUncapturedMouseMove, expandRectByPenWidth, geometryChange, getPartner, getPath, getQuantizeBase, getQuantizeUnit, getScale, getValue, getValueForPoint, isActionActivated, isActionEnabled, isQuantized, makePath, onAction, onActionAdjusted, onActionCancelled, quantizeValue, resetPath, setActionActivated, setActionEnabled, setPartner, setQuantizeBase, setQuantized, setQuantizeUnit, setScale, setValue, validValue

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, 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