com.steema.teechart.styles
Class CustomPoint

java.lang.Object
  com.steema.teechart.TeeBase
      com.steema.teechart.styles.Series
          com.steema.teechart.styles.CustomPoint

All Implemented Interfaces:

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

Direct Known Subclasses:

Custom, Points

public class CustomPoint
extends Series

Title: CustomPoint class

Description: Base Series class inherited by a number of TeeChart series styles.

Copyright (c) 2005-2008 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

protected CustomStack	iStacked
protected ChartPen	linePen
protected SeriesPointer	point
protected TreatNullsStyle	treatnulls

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

CustomPoint()

CustomPoint(IBaseChart c)

Method Summary

void	addSeriesMouseListener(SeriesMouseListener l)
void	assign(Series source) Copies all properties from one Series component to another.
void	calcHorizMargins(Margins margins) Returns the number of pixels for horizontal margins
protected double	calcMinMaxValue(boolean isMin)
void	calcVerticalMargins(Margins margins) Returns the number of pixels for vertical margins
int	calcXPos(int valueIndex) Returns horizontal screen position for a given point.
int	calcYPos(int valueIndex) Returns vertical screen position for a given point.
void	calcZOrder()
int	clicked(int x, int y) Returns the ValueIndex of the "clicked" point in the Series.
boolean	clickedPointer(int valueIndex, int tmpX, int tmpY, int x, int y) For internal use
protected void	drawLegendShape(IGraphics3D g, int valueIndex, Rectangle rect)
protected void	drawMark(int valueIndex, java.lang.String s, SeriesMarksPosition position)
void	drawPointer(int aX, int aY, Color aColor, int valueIndex) Draws series pointer to the Canvas.
void	drawValue(int valueIndex) Called internally.
ChartPen	getLinePen() Determines pen to draw the line connecting all points.
double	getMaxXValue() Returns the Maximum Value of the Series X Values List.
double	getMaxYValue() Returns the Maximum Value of the Series Y Values List.
double	getMinXValue() Returns the Minimum Value of the Series X Values List.
double	getMinYValue() Returns the Minimum Value of the Series Y Values List.
protected int	getOriginPos(int valueIndex)
SeriesPointer	getPointer() Defines all necessary properties of the Series Pointer.
CustomStack	getStacked() Defines how multiple series will be displayed.
TreatNullsStyle	getTreatNulls() Defines how null points are treated.
protected PointerStyle	onGetPointerStyle(int valueIndex, PointerStyle style)
void	removePointerStyleResolver()
void	removeSeriesMouseListener(SeriesMouseListener l)
protected boolean	sameClassOrigin(Series s)
void	setChart(IBaseChart c) Chart associated with this object.
void	setPointerStyleResolver(PointerStyleResolver resolver)
void	setStacked(CustomStack value) Defines how multiple series will be displayed.
void	setTreatNulls(TreatNullsStyle value)

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, add, addChartValue, added, addedValue, addNull, addNullXY, addSampleValues, addSeriesPaintListener, addValues, assignDispose, assignValues, associatedToAxis, beginUpdate, calcFirstLastVisibleIndex, calcPercentSt, calcPosValue, calculateMarkPosition, calcXPosValue, calcXSizeValue, calcYPosValue, calcYSizeValue, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clear, clearLists, clicked, clone, cloneSeries, convertArray, countLegendItems, createNewSeries, createNewSeries, createSubGallery, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawChart, doBeforeDrawValues, doClick, doClickPointer, doDoubleClick, draw, drawLegend, drawLegend, drawMarks, drawMarksSeries, drawSeries, drawSeriesForward, drawValuesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, firstDisplayed, galleryChanged3D, getActive, getAllowSinglePoint, getBitmapEditor, getBrush, getColor, getColorEach, getColorMember, getColors, getCount, getCountLegendItems, getCursor, getCustomHorizAxis, getCustomVertAxis, getDataSource, getDefaultColor, getDefaultNullValue, getDepth, getDescription, getEndZ, getFields, getFirstVisible, getFunction, getHasZValues, getHorizAxis, getHorizontalAxis, getLabelMember, getLabels, getLastVisible, getLegendString, getMandatory, getMandatoryAxis, getMarks, getMarkText, getMarkValue, getMaxZValue, getMiddleZ, 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, hasClickEvents, hasDataSource, hasListenersOf, hasNoMandatoryValues, isNull, isPointInChartRect, isValidSeriesSource, isValidSourceOf, lastDisplayed, lastVisibleMark, legendItemColor, legendToValueIndex, maxMarkWidth, moreSameZOrder, mouseEvent, newFromType, numSampleValues, onDisposing, prepareForGallery, prepareLegendCanvas, randomBounds, readResolve, recalcGetAxis, refreshSeries, removeMarkTextResolver, removeSeriesPaintListener, repaint, sameClass, setActive, setColor, setColorEach, setColorMember, setColors, setCursor, setCustomHorizAxis, setCustomHorizAxis, setCustomVertAxis, setCustomVertAxis, setDataSource, setDefaultNullValue, setDepth, setEndZ, setFunction, setHorizontal, setHorizontalAxis, setLabelMember, setLabels, setMarks, setMarkTextResolver, setMiddleZ, setNull, 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, 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

