All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class graph.Axis

java.lang.Object
   |
   +----graph.Axis

public class Axis

extends Object

Version:

1.12, 1996/09/12 03:27:07.

Author:

Leigh Brookshaw

amax

The position in pixels of the maximum point of the axis line

amin

The position in pixels of the minimum point of the axis line

axiscolor

Color of the Axis.

BOTTOM

Constant flagging Axis position on the graph.

data_window

Before the Axis can be positioned correctly and drawn the data window needs to be calculated and passed to the Axis.

dataset

Vector containing a list of attached DataSets

drawgrid

If true draw a grid positioned on major ticks over the graph

drawzero

If true draw a line positioned on the Zero label tick mark.

exponent

Textline class to hold the label's exponent (if it has one).

force_end_labels

Rescale the axis so that labels fall at the end of the Axis.

g2d

The graph canvas this axis is attached to (if it is attached to any)

gridcolor

Color of the grid

guess_label_number

Initial guess for the number of labels required

label

Textline class to hold the labels before printing.

label_count

The number of labels required

label_exponent

The label exponent

label_start

The starting value of the labels

label_step

The increment between labels

label_string

String to contain the labels.

label_value

The actual values of the axis labels

LEFT

Constant flagging Axis position on the graph.

major_tic_size

Size in pixels of the major tick marks

manualRange

If true the axis range must be manually set by setting the Axis.minimum and Axis.maximum variables.

max_label_width

The width of the maximum label.

maximum

Maximum data value of the axis.

minimum

Minimum data value of the axis.

minor_tic_count

Number of minor tick marks between major tick marks

minor_tic_size

Size in pixels of the minor tick marks

orientation

The orientation of the axis.

position

The position of the axis.

redraw

Default value true.

RIGHT

Constant flagging Axis position on the graph.

title

Textline class to contain the title of the axis.

TOP

Constant flagging Axis position on the graph.

width

The width of the Axis.

zerocolor

Color of the line at the Zero label

Axis()

Instantiate the class.

Axis(int)

Instantiate the class.

attachDataSet(DataSet)

Attach a DataSet for the Axis to manage.

attachXdata(DataSet)

Attach a DataSet to a Horizontal Axis

attachYdata(DataSet)

Attach a DataSet to a Vertical Axis

calculateGridLabels()

calculate the labels

detachAll()

Detach All attached dataSets.

detachDataSet(DataSet)

Detach an attached DataSet

drawAxis(Graphics)

Draw the axis using the passed Graphics context.

drawHAxis(Graphics)

Draw a Horizontal Axis.

drawVAxis(Graphics)

Draw a Vertical Axis.

getAxisPos()

Return the position of the Axis.

getAxisWidth(Graphics)

Return the width of the axis.

getDataMax()

Return the maximum value of All datasets attached to the axis.

getDataMin()

Return the minimum value of All datasets attached to the axis.

getDouble(int)

Return the data value equivalent of the passed pixel position.

getInteger(double)

Return the pixel equivalent of the passed data value.

isVertical()

If the Axis is Vertical return true.

positionAxis(int, int, int, int)

Position the axis at the passed coordinates.

resetRange()

Reset the range of the axis (the minimum and maximum values) to the default data values.

setExponentColor(Color)

Set the color of the exponent

setExponentFont(Font)

Set the font of the exponent

setLabelColor(Color)

Set the color of the labels

setLabelFont(Font)

Set the font of the labels.

setManualRange(boolean)

Is the range of the axis to be set automatically (based on the data) or manually by setting the values Axis.minimum and Axis.maximum?

setPosition(int)

Set the axis position.

setTitleColor(Color)

Set the color of the title

setTitleFont(Font)

Set the font of the title

setTitleRotation(int)

Set the title rotation angle.

setTitleText(String)

Set the title of the axis

  public final static int LEFT

Constant flagging Axis position on the graph. Left side => Vertical

  public final static int RIGHT

Constant flagging Axis position on the graph. Right side => Vertical

  public final static int TOP

Constant flagging Axis position on the graph. Top side => Horizontal

  public final static int BOTTOM

Constant flagging Axis position on the graph. Bottom side => Horizontal

  public boolean drawgrid

If true draw a grid positioned on major ticks over the graph

  public boolean drawzero

If true draw a line positioned on the Zero label tick mark.

  public Color gridcolor

Color of the grid

  public Color zerocolor

Color of the line at the Zero label

  public boolean redraw

Default value true. Normally never changed. If set false the Axis draw method exits without drawing the axis.

See Also:

drawAxis

  public boolean force_end_labels

Rescale the axis so that labels fall at the end of the Axis. Default value false.

  public int major_tic_size

Size in pixels of the major tick marks

  public int minor_tic_size

Size in pixels of the minor tick marks

  public int minor_tic_count

Number of minor tick marks between major tick marks

  public Color axiscolor

Color of the Axis.

  public double minimum

Minimum data value of the axis. This is the value used to scale data into the data window. This is the value to alter to force a rescaling of the data window.

  public double maximum

Maximum data value of the axis. This is the value used to scale data into the data window. This is the value to alter to force a rescaling of the data window.

  public Dimension data_window

Before the Axis can be positioned correctly and drawn the data window needs to be calculated and passed to the Axis.

  public Graph2D g2d

The graph canvas this axis is attached to (if it is attached to any)

See Also:

Graph2D

  protected Point amin

The position in pixels of the minimum point of the axis line

  protected Point amax

The position in pixels of the maximum point of the axis line

  protected int orientation

