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

java.lang.Object
  com.nwoods.jgo.JGoObject
      com.nwoods.jgo.JGoArea
          com.nwoods.jgo.instruments.Meter

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

Direct Known Subclasses:: MultipleIndicatorMeter

public class Meter
extends JGoArea

A JGoArea designed to maintain a AbstractGraduatedScale, an AbstractIndicator, a JGoObject background, and a JGoText label.

See Also:: Serialized Form

Field Summary
`static int`	`ChangedBackground` This is a JGoObject update subhint.
`static int`	`ChangedIndicator` This is a JGoObject update subhint.
`static int`	`ChangedInsets` This is a JGoObject update subhint.
`static int`	`ChangedLabel` This is a JGoObject update subhint.
`static int`	`ChangedLabelRelativeSpot` This is a JGoObject update subhint.
`static int`	`ChangedLabelSpot` This is a JGoObject update subhint.
`static int`	`ChangedOrientation` This is a JGoObject update subhint.
`static int`	`ChangedScale` This is a JGoObject update subhint.
`static int`	`OrientationHorizontal` A value for the Orientation property.
`static int`	`OrientationVertical` A value for the Orientation property.

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
`Meter()` Creates an empty Meter -- call initialize() before using!

Method Summary
`void`	`changeValue(JGoDocumentChangedEdit e, boolean undo)` Handle undo and redo changes.
`protected void`	`copyChildren(JGoArea newarea, JGoCopyEnvironment env)` Make sure fields referring to children are updated to refer to the newly copied objects.
`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
`protected JGoObject`	`createBackground()` Method for creating an instance of the meter's standard background.
`protected AbstractIndicator`	`createIndicator()` Method for creating an instance of the meter's standard indicator.
`protected JGoText`	`createLabel()` Method for creating an instance of the meter's standard label.
`protected AbstractGraduatedScale`	`createScale()` Method for creating an instance of the meter's standard scale.
`JGoObject`	`getBackground()` Gets the background object of the Meter.
`AbstractIndicator`	`getIndicator()` Gets the AbstractIndicator associated with the Meter.
`java.awt.Insets`	`getInsets()` Gets the margin between the top-left corner of the Background and the top-left corner of the Scale (and AbstractIndicator).
`JGoText`	`getLabel()` Gets the label object of the Meter.
`int`	`getLabelRelativeSpot()` Gets the Label's position compared to the spot specified by the LabelSpot.
`int`	`getLabelSpot()` Gets the position of Label compared to the Background.
`double`	`getMaximum()` AbstractGraduatedScale's Maximum property exposed from this Meter's Scale.
`double`	`getMinimum()` AbstractGraduatedScale's Minimum property exposed from this Meter's Scale.
`int`	`getOrientation()` Some meters may find it useful to be oriented along either a horizontal or vertical direction; others may ignore this.
`double`	`getQuantizeBase()` The AbstractIndicator.QuantizeBase property exposed from the Meter's AbstractIndicator.
`double`	`getQuantizeUnit()` The AbstractIndicator.QuantizeUnit property exposed from the Meter's AbstractIndicator.
`AbstractGraduatedScale`	`getScale()` Gets the AbstractGraduatedScale associated with the Meter.
`int`	`getScaleLabelDistance()` AbstractGraduatedScale's LabelDistance property exposed from this Meter's Scale.
`java.lang.String`	`getScaleLabelFormat()` AbstractGraduatedScale's LabelFormat property exposed from this Meter's Scale.
`int`	`getScaleLabelFrequency()` AbstractGraduatedScale's LabelFrequency property exposed from this Meter's Scale.
`int`	`getScaleLabelStyle()` AbstractGraduatedScale's LabelStyle property exposed from this Meter's Scale.
`double`	`getTickBase()` AbstractGraduatedScale's TickBase property exposed from this Meter's Scale.
`java.awt.Color`	`getTickColor()` AbstractGraduatedScale's TickColor property exposed from this Meter's Scale.
`float`	`getTickLengthLeft()` AbstractGraduatedScale's TickLengthLeft property exposed from this Meter's Scale.
`float`	`getTickLengthRight()` AbstractGraduatedScale's TickLengthRight property exposed from this Meter's Scale.
`int`	`getTickMajorFrequency()` AbstractGraduatedScale's TickMajorFrequency property exposed from this Meter's Scale.
`float`	`getTickMajorLengthRatio()` AbstractGraduatedScale's TickMajorLengthRatio property exposed from this Meter's Scale.
`int`	`getTickMajorWidth()` AbstractGraduatedScale's TickMajorWidth property exposed from this Meter's Scale.
`double`	`getTickUnit()` AbstractGraduatedScale's TickUnit property exposed from this Meter's Scale.
`int`	`getTickWidth()` AbstractGraduatedScale's TickWidth property exposed from this Meter's Scale.
`double`	`getValue()` The AbstractIndicator.Value property exposed from the Meter's AbstractIndicator.
`void`	`initialize()` This calls createBackground(), createLabel(), createScale(), and createIndicator(), adds all the resulting objects to this area, and sets the AbstractIndicator's Scale to the created scale.
`boolean`	`isControllable()` Gets whether the value of the meter can be manipulated by the user.
`boolean`	`isQuantized()` The AbstractIndicator.Quantized property exposed from the Meter's AbstractIndicator.
`boolean`	`isTickLabels()` AbstractGraduatedScale's TickLabels property exposed from this Meter's Scale.
`void`	`layoutChildren(JGoObject childchanged)` Have the Scale and AbstractIndicator have the same bounds smaller than and within the Background, as determined by TopLeftMargin and BottomRightMargin.
`JGoObject`	`removeObjectAtPos(JGoListPosition pos)` If any part is removed from this group, be sure to remove any references in local fields.
`void`	`setBackground(JGoObject value)` Sets the background object of the Meter.
`void`	`setControllable(boolean value)` Sets whether the value of the meter can be manipulated by the user.
`void`	`setIndicator(AbstractIndicator value)` Sets the AbstractIndicator associated with the Meter.
`void`	`setInsets(java.awt.Insets x)` Sets the margin between the top-left corner of the Background and the top-left corner of the Scale (and AbstractIndicator).
`void`	`setLabel(JGoText value)` Sets the label object of the Meter.
`void`	`setLabelRelativeSpot(int value)` Sets the Label's position compared to the spot specified by the LabelSpot.
`void`	`setLabelSpot(int value)` Sets the position of Label compared to the Background.
`void`	`setMaximum(double value)` AbstractGraduatedScale's Maximum property exposed from this Meter's Scale.
`void`	`setMinimum(double value)` AbstractGraduatedScale's Minimum property exposed from this Meter's Scale.
`void`	`setOrientation(int value)` Some meters may find it useful to be oriented along either a horizontal or vertical direction; others may ignore this.
`void`	`setQuantizeBase(double value)` The AbstractIndicator.QuantizeBase property exposed from the Meter's AbstractIndicator.
`void`	`setQuantized(boolean value)` The AbstractIndicator.Quantized property exposed from the Meter's AbstractIndicator.
`void`	`setQuantizeUnit(double value)` The AbstractIndicator.QuantizeUnit property exposed from the Meter's AbstractIndicator.
`void`	`setScale(AbstractGraduatedScale value)` Sets the AbstractGraduatedScale associated with the Meter.
`void`	`setScaleLabelDistance(int value)` AbstractGraduatedScale's LabelDistance property exposed from this Meter's Scale.
`void`	`setScaleLabelFormat(java.lang.String value)` AbstractGraduatedScale's LabelFormat property exposed from this Meter's Scale.
`void`	`setScaleLabelFrequency(int value)` AbstractGraduatedScale's LabelFrequency property exposed from this Meter's Scale.
`void`	`setScaleLabelStyle(int value)` AbstractGraduatedScale's LabelStyle property exposed from this Meter's Scale.
`void`	`setTickBase(double value)` AbstractGraduatedScale's TickBase property exposed from this Meter's Scale.
`void`	`setTickColor(java.awt.Color value)` AbstractGraduatedScale's TickColor property exposed from this Meter's Scale.
`void`	`setTickLabels(boolean value)` AbstractGraduatedScale's TickLabels property exposed from this Meter's Scale.
`void`	`setTickLengthLeft(float value)` AbstractGraduatedScale's TickLengthLeft property exposed from this Meter's Scale.
`void`	`setTickLengthRight(float value)` AbstractGraduatedScale's TickLengthRight property exposed from this Meter's Scale.
`void`	`setTickMajorFrequency(int value)` AbstractGraduatedScale's TickMajorFrequency property exposed from this Meter's Scale.
`void`	`setTickMajorLengthRatio(float value)` AbstractGraduatedScale's TickMajorLengthRatio property exposed from this Meter's Scale.
`void`	`setTickMajorWidth(int value)` AbstractGraduatedScale's TickMajorWidth property exposed from this Meter's Scale.
`void`	`setTickUnit(double value)` AbstractGraduatedScale's TickUnit property exposed from this Meter's Scale.
`void`	`setTickWidth(int value)` AbstractGraduatedScale's TickWidth property exposed from this Meter's Scale.
`void`	`setValue(double value)` The AbstractIndicator.Value property exposed from the Meter's AbstractIndicator.
`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.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, getLocation, 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, ownerChange, partnerUpdate, 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, 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

OrientationHorizontal

public static final int OrientationHorizontal

A value for the Orientation property.

See Also:: Constant Field Values

OrientationVertical

public static final int OrientationVertical

A value for the Orientation property.

See Also:: Constant Field Values