com.steema.teechart.styles
Class Gauges

java.lang.Object
  com.steema.teechart.TeeBase
      com.steema.teechart.styles.Series
          com.steema.teechart.styles.Circular
              com.steema.teechart.styles.Gauges

All Implemented Interfaces:

ISeries, java.io.Serializable, java.lang.Cloneable

public class Gauges
extends Circular

Title: Gauges class

Description: Gauges Series.

Copyright (c) 2005-2006 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.steema.teechart.styles.Series

Series.MarkTextResolver

Field Summary

Fields inherited from class com.steema.teechart.styles.Circular

iCircleXCenter, iCircleYCenter, iXRadius, iYRadius, PIDEGREE, rCircleRect, rotDegree

Fields inherited from class com.steema.teechart.styles.Series

AUTODEPTH, AUTOZORDER, bActive, bBrush, bColorEach, calcVisiblePoints, colorMember, customMarkText, drawBetweenPoints, endZ, firstVisible, hasZValues, iColors, InternalUse, iNumSampleValues, iZOrder, labelMember, lastVisible, listenerList, mandatory, manualData, marks, middleZ, notMandatory, percentDecimal, percentFormat, sLabels, startZ, useAxis, useSeriesColor, valueFormat, vxValues, vyValues, yMandatory

Fields inherited from class com.steema.teechart.TeeBase

chart

Constructor Summary

Gauges()

Gauges(IBaseChart c)

Method Summary

void	addChangeListener(javax.swing.event.ChangeListener l)
protected void	addSampleValues(int numValues)
protected void	draw()
protected void	fireChange()
SeriesPointer	getCenter() Returns a sub-object with properties that control the appearance of a shape at the middle of gauge.
java.lang.String	getDescription() Gets descriptive text.
SeriesPointer	getEndPoint() Returns a sub-object with properties that control the appearance of a shape at the end of the gauge arrow.
int	getHandDistance() The amount in pixels that define a gap between the gauge axis and the end of the gauge arrow line.
HandStyle	getHandStyle() Style of Gauge hand.
boolean	getLabelsInside() Defines where to display gauge axis labels.
double	getMaximum() The maximum value for the gauge.
double	getMinimum() The minimum value for the gauge.
int	getMinorTickDistance() Set to a value bigger than zero to display the axis minor ticks (ticks inside normal ticks) displaced from the axis line the specified number of pixels.
ChartPen	getPen() Line pen for Gauge.
double	getTotalAngle() Controls the size in degrees for the gauge axis.
double	getValue() Gets or sets the position of gauge arrow line.
void	prepareForGallery(boolean isEnabled)
void	removeChangeListener(javax.swing.event.ChangeListener l)
void	setChart(IBaseChart c) Chart associated with this object.
void	setHandDistance(int value) Sets the amount in pixels that define a gap between the gauge axis and the end of the gauge arrow line.
void	setHandStyle(HandStyle value) Sets the Style of Gauge hand.
void	setLabelsInside(boolean value) Defines where to display gauge axis labels.
void	setMaximum(double value) Sets the maximum value for the gauge.
void	setMinimum(double value) Sets the minimum value for the gauge.
void	setMinorTickDistance(int value) Sets the number of pixels to displace the axis minor ticks from the axis line.
void	setTotalAngle(double value) Controls the size in degrees for the gauge axis.
void	setValue(double value) Sets the position of gauge arrow line.

Methods inherited from class com.steema.teechart.styles.Circular

adjustCircleRect, angleToPos, associatedToAxis, calcCircleBackColor, calcCircleGradient, calcRadius, doBeforeDrawValues, getCircleBackColor, getCircled, getCircleGradient, getCircleHeight, getCircleRect, getCircleWidth, getCircleXCenter, getCircleYCenter, getCustomXRadius, getCustomYRadius, getRotationAngle, getXRadius, getYRadius, onDisposing, pointToAngle, pointToRadius, prepareLegendCanvas, rotate, setActive, setCircleBackColor, setCircled, setCustomXRadius, setCustomYRadius, setParentProperties, setRotationAngle, shouldSerializeCircleBackColor

Methods inherited from class com.steema.teechart.styles.Series

add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, addChartValue, added, addNull, addNullXY, addSeriesMouseListener, addSeriesPaintListener, addValues, assign, assignDispose, assignValues, beginUpdate, calcFirstLastVisibleIndex, calcHorizMargins, calcPosValue, calcVerticalMargins, calcXPos, calcXPosValue, calcXSizeValue, calcYPos, calcYPosValue, calcYSizeValue, calcZOrder, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clear, clearLists, clicked, clicked, clone, cloneSeries, convertArray, createNewSeries, createNewSeries, createSubGallery, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawChart, doClick, doClickPointer, doDoubleClick, drawLegend, drawLegend, drawLegendShape, drawMark, drawMarks, drawSeries, drawSeriesForward, drawValue, drawValuesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, galleryChanged3D, getActive, getAllowSinglePoint, getBitmapEditor, getColor, getColorEach, getColorMember, getColors, getCount, getCountLegendItems, getCursor, getCustomHorizAxis, getCustomVertAxis, getDataSource, getDepth, getEndZ, getFields, getFirstVisible, getFunction, getHasZValues, getHorizAxis, getHorizontalAxis, getLabelMember, getLabels, getLastVisible, getLegendString, getMandatory, getMarks, getMarkText, getMarkValue, getMaxXValue, getMaxYValue, getMaxZValue, getMiddleZ, getMinXValue, getMinYValue, getMinZValue, getNotMandatory, getNumGallerySeries, getNumSampleValues, getOriginValue, getPercentFormat, getPoint, getSeriesColor, getShowInLegend, getStartZ, getTitle, getUseAxis, getValueColor, getValueFormat, getValueIndexSwapper, getValueList, getValueList, getValueMarkText, getValuesLists, getVertAxis, getVerticalAxis, getVisible, getXValues, getYMandatory, getYValueList, getYValues, getZOrder, hasDataSource, hasListenersOf, hasNoMandatoryValues, isNull, isValidSeriesSource, isValidSourceOf, legendItemColor, legendToValueIndex, maxMarkWidth, moreSameZOrder, mouseEvent, newFromType, numSampleValues, paintLegend, randomBounds, readResolve, recalcGetAxis, refreshSeries, removeMarkTextResolver, removeSeriesMouseListener, removeSeriesPaintListener, repaint, sameClass, setColor, setColorEach, setColorMember, setColors, setCursor, setCustomHorizAxis, setCustomHorizAxis, setCustomVertAxis, setCustomVertAxis, setDataSource, setDepth, setEndZ, setFunction, setHorizontal, setHorizontalAxis, setLabelMember, setLabels, setMarks, setMarkTextResolver, setMiddleZ, setNull, setPercentFormat, setSeriesColor, setShowInLegend, setStartZ, setSubGallery, setTitle, setValueFormat, setValueList, setVerticalAxis, setVisible, setXValues, setYValues, setZOrder, setZPositions, sortByLabels, sortByLabels, swapValueIndex, titleOrName, toString, valuesListAdd, xScreenToValue, yScreenToValue

