quadbase.util
Interface IBubblePropertySet

public interface IBubblePropertySet

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

Field Summary

static int	DRAW_FRAME A draw mode
static int	FILL_BUBBLE A draw mode

Method Summary

int	get3DLightIntensity() This method returns the intensity of the light used in the simulated 3D mode.
double	getAxisUnitToRadiusRatio() This method returns the ratio of the unit length of x-axis (in pixel/unit) to bubble radius value.
int	getDrawMode() This method gets the draw mode of bubble chart.
boolean	is3DShading() This method returns the state of drawing the bubbles in the simulated 3D shading mode.
boolean	isAreaProportionalToValue() This method returns the state of using the ratio of area to represent the ratio in the Z-values of the bubbles.
boolean	isBlackBorderVisible() This method returns the state of bubble border.
void	set3DShading(boolean state) This method sets the rendition of the bubbles to have 3D shading with the default value of light intensity, 66.
void	set3DShading(boolean state, int lightIntensity) This method sets the rendition of the bubbles to simulate 3D bubbles.
void	setAreaProportionalToValue(boolean state) This method sets drawing the bubbles in respect to their area size.
void	setAxisUnitToRadiusRatio(double ratio) This method sets the ratio of the unit length of x-axis (in pixel/unit) to bubble radius value.
void	setBlackBorderVisible(boolean visible) This method sets the state of bubble border.
void	setDrawMode(int mode) This method sets the draw mode of bubble chart.

Field Detail

DRAW_FRAME

public static final int DRAW_FRAME

A draw mode

FILL_BUBBLE

public static final int FILL_BUBBLE

A draw mode

Method Detail

getDrawMode

public int getDrawMode()

This method gets the draw mode of bubble chart. It returns either DRAW_FRAME or FILL_BUBBLE. The default value is DRAW_FRAME.

Returns:

The current draw mode

See Also:

setDrawMode(int)

setDrawMode

public void setDrawMode(int mode)

This method sets the draw mode of bubble chart. The argument is either DRAW_FRAME or FILL_BUBBLE. The default value is DRAW_FRAME.

Parameters:

mode - The new draw mode

See Also:

getDrawMode()

setBlackBorderVisible

public void setBlackBorderVisible(boolean visible)

This method sets the state of bubble border. When the state is true, bubble chart draws a back border around each bubble. It is effective only when draw mode is FILL_BUBBLE. The default value is true.

Parameters:

The - new state

See Also:

isBlackBorderVisible(), setDrawMode(int)

isBlackBorderVisible

public boolean isBlackBorderVisible()

This method returns the state of bubble border. The default value is true.

Returns:

The current state

See Also:

setBlackBorderVisible(boolean)

getAxisUnitToRadiusRatio

public double getAxisUnitToRadiusRatio()

This method returns the ratio of the unit length of x-axis (in pixel/unit) to bubble radius value. Unit length of an axis is defined as the number of pixels required to represent 1 unit on the axis. For instance, if the data value represented by bubble at a point is 20 and the ratio is 0.5, the radius of the bubble is 20*0.5 = 10 unit length. The default value is 1.

Returns:

The ratio

See Also:

setAxisUnitToRadiusRatio(double)

setAxisUnitToRadiusRatio

public void setAxisUnitToRadiusRatio(double ratio)

This method sets the ratio of the unit length of x-axis (in pixel/unit) to bubble radius value. The default value is 1.

Parameters:

ratio - The new ratio

See Also:

getAxisUnitToRadiusRatio()

setAreaProportionalToValue

public void setAreaProportionalToValue(boolean state)

This method sets drawing the bubbles in respect to their area size. When the state is true, the area ratio of two bubbles having a value ratio of 2 to 1 would be 2 to 1. When the state is false, the radius ratio would reflect value ratios; in this case, the area ratio would be 4 to 1, instead of 2 to 1. The default value is false.

Parameters:

state - The new state

isAreaProportionalToValue

public boolean isAreaProportionalToValue()

This method returns the state of using the ratio of area to represent the ratio in the Z-values of the bubbles. The default value is false.

Returns:

The current state

set3DShading

public void set3DShading(boolean state)

This method sets the rendition of the bubbles to have 3D shading with the default value of light intensity, 66.

Parameters:

state - The new state of the rendition, default is false.

set3DShading

public void set3DShading(boolean state,
                         int lightIntensity)

This method sets the rendition of the bubbles to simulate 3D bubbles. You can specify the amount of light with the variable "lightIntensity". Values close to 100 indicate almost no shadow while values close to zero indicate significant shadow effect.

Parameters:

state - The new state of the rendition, default is false.

lightIntensity - value should be between 1 to 100, inclusive.

is3DShading

public boolean is3DShading()

This method returns the state of drawing the bubbles in the simulated 3D shading mode.

Returns:

The current state

get3DLightIntensity

public int get3DLightIntensity()

This method returns the intensity of the light used in the simulated 3D mode.

Returns:

The current value