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

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

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

Direct Known Subclasses:: GraduatedScaleElliptical, GraduatedScaleLinear

public abstract class AbstractGraduatedScale
extends JGoDrawable
implements GraduatedScale

An implementation of the GraduatedScale class, used to depict a scale as a path between two end points, representing a minimum and maximum value, with all the points along that path representing uniformly delineated values.

See Also:: Serialized Form

Field Summary
`static int`	`ChangedLabelDistance` This is a JGoObject update subhint.
`static int`	`ChangedLabelFormat` This is a JGoObject update subhint.
`static int`	`ChangedLabelFrequency` This is a JGoObject update subhint.
`static int`	`ChangedLabelStyle` This is a JGoObject update subhint.
`static int`	`ChangedLabelTemplate` This is a JGoObject update subhint.
`static int`	`ChangedMaximum` This is a JGoObject update subhint.
`static int`	`ChangedMinimum` This is a JGoObject update subhint.
`static int`	`ChangedTickBase` This is a JGoObject update subhint.
`static int`	`ChangedTickColor` This is a JGoObject update subhint.
`static int`	`ChangedTickLabels` This is a JGoObject update subhint.
`static int`	`ChangedTickLengthLeft` This is a JGoObject update subhint.
`static int`	`ChangedTickLengthRight` This is a JGoObject update subhint.
`static int`	`ChangedTickMajorFrequency` This is a JGoObject update subhint.
`static int`	`ChangedTickMajorLengthRatio` This is a JGoObject update subhint.
`static int`	`ChangedTickMajorWidth` This is a JGoObject update subhint.
`static int`	`ChangedTickUnit` This is a JGoObject update subhint.
`static int`	`ChangedTickWidth` This is a JGoObject update subhint.
`static int`	`LabelStyleAlternateStartLeft` A style for the layout of tick labels for AbstractGraduatedScale.
`static int`	`LabelStyleAlternateStartRight` A style for the layout of tick labels for AbstractGraduatedScale.
`static int`	`LabelStyleLeft` A style for the layout of tick labels for AbstractGraduatedScale.
`static int`	`LabelStyleRight` A style for the layout of tick labels for AbstractGraduatedScale.

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`	`AbstractGraduatedScale()` This constructor creates a AbstractGraduatedScale with all default properties, including not being Selectable.

Method Summary
`void`	`changeValue(JGoDocumentChangedEdit e, boolean undo)` Handle undo and redo changes.
`protected abstract void`	`computePath(java.awt.geom.GeneralPath path)` Determines the main path of the AbstractGraduatedScale.
`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)` Make sure the JGoText object that is the LabelTemplate is copied.
`void`	`expandRectByPenWidth(java.awt.Rectangle rect)` The paint bounds needs to include tick marks and labels.
`protected void`	`geometryChange(java.awt.Rectangle old)` Whenever the size and/or position is changed, we need to recalculate the GeneralPath.
`abstract boolean`	`getIntersectionWithLine(java.awt.geom.Point2D.Float p1, java.awt.geom.Point2D.Float p2, DoubleRef outval)` Finds the value that corresponds to the point where the scale and the line defined by p1 and p2 intersect.
`abstract java.awt.Point`	`getLabelCenter(double val, boolean drawLeft)` Returns the point at which the Label should be centered.
`int`	`getLabelDistance()` Gets the distance at which labels are centered away from the tick mark.
`java.lang.String`	`getLabelFormat()` Gets the format string for formatting label values.
`int`	`getLabelFrequency()` Gets how often to label major tick marks.
`java.lang.String`	`getLabelString(double val)` Returns the text string that a label marking the given value would contain.
`int`	`getLabelStyle()` Gets the layout style with which the tick labels are drawn.
`JGoText`	`getLabelTemplate()` Gets the instance of a JGoText that contains the font, size, and other text properties used when drawing labels.
`protected double`	`getLength()` Gets the length of the scale, in document units.
`double`	`getMaximum()` Gets the maximum value represented on the AbstractGraduatedScale.
`double`	`getMinimum()` Gets the minimum value represented on the AbstractGraduatedScale.
`static boolean`	`getNearestIntersectionOnLine(float Ax, float Ay, float Bx, float By, float Px, float Py, float Qx, float Qy, java.awt.geom.Point2D.Float R)`
`static boolean`	`getNearestPointOnLine(float Ax, float Ay, float Bx, float By, float Px, float Py, java.awt.geom.Point2D.Float R)`
`java.awt.geom.GeneralPath`	`getPath()` Get a cached GeneralPath that is produced by a call to makePath.
`abstract java.awt.geom.Point2D.Float`	`getPointForValue(double v)` Returns a point that represents the given value.
`double`	`getRange()` Gets the range of values represented by the AbstractGraduatedScale.
`double`	`getTickBase()` Gets the base value which is marked with a tick.
`java.awt.Color`	`getTickColor()` Gets the color used to draw tick marks.
`abstract void`	`getTickEnds(double v, boolean isMajor, java.awt.geom.Point2D.Float outp1, java.awt.geom.Point2D.Float outp2)` Finds the two end points of the tick mark for a given value.
`float`	`getTickLengthLeft()` Gets the length that each minor tick is drawn to the left of the AbstractGraduatedScale's path, as seen when drawing from the Minimum value to the Maximum value.
`float`	`getTickLengthRight()` Gets the length that each minor tick is drawn to the right of the scale's path, as seen when drawing from the Minimum value to the Maximum value.
`int`	`getTickMajorFrequency()` Gets when to draw emphasized tick marks.
`float`	`getTickMajorLengthRatio()` Gets the relative length of major tick marks compared to minor ones.
`int`	`getTickMajorWidth()` Gets the pen width of major tick marks.
`double`	`getTickUnit()` Gets the difference between two consecutive values marked by minor ticks.
`int`	`getTickWidth()` Gets the pen width of the tick marks.
`abstract double`	`getValueAtPoint(java.awt.geom.Point2D.Float p)` Returns the value which would be represented at a given point.
`static boolean`	`isDefaultBufferingImage()` This is true when the appearance of all AbstractGraduatedScales, including labels, may be cached in an image, for painting efficiency.
`boolean`	`isTickLabels()` Gets whether to draw tick labels at major tick marks.
`java.awt.geom.GeneralPath`	`makePath()` Make sure that whenever we reconstruct the main GeneralPath for this shape, we also reconstruct the paths for the ticks.
`void`	`paint(java.awt.Graphics2D g, JGoView view)` Render this object to a Graphics2D object.
`void`	`paintLabel(java.awt.Graphics2D g, JGoView view, java.awt.Point p, java.lang.String text)` This method is responsible for properly painting a label for the given value parameter.
`protected void`	`resetPath()` Clear any cached GeneralPath.
`static void`	`setDefaultBufferingImage(boolean b)` Enable more efficient painting by caching an image of the scale, including any labels.
`void`	`setLabelDistance(int value)` Sets the distance at which labels are centered away from the tick mark.
`void`	`setLabelFormat(java.lang.String value)` Sets the format string for formatting label values.
`void`	`setLabelFrequency(int value)` Set how often to label major tick marks.
`void`	`setLabelStyle(int value)` Sets the layout style with which the tick labels are drawn.
`void`	`setLabelTemplate(JGoText value)` Sets the instance of a JGoText that contains the font, size, and other text properties used when drawing labels.
`void`	`setMaximum(double value)` Sets the maximum value represented on the AbstractGraduatedScale.
`void`	`setMinimum(double value)` Sets the minimum value represented on the AbstractGraduatedScale.
`void`	`setTickBase(double value)` Sets the base value which is marked with a tick.
`void`	`setTickColor(java.awt.Color value)` Sets the color used to draw tick marks.
`void`	`setTickLabels(boolean value)` Sets whether to draw tick labels at major tick marks.
`void`	`setTickLengthLeft(float value)` Sets the length that each minor tick is drawn to the left of the AbstractGraduatedScale's path, as seen when drawing from the Minimum value to the Maximum value.
`void`	`setTickLengthRight(float value)` Sets the length that each minor tick is drawn to the right of the scale's path, as seen when drawing from the Minimum value to the Maximum value.
`void`	`setTickMajorFrequency(int value)` Sets when to draw emphasized tick marks.
`void`	`setTickMajorLengthRatio(float value)` Sets the relative length of major tick marks compared to minor ones.
`void`	`setTickMajorWidth(int value)` Sets the pen width of major tick marks.
`void`	`setTickUnit(double value)` Sets the difference between two consecutive values marked by minor ticks.
`void`	`setTickWidth(int value)` Sets the pen width of the tick marks.
`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.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, doUncapturedMouseMove, findCommonParent, foredate, gainedSelection, geometryChangeChild, 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, 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, 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

LabelStyleLeft

public static final int LabelStyleLeft

A style for the layout of tick labels for AbstractGraduatedScale.

All ticks are labeled on the end that is left of the AbstractGraduatedScale's path.

See Also:: Constant Field Values

LabelStyleRight

public static final int LabelStyleRight

A style for the layout of tick labels for AbstractGraduatedScale.

All ticks are labeled on the end that is right of the AbstractGraduatedScale's path.

See Also:: Constant Field Values

LabelStyleAlternateStartLeft

public static final int LabelStyleAlternateStartLeft

A style for the layout of tick labels for AbstractGraduatedScale.

Alternates which side of the tick gets labeled. The first label tick is labeled to the left.

See Also:: Constant Field Values

LabelStyleAlternateStartRight

public static final int LabelStyleAlternateStartRight

A style for the layout of tick labels for AbstractGraduatedScale.

Alternates which side of the tick gets labeled. The first label tick is labeled to the right.

See Also:: Constant Field Values