Methods inherited from class com.steema.teechart.TeeBase

getChart, invalidate, setBooleanProperty, setColorProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.steema.teechart.styles.ISeries

getChart, invalidate

Constructor Detail

Gauges

public Gauges()

Gauges

public Gauges(IBaseChart c)

Method Detail

addChangeListener

public void addChangeListener(javax.swing.event.ChangeListener l)

removeChangeListener

public void removeChangeListener(javax.swing.event.ChangeListener l)

fireChange

protected void fireChange()

getPen

public ChartPen getPen()

Line pen for Gauge.

Returns:

ChartPen

getHandStyle

public HandStyle getHandStyle()

Style of Gauge hand.
The gauge can display its arrow as a simple line ( hsLine style ) or as a filled triangle ( hsTriangle style ).
Default value: hsLine

Returns:

HandStyle

setHandStyle

public void setHandStyle(HandStyle value)

Sets the Style of Gauge hand.
Default value: hsLine

Parameters:

value - HandStyle

getTotalAngle

public double getTotalAngle()

Controls the size in degrees for the gauge axis.
Use together with RotationAngle property.
Default value: 90

Returns:

double

See Also:

Circular.getRotationAngle()

setTotalAngle

public void setTotalAngle(double value)

Controls the size in degrees for the gauge axis.
Default value: 90

Parameters:

value - double

getHandDistance

public int getHandDistance()

The amount in pixels that define a gap between the gauge axis and the end of the gauge arrow line.
Default value: 30

Returns:

int

setHandDistance

public void setHandDistance(int value)

Sets the amount in pixels that define a gap between the gauge axis and the end of the gauge arrow line.
Default value: 30

Parameters:

value - int

getValue

public double getValue()

Gets or sets the position of gauge arrow line.
Must be a number between gauge Minimum and Maximum.
When Value is changed, the gauge arrow is automatically redisplayed at the new position.
FullRepaint controls if the whole chart will be repainted or just the gauge arrow line.
Default value: 0

Returns:

double

setValue

public void setValue(double value)

Sets the position of gauge arrow line.
Default value: 0

Parameters:

value - double

getMinimum

public double getMinimum()

The minimum value for the gauge.
Default value: 0

Returns:

double

setMinimum

public void setMinimum(double value)

Sets the minimum value for the gauge.
Default value: 0

Parameters:

value - double

getMaximum

public double getMaximum()

The maximum value for the gauge.
Default value: 100

Returns:

double

setMaximum

public void setMaximum(double value)

Sets the maximum value for the gauge.
Default value: 100

Parameters:

value - double

getCenter

public SeriesPointer getCenter()

Returns a sub-object with properties that control the appearance of a shape at the middle of gauge.

Returns:

SeriesPointer

getEndPoint

public SeriesPointer getEndPoint()

Returns a sub-object with properties that control the appearance of a shape at the end of the gauge arrow.

Returns:

SeriesPointer

getMinorTickDistance

public int getMinorTickDistance()

Set to a value bigger than zero to display the axis minor ticks (ticks inside normal ticks) displaced from the axis line the specified number of pixels.
Default value: 0 pixels

Returns:

int

setMinorTickDistance

public void setMinorTickDistance(int value)

Sets the number of pixels to displace the axis minor ticks from the axis line.
Default value: 0 pixels

Parameters:

value - int

getLabelsInside

public boolean getLabelsInside()

Defines where to display gauge axis labels. Default value: true

Returns:

boolean

setLabelsInside

public void setLabelsInside(boolean value)

Defines where to display gauge axis labels. Default value: true

Parameters:

value - boolean

addSampleValues

protected void addSampleValues(int numValues)

Overrides:

addSampleValues in class Series

draw

protected void draw()

Overrides:

draw in class Series

setChart

public void setChart(IBaseChart c)

Description copied from class: TeeBase

Chart associated with this object.

Specified by:

setChart in interface ISeries

Overrides:

setChart in class Circular

Parameters:

c - IBaseChart

prepareForGallery

public void prepareForGallery(boolean isEnabled)

Overrides:

prepareForGallery in class Series

getDescription

public java.lang.String getDescription()

Gets descriptive text.

Overrides:

getDescription in class Series

Returns:

String