quadbase.util
Interface IAxisRuler

All Known Implementing Classes:

QbChartBasic.CAxisRuler, QbChartBasic.CAxisRuler

public interface IAxisRuler

This class is used by users to configure the visibility of X, Y, and S axis rulers shown in a QbChart object. A handle to the ruler for a particular axis can be obtained by calling:

      QbChart.gethXRuler()  - To get the X Axis Ruler
      QbChart.gethYRuler()  - To get the Y Axis Ruler
      gethAxisRuler() defined in ISecondaryChart - To get the S Axis Ruler
 

See Also:

ISecondaryChart

Method Summary

boolean	isLabelVisible() Checks the boolean state of the axis ruler labels.
boolean	isVisible() Returns the boolean state of the Axis Ruler for the particular axis.
void	setLabelVisible(boolean value) Sets the ruler label visibility.
void	setVisible(boolean value) Sets the ruler visibility to on or off

Method Detail

isVisible

public boolean isVisible()

Returns the boolean state of the Axis Ruler for the particular axis. The axis being checked for depends on the IAxisRuler handle being used.

Returns:

true if axis ruler is visible

setVisible

public void setVisible(boolean value)

Sets the ruler visibility to on or off

Parameters:

value - The boolean state of the axis ruler. True implies visible and false implies hidden

isLabelVisible

public boolean isLabelVisible()

Checks the boolean state of the axis ruler labels. Labels can be turned on or off on the axis ruler.

Returns:

true if axis ruler label is visible, false otherwise.

setLabelVisible

public void setLabelVisible(boolean value)

Sets the ruler label visibility. Labels in a ruler can be turned on or off using this method.

Parameters:

value - Set it to true for ruler labels to be displayed.