EspressReport 6.6

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();


Field Summary
static int POINTED_BLADE
           
static int POINTER
           
static int RECTANGULAR_POINTER
           
static int ROUND_HEADED_BLADE
           
static int TRIANGULAR_POINTER
           
 
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
 int getNeedleStyle()
          This method returns the needle style Needle style option: RECTANGULAR_POINTER - Rectangular pointer style POINTER - 3 segment Pointer style TRIANGULAR_POINTER - Triangule pointer style POINTED_BLADE - Pointed blade style ROUND_HEADED_BLADE - Round headed blade style
 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 setNeedleStyle(int style)
          This method sets the needle style Needle style option: RECTANGULAR_POINTER - Rectangular pointer style POINTER - 3 segment Pointer style TRIANGULAR_POINTER - Triangule pointer style POINTED_BLADE - Pointed blade style ROUND_HEADED_BLADE - Round headed blade style style of pointer 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
 

Field Detail

RECTANGULAR_POINTER

static final int RECTANGULAR_POINTER
See Also:
Constant Field Values

POINTER

static final int POINTER
See Also:
Constant Field Values

TRIANGULAR_POINTER

static final int TRIANGULAR_POINTER
See Also:
Constant Field Values

POINTED_BLADE

static final int POINTED_BLADE
See Also:
Constant Field Values

ROUND_HEADED_BLADE

static final int ROUND_HEADED_BLADE
See Also:
Constant Field Values
Method Detail

getNeedleCount

int getNeedleCount()
This method counts number of needles

Returns:
number of needles

getNeedleLength

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

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

double getCenterPointRadius()
This method returns the relative radius of the center point

Returns:
corresponding relative radius
See Also:
setCenterPointRadius(double)

setCenterPointRadius

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

java.awt.Color getCenterPointColor()
This method returns the color of the center point

Returns:
center point color
See Also:
setCenterPointColor(java.awt.Color)

setCenterPointColor

void setCenterPointColor(java.awt.Color color)
This method sets the center point color

Parameters:
color - Color of the center point
See Also:
getCenterPointColor()

getStartAngle

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

Returns:
the starting angle (in degree)

setStartAngle

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

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

Returns:
the ending angle (in degree)

setEndAngle

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

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

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

void setLabelOffset(java.awt.Dimension[] offset)
This method sets offset for all labels

Parameters:
offset - array of labels offset dimension

countLabelOffset

int countLabelOffset()
This method returns the number of label offset

Returns:
number of label offset

getHandCount

@Deprecated
int getHandCount()
Deprecated. This method is deprecated and should use getNeedleCount instead

This method counts number of hands

Returns:
number of hands

getHandLength

@Deprecated
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

@Deprecated
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

boolean isDrawFullCircle()
This method returns whether draw full circle for dial or not

Returns:
state of drawing full circle

setDrawFullCircle

void setDrawFullCircle(boolean state)
This method sets drawing full circle for dial

Parameters:
state - the state of drawing full circle

getSubTickerLength

int getSubTickerLength()
This method returns the length of the sub-ticker

Returns:
length of the sub-ticker

setSubTickerLength

void setSubTickerLength(int t)
This method sets the length of the sub-ticker

Parameters:
t - length of the sub-ticker

getTickerLength

int getTickerLength()
This method returns the length of the ticker

Returns:
length of the ticker

setTickerLength

void setTickerLength(int t)
This method sets the length of the ticker

Parameters:
t - length of the ticker

is3DShadowForTickerOn

boolean is3DShadowForTickerOn()
This method returns whether ticker 3D shadow is on or not

Returns:
state of ticker 3D shadow

set3DShadowForTickerOn

void set3DShadowForTickerOn(boolean b)
This method sets the ticker 3D shadow is on or not

Parameters:
b - state of ticker 3D shadow

getSubTickerCount

int getSubTickerCount()
This method returns the number of sub-tickers

Returns:
number of sub-tickers

setSubTickerCount

void setSubTickerCount(int ct)
This method sets number of sub-tickers

Parameters:
number - of the sub-tickers

getSubTickerThickness

int getSubTickerThickness()
This method returns the thickness of the sub-ticker

Returns:
the thickness of the sub-ticker

setSubTickerThickness

void setSubTickerThickness(int t)
This method sets the thickness of the sub-ticker

Parameters:
t - the thickness of the sub-ticker

isPointerUsed

boolean isPointerUsed()
This method returns whether the pointer needle is used or not

Returns:
state of pointer needle

setPointerUsed

void setPointerUsed(boolean b)
This method sets the length of the sub-ticker

Parameters:
b - length of the sub-ticker

getNeedleStyle

int getNeedleStyle()
This method returns the needle style Needle style option: RECTANGULAR_POINTER - Rectangular pointer style POINTER - 3 segment Pointer style TRIANGULAR_POINTER - Triangule pointer style POINTED_BLADE - Pointed blade style ROUND_HEADED_BLADE - Round headed blade style

Returns:
style of pointer needle

setNeedleStyle

void setNeedleStyle(int style)
This method sets the needle style Needle style option: RECTANGULAR_POINTER - Rectangular pointer style POINTER - 3 segment Pointer style TRIANGULAR_POINTER - Triangule pointer style POINTED_BLADE - Pointed blade style ROUND_HEADED_BLADE - Round headed blade style style of pointer needle


EspressReport 6.6