JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.chart
Class JCBarChartFormat

java.lang.Object
  |
  +--com.klg.jclass.chart.JCBarChartFormat
All Implemented Interfaces:
JCChartTypeFormat, Serializable

public class JCBarChartFormat
extends Object
implements JCChartTypeFormat, Serializable

An object that manages chart properties specific to bar charts.

See Also:
Serialized Form

Field Summary
static int BAR_CLUSTER_OVERLAP_MAX
           
static int BAR_CLUSTER_OVERLAP_MIN
           
static int BAR_CLUSTER_WIDTH_MAX
           
protected  int clusterOverlap
           
protected  int clusterWidth
           
protected  boolean is100Percent
           
protected  com.klg.jclass.chart.Changeable parent
           
 
Constructor Summary
JCBarChartFormat()
           
JCBarChartFormat(com.klg.jclass.chart.Changeable p)
           
 
Method Summary
 int getClusterOverlap()
          Gets the ClusterOverlap property, which specifies the overlap between bars.
 int getClusterWidth()
          Gets the ClusterWidth property, which determines the percentage of available space to be occupied by the bars.
 boolean is100Percent()
          Gets the value of the 100Percent property.
 void set100Percent(boolean b)
          Sets the value of the 100Percent property.
 void setClusterOverlap(int per)
          Sets the ClusterOverlap property, which specifies the overlap between bars.
 void setClusterWidth(int per)
          Sets the ClusterWidth property, which determines the percentage of available space that will be occupied by the bars.
 void setParent(com.klg.jclass.chart.ChartDataView cdv)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BAR_CLUSTER_WIDTH_MAX

public static final int BAR_CLUSTER_WIDTH_MAX
See Also:
Constant Field Values

BAR_CLUSTER_OVERLAP_MIN

public static final int BAR_CLUSTER_OVERLAP_MIN
See Also:
Constant Field Values

BAR_CLUSTER_OVERLAP_MAX

public static final int BAR_CLUSTER_OVERLAP_MAX
See Also:
Constant Field Values

clusterWidth

protected int clusterWidth

clusterOverlap

protected int clusterOverlap

is100Percent

protected boolean is100Percent

parent

protected com.klg.jclass.chart.Changeable parent
Constructor Detail

JCBarChartFormat

public JCBarChartFormat()

JCBarChartFormat

public JCBarChartFormat(com.klg.jclass.chart.Changeable p)
Method Detail

setParent

public void setParent(com.klg.jclass.chart.ChartDataView cdv)
Specified by:
setParent in interface JCChartTypeFormat

getClusterWidth

public int getClusterWidth()
Gets the ClusterWidth property, which determines the percentage of available space to be occupied by the bars.

Returns:
A value between 0 and 100 representing the percentage of available space used by the bars

setClusterWidth

public void setClusterWidth(int per)
Sets the ClusterWidth property, which determines the percentage of available space that will be occupied by the bars.

Parameters:
per - value between 0 and 100 representing the percentage of available space used by the bars
Throws:
IllegalArgumentException - If ClusterWidth is not between 0 and 100.

getClusterOverlap

public int getClusterOverlap()
Gets the ClusterOverlap property, which specifies the overlap between bars.

Returns:
percentage of overlap as a percentage of the bar's width. Valid values are between -100 and +100.

setClusterOverlap

public void setClusterOverlap(int per)
Sets the ClusterOverlap property, which specifies the overlap between bars.

Parameters:
per - percentage of overlap as a percentage of the bar's width. Valid values are between -100 and +100.
Throws:
IllegalArgumentException - If ClusterOverlap is not between -100 and 100.

is100Percent

public boolean is100Percent()
Gets the value of the 100Percent property. A true value indicates that the stacking bar chart will be charted against an axis representing values from 0 to 100 percent.

Returns:
A boolean indicating whether the Y-axis will range from 0 to 100.

set100Percent

public void set100Percent(boolean b)
Sets the value of the 100Percent property. A true value indicates that the stacking bar chart will be charted against an axis representing values from 0 to 100 percent.

Parameters:
b - boolean indicating whether the y axis will range from 0 to 100

Copyright © 2004 Quest Software Inc..
All rights reserved.