com.steema.teechart.styles
Class HighLow

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.styles.Series
          extended by com.steema.teechart.styles.HighLow
All Implemented Interfaces:
ISeries

public class HighLow
extends Series

Title: Highlow class

Description: HighLow Series.

Example:


 series = new HighLow(myChart.getChart());
 series.fillSampleValues(20);
 series.setColor(Color.RED);
 series.getHighBrush().setColor(Color.LIME);
 series.getHighPen().setColor(Color.BLUE);
 series.getHighPen().setWidth(2);
 series.getLowBrush().setColor(Color.WHITE);
 series.getPen().setColor(Color.BLUE);
 series.setCursor(new Cursor(Cursor.CROSSHAIR_CURSOR));

 highFillButton = new JButton("High Fill...");
 lowFillButton = new JButton("Low Fill...");
 highButton = new ButtonPen(series.getHighPen(), "High...");
 lowButton = new ButtonPen(series.getLowPen(), "Low...");
 linesButton = new ButtonPen(series.getPen(), "Lines...");
 

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

Company: Steema Software SL


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.Series
AUTODEPTH, AUTOZORDER, bActive, bBrush, bColorEach, calcVisiblePoints, colorMember, customMarkText, drawBetweenPoints, endZ, firstVisible, hasZValues, iColors, 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, InternalUse
 
Constructor Summary
HighLow()
           
HighLow(IBaseChart c)
           
 
Method Summary
 int Add(double x, double h, double l)
          Adds a new High and Low value to a HighLow series.
 int Add(double x, double h, double l, Color color)
          Adds a new High and Low value to a HighLow series.
 int Add(double x, double h, double l, java.lang.String text)
          Adds a new High and Low value to a HighLow series and label.
 int Add(double x, double h, double l, java.lang.String text, Color color)
          Adds a new High and Low value to a HighLow series with label and color.
protected  void addSampleValues(int numValues)
           
 void createSubGallery(Gallery addSubChart)
           
 void drawValue(int valueIndex)
          Called internally.
 java.lang.String getDescription()
          Gets descriptive text.
 ChartBrush getHighBrush()
          Defines the Brush for the High value.
 ChartPen getHighPen()
          Defines the Pen for the High value.
 ValueList getHighValues()
           
 ChartBrush getLowBrush()
          Defines the Brush for the Low value.
 ChartPen getLowPen()
          Defines the Pen for the Low value.
 ValueList getLowValues()
           
 double getMaxYValue()
          The Maximum Value of the Series Y Values List.
 double getMinYValue()
          The Minimum Value of the Series Y Values List.
 ChartPen getPen()
          Sets the Pen to draw the vertical dividing lines of the HighLow series.
 boolean isValidSourceOf(ISeries value)
          True if Series source is HighLow.
 void setChart(IBaseChart c)
          Chart associated with this object.
 void setSubGallery(int index)
          Creates and prepares the index'th Series style to show at sub-gallery dialog.
 
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, add, addChartValue, added, addedValue, addNull, addNullXY, addSeriesMouseListener, addSeriesPaintListener, addValues, assign, assignDispose, assignValues, associatedToAxis, beginUpdate, calcFirstLastVisibleIndex, calcHorizMargins, calcPercentSt, calcPosValue, calculateMarkPosition, calcVerticalMargins, calcXPos, calcXPosValue, calcXSizeValue, calcYPos, calcYPosValue, calcYSizeValue, calcZOrder, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clear, clearLists, clicked, clicked, clone, cloneSeries, convertArray, countLegendItems, createNewSeries, createNewSeries, createNewSeries, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawChart, doBeforeDrawValues, doClick, doClickPointer, doDoubleClick, draw, drawHiddenValue, drawLegend, drawLegend, drawLegendShape, drawMark, drawMarks, drawMarksSeries, drawSeries, drawSeriesForward, drawValuesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, firstDisplayed, galleryChanged3D, getActive, getAllowSinglePoint, getBrush, getColor, getColorEach, getColorMember, getColors, getCount, getCountLegendItems, getCursor, getCustomHorizAxis, getCustomVertAxis, getDataSource, getDefaultColor, getDefaultNullValue, getDepth, getEndZ, getFields, getFirstVisible, getFunction, getHasZValues, getHorizAxis, getHorizontalAxis, getLabelMember, getLabels, getLastVisible, getLegendString, getMandatory, getMandatoryAxis, getMarks, getMarkText, getMarkValue, getMaxXValue, getMaxZValue, getMiddleZ, getMinXValue, 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, removeSeriesMouseListener, 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, setTitle, setValueFormat, setValueList, setVerticalAxis, setVisible, setXValues, setYValues, setZOrder, setZPositions, sortByLabels, sortByLabels, swapValueIndex, titleOrName, toString, valueListOfAxis, 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
 

Constructor Detail

HighLow

public HighLow()

HighLow

public HighLow(IBaseChart c)
Method Detail

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 Series
Parameters:
c - IBaseChart

getPen

public ChartPen getPen()
Sets the Pen to draw the vertical dividing lines of the HighLow series.

Returns:
ChartPen

getHighPen

public ChartPen getHighPen()
Defines the Pen for the High value.

Returns:
ChartPen

getLowPen

public ChartPen getLowPen()
Defines the Pen for the Low value.

Returns:
ChartPen

getLowBrush

public ChartBrush getLowBrush()
Defines the Brush for the Low value.

Returns:
ChartBrush

getHighBrush

public ChartBrush getHighBrush()
Defines the Brush for the High value.

Returns:
ChartBrush

getHighValues

public ValueList getHighValues()

getLowValues

public ValueList getLowValues()

addSampleValues

protected void addSampleValues(int numValues)
Overrides:
addSampleValues in class Series

Add

public int Add(double x,
               double h,
               double l)
Adds a new High and Low value to a HighLow series.

Parameters:
x - double
h - double
l - double
Returns:
int

Add

public int Add(double x,
               double h,
               double l,
               Color color)
Adds a new High and Low value to a HighLow series.

Parameters:
x - double
h - double
l - double
color - Color
Returns:
int

Add

public int Add(double x,
               double h,
               double l,
               java.lang.String text)
Adds a new High and Low value to a HighLow series and label.

Parameters:
x - double
h - double
l - double
text - String
Returns:
int

Add

public int Add(double x,
               double h,
               double l,
               java.lang.String text,
               Color color)
Adds a new High and Low value to a HighLow series with label and color.

Parameters:
x - double
h - double
l - double
text - String
color - Color
Returns:
int

createSubGallery

public void createSubGallery(Gallery addSubChart)
Overrides:
createSubGallery in class Series

setSubGallery

public void setSubGallery(int index)
Description copied from class: Series
Creates and prepares the index'th Series style to show at sub-gallery dialog.

Specified by:
setSubGallery in interface ISeries
Overrides:
setSubGallery in class Series
Parameters:
index - int

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

isValidSourceOf

public boolean isValidSourceOf(ISeries value)
True if Series source is HighLow.
Returns false if the Value parameter is the same as Self.
It's used to validate the DataSource method both at design and run-time.

Parameters:
value - ISeries
Returns:
boolean

getMaxYValue

public double getMaxYValue()
The Maximum Value of the Series Y Values List.

Overrides:
getMaxYValue in class Series
Returns:
double

getMinYValue

public double getMinYValue()
The Minimum Value of the Series Y Values List.

Overrides:
getMinYValue in class Series
Returns:
double

getDescription

public java.lang.String getDescription()
Gets descriptive text.

Overrides:
getDescription in class Series
Returns:
String