com.steema.teechart.styles
Class HorizBar

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

public class HorizBar
extends CustomBar

Title: HorizBar class

Description: Horizontal Bar Series.

Example:

 
  barSeries = new HorizBar(myChart.getChart());
  barSeries.setBarStyle(BarStyle.RECTANGLE);
  barSeries.setMultiBar(MultiBars.NONE);
  barSeries.fillSampleValues(3);
 
 

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.CustomBar
CustomBar.BarStyleResolver
 
Nested classes/interfaces inherited from class com.steema.teechart.styles.Series
Series.MarkTextResolver
 
Field Summary
 
Fields inherited from class com.steema.teechart.styles.CustomBar
barSizePercent, bDark3D, bUseOrigin, conePercent, customBarSize, dOrigin, iBarBounds, iBarSize, iMultiBar, iNumBars, iOrderPos, iPreviousCount, marksOnBar, normalBarColor, pPen
 
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
HorizBar()
           
HorizBar(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 calcXPos(int valueIndex)
          The pixel Screen Horizontal coordinate of the ValueIndex Series value.
 int calcYPos(int valueIndex)
          The vertical Bar position is the "real" Y pos plus the Barwidth by our BarSeries order.
protected  void drawMark(int valueIndex, java.lang.String s, SeriesMarksPosition position)
           
protected  boolean drawSeriesForward(int valueIndex)
           
protected  void drawTickLine(int tickPos, BarStyle aStyle)
           
 void drawValue(int valueIndex)
          Called internally.
 int getBarHeightPercent()
          Defines the percent of bar Height, from 0 to 100.
 java.lang.String getDescription()
          Gets descriptive text.
 double getMaxXValue()
          The Maximum Value of the Series X Values List.
 double getMaxYValue()
          The Maximum Value of the Series Y Values List.
 double getMinXValue()
          The Minimum Value of the Series X Values List.
 double getMinYValue()
          The Minimum Value of the Series Y Values Lists.
protected  int getOriginPos(int valueIndex)
           
protected  int internalCalcMarkLength(int valueIndex)
           
protected  boolean internalClicked(int valueIndex, Point point)
           
 void setBarHeightPercent(int value)
          Defines the percent of bar Height, from 0 to 100.
 
Methods inherited from class com.steema.teechart.styles.CustomBar
applyBarOffset, barMargin, barRectangle, barRectangle, calcBarBounds, calcFirstLastVisibleIndex, calcFirstLastVisibleIndex, calcMarkLength, calcZOrder, clicked, createSubGallery, doBarGradient, doBeforeDrawChart, doGetBarStyle, doGradient3D, drawLegendShape, drawTickLines, drawValuesForward, getAutoMarkPosition, getBarBounds, getBarBoundsMidX, getBarStyle, getBrush, getConePercent, getCustomBarWidth, getDark3D, getDepthPercent, getGradient, getGradientRelative, getMarksLocation, getMarksOnBar, getMultiBar, getOffsetPercent, getOrigin, getPen, getSideMargins, getStackGroup, getTickLines, getUseOrigin, getYOrigin, internalApplyBarMargin, internalGetOriginPos, isPointInChartRect, lastVisibleMark, maxMandatoryValue, minMandatoryValue, numSampleValues, pointOrigin, prepareForGallery, removeBarStyleResolver, setAutoMarkPosition, setBarSizePercent, setBarStyle, setBarStyleResolver, setChart, setConePercent, setCustomBarWidth, setDark3D, setDepthPercent, setGradientRelative, setMarksLocation, setMarksOnBar, setMultiBar, setOffsetPercent, setOrigin, setPenBrushBar, setSideMargins, setStackGroup, setSubGallery, setUseOrigin, setYOrigin, setZPositions, shouldSerializeYOrigin, subGalleryStack
 
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, addSampleValues, addSeriesMouseListener, addSeriesPaintListener, addValues, assign, assignDispose, assignValues, associatedToAxis, beginUpdate, calcPercentSt, calcPosValue, calculateMarkPosition, calcXPosValue, calcXSizeValue, calcYPosValue, calcYSizeValue, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clear, clearLists, clicked, clone, cloneSeries, convertArray, countLegendItems, createNewSeries, createNewSeries, createNewSeries, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawValues, doClick, doClickPointer, doDoubleClick, draw, drawHiddenValue, drawLegend, drawLegend, drawMarks, drawMarksSeries, drawSeries, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, firstDisplayed, galleryChanged3D, getActive, getAllowSinglePoint, 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, 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, isValidSeriesSource, isValidSourceOf, lastDisplayed, legendItemColor, legendToValueIndex, maxMarkWidth, moreSameZOrder, mouseEvent, newFromType, onDisposing, 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, 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

HorizBar

public HorizBar()

HorizBar

public HorizBar(IBaseChart c)
Method Detail

getDescription

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

Overrides:
getDescription in class Series
Returns:
String

getBarHeightPercent

public int getBarHeightPercent()
Defines the percent of bar Height, from 0 to 100.
Default value: 70

Returns:
int

setBarHeightPercent

public void setBarHeightPercent(int value)
Defines the percent of bar Height, from 0 to 100.
Default value: 70

Parameters:
value - int

internalCalcMarkLength

protected int internalCalcMarkLength(int valueIndex)
Overrides:
internalCalcMarkLength in class CustomBar

internalClicked

protected boolean internalClicked(int valueIndex,
                                  Point point)
Overrides:
internalClicked in class CustomBar

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

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

drawMark

protected void drawMark(int valueIndex,
                        java.lang.String s,
                        SeriesMarksPosition position)
Overrides:
drawMark in class Series

calcXPos

public int calcXPos(int valueIndex)
The pixel Screen Horizontal coordinate of the ValueIndex Series value.
This coordinate is calculated using the Series associated Horizontal Axis.

Overrides:
calcXPos in class Series
Parameters:
valueIndex - int
Returns:
int

calcYPos

public int calcYPos(int valueIndex)
The vertical Bar position is the "real" Y pos plus the Barwidth by our BarSeries order.
This coordinate is calculated using the Series associated Vertical Axis.

Overrides:
calcYPos in class Series
Parameters:
valueIndex - int
Returns:
int

drawTickLine

protected void drawTickLine(int tickPos,
                            BarStyle aStyle)
Overrides:
drawTickLine in class CustomBar

drawSeriesForward

protected boolean drawSeriesForward(int valueIndex)
Overrides:
drawSeriesForward in class Series

getOriginPos

protected int getOriginPos(int valueIndex)

getMaxXValue

public double getMaxXValue()
The Maximum Value of the Series X Values List.

Overrides:
getMaxXValue in class Series
Returns:
double

getMinXValue

public double getMinXValue()
The Minimum Value of the Series X Values List.

Overrides:
getMinXValue in class Series
Returns:
double

getMinYValue

public double getMinYValue()
The Minimum Value of the Series Y Values Lists.
As some Series have more than one Y Values List, this Minimum Value is the "Minimum of Minimums" of all Series Y Values lists.

Overrides:
getMinYValue in class Series
Returns:
double

getMaxYValue

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

Overrides:
getMaxYValue in class Series
Returns:
double