com.steema.teechart.styles
Class Custom

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Area, Bezier, Line, OHLC, Volume

public class Custom
extends CustomPoint

Title: Custom class

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

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

protected ChartBrush	bAreaBrush
protected boolean	bClickableLine
protected boolean	bDark3D
protected boolean	drawArea
protected boolean	drawLine
protected ChartPen	linePen
protected ChartPen	pAreaLines

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

iStacked, point

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

Custom()

Custom(IBaseChart c)

Method Summary

void	calcHorizMargins(Margins margins) Returns the number of pixels for horizontal margins
void	calcVerticalMargins(Margins margins) Returns the number of pixels for vertical margins
int	clicked(int x, int y) Calculates if any point is at XY position.
protected void	draw()
protected void	drawLegendShape(IGraphics3D g, int valueIndex, Rectangle rect)
void	drawValue(int valueIndex) Called internally.
protected Color	getAreaBrushColor(Color c)
ChartBrush	getBrush() Sets Brush characteristics.
boolean	getClickableLine() Allows mouse clicks over the line drawn between points.
boolean	getColorEachLine() Enables/Disables the coloring of each connecting line of a series.
boolean	getDark3D() Darkens parts of 3D Line Series to add depth.
boolean	getInvertedStairs() Changes the direction of the step, when true.
int	getLineHeight() The vertical thickness of the line in pixels.
ChartPen	getLinePen() Determines pen to draw the line connecting all points.
int	getOpacity() Opacity level from 0 to 100%
ChartPen	getOutLine() Pen for Series Line's outer pen.
boolean	getStairs() Steps line joining adjacent points.
int	getTransparency() Transparency level from 0 to 100% Default value: 0
protected java.lang.Object	readResolve()
void	setChart(IBaseChart c) Chart associated with this object.
void	setClickableLine(boolean value) Allows mouse clicks over the line drawn between points.
void	setColor(Color value) Default color for all points.
void	setColorEachLine(boolean value) Enables/Disables the coloring of each connecting line of a series.
void	setDark3D(boolean value) Darkens parts of 3D Line Series to add depth.
void	setInvertedStairs(boolean value) Changes the direction of the step, when true.
void	setLineHeight(int value) Sets the vertical thickness of the line in pixels.
void	setOpacity(int value) Sets Opacity level from 0 to 100%
void	setStairs(boolean value) Steps line joining adjacent points.
void	setTransparency(int value) Sets Transparency level from 0 to 100% Default value: 0

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

addSeriesMouseListener, assign, calcXPos, calcYPos, calcZOrder, clickedPointer, drawMark, drawPointer, getMaxXValue, getMaxYValue, getMinXValue, getMinYValue, getOriginPos, getPointer, getStacked, onGetPointerStyle, removePointerStyleResolver, removeSeriesMouseListener, setPointerStyleResolver, setStacked

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, addSampleValues, addSeriesPaintListener, addValues, assignDispose, assignValues, associatedToAxis, beginUpdate, calcFirstLastVisibleIndex, calcPosValue, calcXPosValue, calcXSizeValue, calcYPosValue, calcYSizeValue, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clear, clearLists, clicked, clone, cloneSeries, convertArray, createNewSeries, createNewSeries, createSubGallery, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawChart, doBeforeDrawValues, doClick, doClickPointer, doDoubleClick, drawLegend, drawLegend, drawMarks, drawSeries, drawSeriesForward, drawValuesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, galleryChanged3D, getActive, getAllowSinglePoint, getBitmapEditor, getColor, getColorEach, getColorMember, getColors, getCount, getCountLegendItems, getCursor, getCustomHorizAxis, getCustomVertAxis, getDataSource, getDepth, getDescription, getEndZ, getFields, getFirstVisible, getFunction, getHasZValues, getHorizAxis, getHorizontalAxis, getLabelMember, getLabels, getLastVisible, getLegendString, getMandatory, 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, hasDataSource, hasListenersOf, hasNoMandatoryValues, isNull, isValidSeriesSource, isValidSourceOf, legendItemColor, legendToValueIndex, maxMarkWidth, moreSameZOrder, mouseEvent, newFromType, numSampleValues, onDisposing, paintLegend, prepareForGallery, prepareLegendCanvas, randomBounds, recalcGetAxis, refreshSeries, removeMarkTextResolver, removeSeriesPaintListener, repaint, sameClass, setActive, 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

