quadbase.util
Interface IDialPropertySet

public interface IDialPropertySet

This interface is used to modify the properties associated with a 2D dial chart. A handle to an object that implements this interface can be obtained by calling the gethDialProperties method defined in QbChart. eg. QbChart chart = new QbChart(...); IDialPropertySet dial = chart.gethDialProperties();

Method Summary

int	countLabelOffset() This method returns the number of label offset
java.awt.Color	getCenterPointColor() This method returns the color of the center point
double	getCenterPointRadius() This method returns the relative radius of the center point
double	getEndAngle() This method returns the ending angle of the chart (12pm position is 0 degree, clockwise)
int	getHandCount() Deprecated. This method is deprecated and should use getNeedleCount instead
double	getHandLength(int index) Deprecated. This method is deprecated and should use getNeedleLength instead
java.awt.Dimension	getLabelOffset(int index) This method returns the offset for specific label
int	getNeedleCount() This method counts number of needles
double	getNeedleLength(int index) This method returns the relative length of the specific needle
double	getStartAngle() This method returns the starting angle of the chart (12pm position is 0 degree, clockwise)
int	getSubTickerCount() This method returns the number of sub-tickers
int	getSubTickerLength() This method returns the length of the sub-ticker
int	getSubTickerThickness() This method returns the thickness of the sub-ticker
int	getTickerLength() This method returns the length of the ticker
boolean	is3DShadowForTickerOn() This method returns whether ticker 3D shadow is on or not
boolean	isDrawFullCircle() This method returns whether draw full circle for dial or not
boolean	isPointerUsed() This method returns whether the pointer needle is used or not
void	set3DShadowForTickerOn(boolean b) This method sets the ticker 3D shadow is on or not
void	setCenterPointColor(java.awt.Color color) This method sets the center point color
void	setCenterPointRadius(double lenRatio) This method sets the center point radius
void	setDrawFullCircle(boolean state) This method sets drawing full circle for dial
void	setEndAngle(double angle) This method sets the ending angle of the chart (12pm position is 0 degree, clockwise)
void	setHandLength(int index, double lenRatio) Deprecated. This method is deprecated and should use setNeedleLength instead
void	setLabelOffset(java.awt.Dimension[] offset) This method sets offset for all labels
void	setLabelOffset(int index, java.awt.Dimension offset) This method sets the offset for specific label
void	setNeedleLength(int index, double lenRatio) This method sets the relative length of the specific needle
void	setPointerUsed(boolean b) This method sets the length of the sub-ticker
void	setStartAngle(double angle) This method sets the starting angle of the chart (12pm position is 0 degree, clockwise)
void	setSubTickerCount(int ct) This method sets number of sub-tickers
void	setSubTickerLength(int t) This method sets the length of the sub-ticker
void	setSubTickerThickness(int t) This method sets the thickness of the sub-ticker
void	setTickerLength(int t) This method sets the length of the ticker

Method Detail

getNeedleCount

public int getNeedleCount()

This method counts number of needles

Returns:

number of needles

getNeedleLength

public double getNeedleLength(int index)

This method returns the relative length of the specific needle

Parameters:

index - index of the needle

Returns:

corresponding relative length

See Also:

setNeedleLength(int, double)

setNeedleLength

public void setNeedleLength(int index,
                            double lenRatio)

This method sets the relative length of the specific needle

Parameters:

index - index of the needle

lenRatio - relative needle length (radius of the dial chart == 1.0)

See Also:

getNeedleLength(int)

getCenterPointRadius

public double getCenterPointRadius()

This method returns the relative radius of the center point

Returns:

corresponding relative radius

See Also:

setCenterPointRadius(double)

setCenterPointRadius

public void setCenterPointRadius(double lenRatio)

This method sets the center point radius

Parameters:

lenRatio - relative center point radius (radius of the dial chart == 1.0)

See Also:

getCenterPointRadius()

getCenterPointColor

public java.awt.Color getCenterPointColor()

This method returns the color of the center point

Returns:

center point color

See Also:

setCenterPointColor(java.awt.Color)

setCenterPointColor

public void setCenterPointColor(java.awt.Color color)