The orientation of the axis. Either Axis.HORIZONTAL or Axis.VERTICAL

  protected int position

The position of the axis. Either Axis.LEFT, Axis.RIGHT, Axis.TOP, or Axis.BOTTOM

  protected int width

The width of the Axis. Where width for a horizontal axis is really the height

  protected RTextLine title

Textline class to contain the title of the axis.

  protected RTextLine label

Textline class to hold the labels before printing.

  protected RTextLine exponent

Textline class to hold the label's exponent (if it has one).

  protected int max_label_width

The width of the maximum label. Used to position a Vertical Axis.

  protected Vector dataset

Vector containing a list of attached DataSets

  protected String label_string[]

String to contain the labels.

  protected float label_value[]

The actual values of the axis labels

  protected double label_start

The starting value of the labels

  protected double label_step

The increment between labels

  protected int label_exponent

The label exponent

  protected int label_count

The number of labels required

  protected int guess_label_number

Initial guess for the number of labels required

  protected boolean manualRange

If true the axis range must be manually set by setting the Axis.minimum and Axis.maximum variables. The default is false. The default action is for the axis range to be calculated everytime a dataset is attached.

  public Axis()

Instantiate the class. The defalt type is a Horizontal axis positioned at the bottom of the graph.

  public Axis(int p)

Instantiate the class. Setting the position.

Parameters:

p - Set the axis position. Must be one of Axis.BOTTOM, Axis.TOP, Axis.LEFT, Axis.RIGHT, Axis.HORIZONTAL or Axis.VERTICAL. If one of the latter two are used then Axis.BOTTOM or Axis.LEFT is assumed.

  public void setPosition(int p)

Set the axis position.

Parameters:

p - Must be one of Axis.BOTTOM, Axis.TOP, Axis.LEFT, Axis.RIGHT, Axis.HORIZONTAL or Axis.VERTICAL. If one of the latter two are used then Axis.BOTTOM or Axis.LEFT is assumed.

  public void attachDataSet(DataSet d)

Attach a DataSet for the Axis to manage.

Parameters:

d - dataSet to attach

See Also:

DataSet

  public void detachDataSet(DataSet d)

Detach an attached DataSet

Parameters:

d - dataSet to detach

See Also:

DataSet

  public void detachAll()

Detach All attached dataSets.

  public double getDataMin()

Return the minimum value of All datasets attached to the axis.

Returns:

Data minimum

  public double getDataMax()

Return the maximum value of All datasets attached to the axis.

Returns:

Data maximum

  public int getInteger(double v)

Return the pixel equivalent of the passed data value. Using the position of the axis and the maximum and minimum values convert the data value into a pixel value

Parameters:

v - data value to convert

Returns:

equivalent pixel value

See Also:

getDouble

  public double getDouble(int i)

Return the data value equivalent of the passed pixel position. Using the position of the axis and the maximum and minimum values convert the pixel position into a data value

Parameters:

i - pixel value

Returns:

equivalent data value

See Also:

getInteger

  public void resetRange()

Reset the range of the axis (the minimum and maximum values) to the default data values.

  public int getAxisPos()

Return the position of the Axis.

Returns:

One of Axis.LEFT, Axis.RIGHT, Axis.TOP, or Axis.BOTTOM.

  public boolean isVertical()

If the Axis is Vertical return true.

  public int getAxisWidth(Graphics g)

Return the width of the axis.

Parameters:

g - graphics context.

  public boolean positionAxis(int xmin,
                              int xmax,
                              int ymin,
                              int ymax)

Position the axis at the passed coordinates. The coordinates should match the type of axis.

Parameters:

xmin - The minimum X pixel

xmax - The maximum X pixel. These should be equal if the axis is vertical

ymin - The minimum Y pixel

ymax - The maximum Y pixel. These should be equal if the axis is horizontal

Returns:

true if there are no inconsistencies.

  public void drawAxis(Graphics g)

Draw the axis using the passed Graphics context.

Parameters:

g - Graphics context for drawing

  public void setTitleText(String s)

Set the title of the axis

Parameters:

s - string containing text.

  public void setTitleColor(Color c)

Set the color of the title

Parameters:

c - Color of the title.

  public void setTitleFont(Font f)

Set the font of the title

Parameters:

c - Title font.

  public void setTitleRotation(int a)

Set the title rotation angle. Only multiples of 90 degrees allowed.

Parameters:

a - Title rotation angle in degrees.

  public void setLabelColor(Color c)

Set the color of the labels

Parameters:

c - Color of the labels.

  public void setLabelFont(Font f)

Set the font of the labels.

Parameters:

f - font.

  public void setExponentColor(Color c)

Set the color of the exponent

Parameters:

c - Color.

  public void setExponentFont(Font f)

Set the font of the exponent

Parameters:

f - font.

  public void setManualRange(boolean b)

Is the range of the axis to be set automatically (based on the data) or manually by setting the values Axis.minimum and Axis.maximum?

Parameters:

b - boolean value.

  protected void drawHAxis(Graphics g)

Draw a Horizontal Axis.

Parameters:

g - Graphics context.

  protected void drawVAxis(Graphics g)

Draw a Vertical Axis.

Parameters:

g - Graphics context.

  protected void attachXdata(DataSet d)

Attach a DataSet to a Horizontal Axis

Parameters:

d - dataset to attach.

  protected void attachYdata(DataSet d)

Attach a DataSet to a Vertical Axis

Parameters:

d - dataset to attach.

  protected void calculateGridLabels()

calculate the labels

All Packages  Class Hierarchy  This Package  Previous  Next  Index