Field Detail

bAreaBrush

protected ChartBrush bAreaBrush

pAreaLines

protected ChartPen pAreaLines

bClickableLine

protected boolean bClickableLine

bDark3D

protected boolean bDark3D

drawArea

protected boolean drawArea

drawLine

protected boolean drawLine

linePen

protected ChartPen linePen

Constructor Detail

Custom

public Custom()

Custom

public Custom(IBaseChart c)

Method Detail

readResolve

protected java.lang.Object readResolve()

Overrides:

readResolve in class Series

getClickableLine

public boolean getClickableLine()

Allows mouse clicks over the line drawn between points.
Default value: true

Returns:

boolean

setClickableLine

public void setClickableLine(boolean value)

Allows mouse clicks over the line drawn between points.
Default value: true

Parameters:

value - boolean

getOpacity

public int getOpacity()

Opacity level from 0 to 100%

Returns:

int

setOpacity

public void setOpacity(int value)

Sets Opacity level from 0 to 100%

Parameters:

value - int

getTransparency

public int getTransparency()

Transparency level from 0 to 100%
Default value: 0

Returns:

int

setTransparency

public void setTransparency(int value)

Sets Transparency level from 0 to 100%
Default value: 0

Parameters:

value - int

getBrush

public ChartBrush getBrush()

Sets Brush characteristics.

Returns:

ChartBrush

getDark3D

public boolean getDark3D()

Darkens parts of 3D Line Series to add depth.
Default value: true

Returns:

boolean

setDark3D

public void setDark3D(boolean value)

Darkens parts of 3D Line Series to add depth.
Default value: true

Parameters:

value - boolean

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 CustomPoint

Parameters:

c - IBaseChart

setColor

public void setColor(Color value)

Description copied from class: Series

Default color for all points.
Default value: Color.Empty

Overrides:

setColor in class Series

Parameters:

value - Color

See Also:

Series.getColorEach()

getStairs

public boolean getStairs()

Steps line joining adjacent points.
In most normal situations, a series draws a line between each Line point. This makes the Line appear as a "mountain" shape. However, setting Stairs to true will make the Series draw 2 Lines between each pair of points, thus giving a "stair" appearance.
This is most used in some financial Chart representations.
When Stairs is set to true you may set InvertedStairs to true to alter the direction of the step.
Default value: false

Returns:

boolean

setStairs

public void setStairs(boolean value)

Steps line joining adjacent points.
Default value: false

Parameters:

value - boolean

See Also:

getStairs()

getColorEachLine

public boolean getColorEachLine()

Enables/Disables the coloring of each connecting line of a series.
Default value: true

Returns:

boolean

setColorEachLine

public void setColorEachLine(boolean value)

Enables/Disables the coloring of each connecting line of a series.
Default value: true

Parameters:

value - boolean

getInvertedStairs

public boolean getInvertedStairs()

Changes the direction of the step, when true.
Default value: false

Returns:

boolean

setInvertedStairs

public void setInvertedStairs(boolean value)

Changes the direction of the step, when true.
Default value: false

Parameters:

value - boolean

getOutLine

public ChartPen getOutLine()

Pen for Series Line's outer pen.
Default value: null

Returns:

ChartPen

getLineHeight

public int getLineHeight()

The vertical thickness of the line in pixels.
Default value: 0

Returns:

int

setLineHeight

public void setLineHeight(int value)

Sets the vertical thickness of the line in pixels.
Default value: 0

Parameters:

value - int

calcHorizMargins

public void calcHorizMargins(Margins margins)

Description copied from class: Series

Returns the number of pixels for horizontal margins

Overrides:

calcHorizMargins in class CustomPoint

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 CustomPoint

Parameters:

margins - Margins

clicked

public int clicked(int x,
                   int y)

Calculates if any point is at XY position.

Specified by:

clicked in interface ISeries

Overrides:

clicked in class CustomPoint

Parameters:

x - int

y - int

Returns:

int Point index

draw

protected void draw()

Overrides:

draw in class Series

getAreaBrushColor

protected Color getAreaBrushColor(Color c)

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 CustomPoint

Parameters:

valueIndex - int

drawLegendShape

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

Overrides:

drawLegendShape in class CustomPoint

getLinePen

public ChartPen getLinePen()

Determines pen to draw the line connecting all points.

Returns:

ChartPen