Field Detail

point

protected SeriesPointer point

iStacked

protected CustomStack iStacked

linePen

protected ChartPen linePen

treatnulls

protected TreatNullsStyle treatnulls

Constructor Detail

CustomPoint

public CustomPoint()

CustomPoint

public CustomPoint(IBaseChart c)

Method Detail

assign

public void assign(Series source)

Description copied from class: Series

Copies all properties from one Series component to another.
Only the common properties shared by both source and destination Series are copied.
The following code copies all properties from Series2 into Series1:

Series1.Assign( Series2 ) ;

Some Series types restore method values after assigning them. For example, Points series restores the Pointer.Visible method to true after being assigned to a Line series, which has Pointers invisible by default.
Note: Series events are not assigned. Series DataSource and FunctionType properties are assigned. Assign is used by CloneChartSeries and ChangeSeriesType methods for example.

Parameters:

source - Series

addSeriesMouseListener

public void addSeriesMouseListener(SeriesMouseListener l)

Overrides:

addSeriesMouseListener in class Series

removeSeriesMouseListener

public void removeSeriesMouseListener(SeriesMouseListener l)

Overrides:

removeSeriesMouseListener in class Series

setPointerStyleResolver

public void setPointerStyleResolver(PointerStyleResolver resolver)

removePointerStyleResolver

public void removePointerStyleResolver()

getStacked

public CustomStack getStacked()

Defines how multiple series will be displayed.

Stacking options of Points series are:

CustomSeriesStack.None: No overlap action. All Series displayed in individual Z space
CustomSeriesStack.Overlap: Series displayed in same Z space (all Series take same ZOrder position). This will result in overpainting of equal Series points.
CustomSeriesStack.Stack: Stack Series one above the other. Series begin with lowest index order at bottom, further Series are then plotted above in their respective indexed order with each point taking the cumulative value of lower points as their starting value.
CustomSeriesStack.Stack100: Plots take up full Bottom to Top space of the Chart Area resulting in a percentage division by Area to reflect Series values. The Y displacement below each line equates to its percentage value of total. Thus the Last Line will be parallel with/at the top of the Chart and the area below that line reflects its percentage proportion.
Default value: CustomStack.None

Returns:

CustomStack

setStacked

public void setStacked(CustomStack value)

Defines how multiple series will be displayed. Default value: CustomStack.None

Parameters:

value - CustomStack

getPointer

public SeriesPointer getPointer()

Defines all necessary properties of the Series Pointer.
It is a subclass of Points series, Line series and all other derived Points series classes like Bubble series.
Each point in a Points series is drawn using the Pointer properties.
Pointer contains several methods to control the formatting attributes of Points like Pen, Brush, Draw3D, Visible, etc.
Default value: Null