This method sets the center point color

Parameters:

color - Color of the center point

See Also:

getCenterPointColor()

getStartAngle

public double getStartAngle()

This method returns the starting angle of the chart (12pm position is 0 degree, clockwise)

Returns:

the starting angle (in degree)

setStartAngle

public void setStartAngle(double angle)

This method sets the starting angle of the chart (12pm position is 0 degree, clockwise)

Parameters:

angle - the starting angle (in degree)

getEndAngle

public double getEndAngle()

This method returns the ending angle of the chart (12pm position is 0 degree, clockwise)

Returns:

the ending angle (in degree)

setEndAngle

public void setEndAngle(double angle)

This method sets the ending angle of the chart (12pm position is 0 degree, clockwise)

Parameters:

angle - the ending angle (in degree)

getLabelOffset

public java.awt.Dimension getLabelOffset(int index)

This method returns the offset for specific label

Parameters:

index - the index of the label (ticker position)

Returns:

the offset dimension for specific label

setLabelOffset

public void setLabelOffset(int index,
                           java.awt.Dimension offset)

This method sets the offset for specific label

Parameters:

index - the index of the label (ticker position)

offset - the label offset dimension

setLabelOffset

public void setLabelOffset(java.awt.Dimension[] offset)

This method sets offset for all labels

Parameters:

offset - array of labels offset dimension

countLabelOffset

public int countLabelOffset()

This method returns the number of label offset

Returns:

number of label offset

getHandCount

public int getHandCount()

Deprecated. This method is deprecated and should use getNeedleCount instead

This method counts number of hands

Returns:

number of hands

getHandLength

public double getHandLength(int index)

Deprecated. This method is deprecated and should use getNeedleLength instead

This method returns the relative length of the specific hand

Parameters:

index - index of the hand

Returns:

corresponding relative length

See Also:

setHandLength(int, double)

setHandLength

public void setHandLength(int index,
                          double lenRatio)

Deprecated. This method is deprecated and should use setNeedleLength instead

This method sets the relative length of the specific hand

Parameters:

index - index of the hand

lenRatio - relative hand length (radius of the dial chart == 1.0)

See Also:

getHandLength(int)

isDrawFullCircle

public boolean isDrawFullCircle()

This method returns whether draw full circle for dial or not

Returns:

state of drawing full circle

setDrawFullCircle

public void setDrawFullCircle(boolean state)

This method sets drawing full circle for dial

Parameters:

state - the state of drawing full circle

getSubTickerLength

public int getSubTickerLength()

This method returns the length of the sub-ticker

Returns:

length of the sub-ticker

setSubTickerLength

public void setSubTickerLength(int t)

This method sets the length of the sub-ticker

Parameters:

t - length of the sub-ticker

getTickerLength

public int getTickerLength()

This method returns the length of the ticker

Returns:

length of the ticker

setTickerLength

public void setTickerLength(int t)

This method sets the length of the ticker

Parameters:

t - length of the ticker

is3DShadowForTickerOn

public boolean is3DShadowForTickerOn()

This method returns whether ticker 3D shadow is on or not

Returns:

state of ticker 3D shadow

set3DShadowForTickerOn

public void set3DShadowForTickerOn(boolean b)

This method sets the ticker 3D shadow is on or not

Parameters:

b - state of ticker 3D shadow

getSubTickerCount

public int getSubTickerCount()

This method returns the number of sub-tickers

Returns:

number of sub-tickers

setSubTickerCount

public void setSubTickerCount(int ct)

This method sets number of sub-tickers

Parameters:

number - of the sub-tickers

getSubTickerThickness

public int getSubTickerThickness()

This method returns the thickness of the sub-ticker

Returns:

the thickness of the sub-ticker

setSubTickerThickness

public void setSubTickerThickness(int t)

This method sets the thickness of the sub-ticker

Parameters:

t - the thickness of the sub-ticker

isPointerUsed

public boolean isPointerUsed()

This method returns whether the pointer needle is used or not

Returns:

state of pointer needle

setPointerUsed

public void setPointerUsed(boolean b)

This method sets the length of the sub-ticker

Parameters:

b - length of the sub-ticker