Returns:

SeriesPointer

setChart

public void setChart(IBaseChart c)

Description copied from class: TeeBase

Chart associated with this object.

Specified by:

setChart in interface ISeries

Parameters:

c - IBaseChart

sameClassOrigin

protected boolean sameClassOrigin(Series s)

onGetPointerStyle

protected PointerStyle onGetPointerStyle(int valueIndex,
                                         PointerStyle style)

calcHorizMargins

public void calcHorizMargins(Margins margins)

Description copied from class: Series

Returns the number of pixels for horizontal margins

Overrides:

calcHorizMargins in class Series

Parameters:

margins - Margins

calcVerticalMargins

public void calcVerticalMargins(Margins margins)

Description copied from class: Series

Returns the number of pixels for vertical margins

Overrides:

calcVerticalMargins in class Series

Parameters:

margins - Margins

calcZOrder

public void calcZOrder()

Overrides:

calcZOrder in class Series

clickedPointer

public boolean clickedPointer(int valueIndex,
                              int tmpX,
                              int tmpY,
                              int x,
                              int y)

For internal use

Parameters:

valueIndex - int

tmpX - int

tmpY - int

x - int

y - int

Returns:

boolean

drawLegendShape

protected void drawLegendShape(IGraphics3D g,
                               int valueIndex,
                               Rectangle rect)

Overrides:

drawLegendShape in class Series

drawMark

protected void drawMark(int valueIndex,
                        java.lang.String s,
                        SeriesMarksPosition position)

Overrides:

drawMark in class Series

drawPointer

public void drawPointer(int aX,
                        int aY,
                        Color aColor,
                        int valueIndex)

Draws series pointer to the Canvas. It displays a pointer at the specified px and py screen pixel coordinates with the tmpHoriz and tmpVert size dimensions.

Parameters:

aX - int

aY - int

aColor - Color

valueIndex - int

calcYPos

public int calcYPos(int valueIndex)

Returns vertical screen position for a given point. This coordinate is calculated using the Series associated Vertical Axis.

Overrides:

calcYPos in class Series

Parameters:

valueIndex - int

Returns:

int

calcXPos

public int calcXPos(int valueIndex)

Returns horizontal screen position for a given point. This coordinate is calculated using the Series associated Horizontal Axis.

Overrides:

calcXPos in class Series

Parameters:

valueIndex - int

Returns:

int

getOriginPos

protected int getOriginPos(int valueIndex)

drawValue

public void drawValue(int valueIndex)

Called internally. Draws the "ValueIndex" point of the Series.

Specified by:

drawValue in interface ISeries

Overrides:

drawValue in class Series

Parameters:

valueIndex - int

clicked

public int clicked(int x,
                   int y)

Returns the ValueIndex of the "clicked" point in the Series.

Specified by:

clicked in interface ISeries

Overrides:

clicked in class Series

Parameters:

x - int

y - int

Returns:

int

getMaxXValue

public double getMaxXValue()

Returns the Maximum Value of the Series X Values List.

Overrides:

getMaxXValue in class Series

Returns:

double

getMinXValue

public double getMinXValue()

Returns the Minimum Value of the Series X Values List.

Overrides:

getMinXValue in class Series

Returns:

double

getMaxYValue

public double getMaxYValue()

Returns the Maximum Value of the Series Y Values List.

Overrides:

getMaxYValue in class Series

Returns:

double

getMinYValue

public double getMinYValue()

Returns the Minimum Value of the Series Y Values List.

Overrides:

getMinYValue in class Series

Returns:

double

calcMinMaxValue

protected double calcMinMaxValue(boolean isMin)

getLinePen

public ChartPen getLinePen()

Determines pen to draw the line connecting all points.

Returns:

ChartPen

getTreatNulls

public TreatNullsStyle getTreatNulls()

Defines how null points are treated.

Returns:

TreatNullsStyle

setTreatNulls

public void setTreatNulls(TreatNullsStyle value)