PamAxis

java.lang.Object
- Layout.PamAxis

Direct Known Subclasses:

ClassifierHistoryTimeAxis, RepeatedAxis
```
public class PamAxis
extends java.lang.Object
```
Draws an axis on a Java Component.
PamAxis contains all the information needed to draw an axis, the actual drawing is generally called from the paintComponent function in the containing window.
for a good example, see PamAxisPanel which will automaticall draw four axis around a central plot.

Author:

Doug Gillespie

See Also:
PamLabel, PamAxisPanel

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABOVE_LEFT`
`static int`	`BELOW_RIGHT`
`static int`	`BOTH_SIDES`
`static int`	`INTERVAL_AUTO`
`static int`	`LABEL_NEAR_CENTRE`
`static int`	`LABEL_NEAR_MAX`
`static int`	`LABEL_NEAR_MIN`

Constructor Summary

Constructors
Constructor and Description
`PamAxis(int x1, int y1, int x2, int y2, double minVal, double maxVal, boolean aboveLeft, java.lang.String label, java.lang.String format)`
`PamAxis(int x1, int y1, int x2, int y2, double minVal, double maxVal, int tickPosition, java.lang.String label, int labelPos, java.lang.String format)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`drawAxis(java.awt.Graphics g)` Draw the axis in the Graphics Context g
`void`	`drawAxis(java.awt.Graphics g, int x1, int y1, int x2, int y2)` Draw the axis in the graphics context g at the given position
`void`	`drawGrid(java.awt.Graphics g, java.awt.Dimension plotSize, java.awt.Insets insets, int minorGrid)`
`void`	`drawGrid(java.awt.Graphics g, java.awt.Dimension plotSize, int minorGrid)` Draw a grid to go with the axis.
`java.lang.String`	`getAutoFormat(boolean isInteger)`
`static java.lang.String`	`getAutoFormat(double minVal, double maxVal, boolean isInteger)`
`java.lang.String`	`getAutoLabelFormat()` Work out the optimal format for the axis labels based on analysis of previously used axis labels.
`java.util.ArrayList<java.awt.Point>`	`getAxisPoints(boolean extraOne)` Work out the coordinates of all tick marks.
`java.util.ArrayList<java.lang.Double>`	`getAxisValues()`
`double`	`getDataValue(double position)` Converts a position on the plot into a data value based on the axis max, min and scale.
`static double`	`getDefaultScaleEnd(double val, double otherVal)`
`int`	`getExtent(java.awt.Graphics g)` Gets the dimension of the axis parallel to the direction of the tickmark - i.e.
`int`	`getExtent(java.awt.Graphics g, java.lang.String typicalString)` Gets the dimension of the axis parallel to the direction of the tickmark - i.e.
`int`	`getExtent2(java.awt.Graphics g)` Gets the dimension of the axis perpendicular to the direction of the tickmark - i.e.
`int`	`getExtent2(java.awt.Graphics g, java.lang.String typicalString)` Gets the dimension of the axis perpendicular to the direction of the tickmark - i.e.
`java.lang.String`	`getExtraAxisEndLabel()`
`java.lang.String`	`getExtraAxisStartLabel()`
`java.lang.String`	`getFormat()`
`java.lang.String`	`getLabel()`
`int`	`getLabelPos()`
`double`	`getMaxVal()`
`double`	`getMinVal()`
`static int`	`getNumDecPlaces(double value)`
`double`	`getPosition(double dataValue)` The axis knows all about scale and can tell us the pixel value for any given data value.
`int`	`getTickPosition()`
`int`	`getX1()`
`int`	`getX2()`
`int`	`getY1()`
`int`	`getY2()`
`boolean`	`isAllowScaleMultiples()`
`boolean`	`isCrampLabels()` Cramped labels means that when drawing an axis, the end labels will be shifted to remain within the bounds of the axis itself.
`boolean`	`isDrawLine()`
`boolean`	`isFractionalScale()`
`boolean`	`isIntegerFormat()`
`boolean`	`isLogScale()`
`boolean`	`isLogTenthsScale()`
`void`	`overrideAxisColour(java.awt.Color color)` Overrides the standard axis color;
`void`	`setAllowScaleMultiples(boolean allowScaleMultiples)`
`void`	`setAngleScales(boolean angleScales)` Easy way to make scales end at 45, 90, 180, etc and step in sensible 45, 90, etc.
`void`	`setAutoFormat(boolean isInteger)` Automatically set the format of axis labels based on the types of numbers in there.
`void`	`setCrampLabels(boolean crampLabels)` Cramped labels means that when drawing an axis, the end labels will be shifted to remain within the bounds of the axis itself.
`void`	`setDrawLine(boolean drawLine)`
`void`	`setExtraAxisEndLabel(java.lang.String extraAxisEndLabel)`
`void`	`setExtraAxisStartLabel(java.lang.String extraAxStartLabel)`
`void`	`setForceFirstVal(boolean forceFirstVal, double forcedFirstVal)`
`void`	`setFormat(java.lang.String format)` Set the format string for writing out numbers on the axis.
`void`	`setFractionalScale(boolean fractionalScale)`
`void`	`setInterval(double interval)` Set the interval between ticks.
`void`	`setLabel(java.lang.String label)`
`void`	`setLabelPos(int labelPos)`
`void`	`setLogScale(boolean logScale)`
`void`	`setLogTenthsScale(boolean logTenthsScale)`
`void`	`setMaxVal(double maxVal)`
`void`	`setMinVal(double minVal)`
`void`	`setPosition(int x1, int y1, int x2, int y2)` Set the axis default coordinates
`void`	`setRange(double minVal, double maxVal)` Set the minimum and maximum values for the axis.
`void`	`setTickPosition(int tickPosition)`
`void`	`setX1(int x1)`
`void`	`setX2(int x2)`
`void`	`setY1(int y1)`
`void`	`setY2(int y2)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INTERVAL_AUTO
```
public static final int INTERVAL_AUTO
```
    See Also:
    Constant Field Values
  - ABOVE_LEFT
```
public static final int ABOVE_LEFT
```
    See Also:
    Constant Field Values
  - BELOW_RIGHT
```
public static final int BELOW_RIGHT
```
    See Also:
    Constant Field Values
  - BOTH_SIDES
```
public static final int BOTH_SIDES
```
    See Also:
    Constant Field Values
  - LABEL_NEAR_MAX
```
public static final int LABEL_NEAR_MAX
```
    See Also:
    Constant Field Values
  - LABEL_NEAR_MIN
```
public static final int LABEL_NEAR_MIN
```
    See Also:
    Constant Field Values
  - LABEL_NEAR_CENTRE
```
public static final int LABEL_NEAR_CENTRE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - PamAxis
```
public PamAxis(int x1,
       int y1,
       int x2,
       int y2,
       double minVal,
       double maxVal,
       int tickPosition,
       java.lang.String label,
       int labelPos,
       java.lang.String format)
```
    Parameters:
    x1 - first x coordinate of axis
    y1 - first y coordinate of axis
    x2 - second x coordinate of axis
    y2 - second coordinate of axis
    minVal - minimum axis value
    maxVal - maximum axis value
    tickPosition - tick position (ABOVE_LEFT or BELOW_RIGHT)
    label - text for label (or null if no label)
    labelPos - Position of axis label (LABEL_NEAR_MAX, LABEL_NEAR_MIN or LABEL_NEAR_CENTRE)
    format - format for numbers printed on the display. This must be a standard format String such as "%d", "%f", "%3.1f", "%.2 seconds", etc.
  - PamAxis
```
public PamAxis(int x1,
       int y1,
       int x2,
       int y2,
       double minVal,
       double maxVal,
       boolean aboveLeft,
       java.lang.String label,
       java.lang.String format)
```
    Parameters:
    x1 - x1
    y1 - y1
    x2 - x2
    y2 - y2
    minVal - min axis value
    maxVal - max axis value
    aboveLeft - above and / or to the left
    label - axis label
    format - format of numbers
- Method Detail
  - setPosition
```
public void setPosition(int x1,
               int y1,
               int x2,
               int y2)
```
    Set the axis default coordinates
    
    Parameters:
    x1 -
    y1 -
    x2 -
    y2 -
  - setInterval
```
public void setInterval(double interval)
```
    Set the interval between ticks. This is by default set to INTERVAL_AUTO whereby an interval is chosen so that there is a tick mark approximately every 100 pixels.
    
    Parameters:
    interval - the interval or INTERVAL_AUTO
  - setRange
```
public void setRange(double minVal,
            double maxVal)
```
    Set the minimum and maximum values for the axis.
    
    Parameters:
    minVal -
    maxVal -
  - drawAxis
```
public void drawAxis(java.awt.Graphics g,
            int x1,
            int y1,
            int x2,
            int y2)
```
    Draw the axis in the graphics context g at the given position
    
    Parameters:
    g -
    x1 -
    y1 -
    x2 -
    y2 -
  - drawAxis
```
public void drawAxis(java.awt.Graphics g)
```
    Draw the axis in the Graphics Context g
    
    Parameters:
    g - graphics context to draw on
  - getAxisPoints
```
public java.util.ArrayList<java.awt.Point> getAxisPoints(boolean extraOne)
```
    Work out the coordinates of all tick marks.
    
    Parameters:
    extraOne -
    
    Returns:
    list of axis points.
  - drawGrid
```
public void drawGrid(java.awt.Graphics g,
            java.awt.Dimension plotSize,
            int minorGrid)
```
    Draw a grid to go with the axis. Generally, the graphics handle for grid drawing will be some inner window sitting inside the window containing the axis.
    
    Parameters:
    g - Graphics context to draw on
    plotSize - size of the graphic
    minorGrid - draw a minor grid as well as lines at the main tick marks.
  - drawGrid
```
public void drawGrid(java.awt.Graphics g,
            java.awt.Dimension plotSize,
            java.awt.Insets insets,
            int minorGrid)
```
  - getExtent2
```
public int getExtent2(java.awt.Graphics g)
```
    Gets the dimension of the axis perpendicular to the direction of the tickmark - i.e. for a vertical axis, it's half the text height, for a horizontal axis it's half the typical string width.
    
    Parameters:
    g - graphics handle for component the axis is to be draw on
    
    Returns:
    axis extent in pixels
  - getExtent2
```
public int getExtent2(java.awt.Graphics g,
             java.lang.String typicalString)
```
    Gets the dimension of the axis perpendicular to the direction of the tickmark - i.e. for a vertical axis, it's half the text height, for a horizontal axis it's half the typical string width.
    
    Parameters:
    g - graphics handle for component the axis is to be draw on
    typicalString - typical text string.
    
    Returns:
    Axis extent
  - getExtent
```
public int getExtent(java.awt.Graphics g)
```
    Gets the dimension of the axis parallel to the direction of the tickmark - i.e. the ticklength + the text height + the label height.
    
    Parameters:
    g - graphics handle for component the axis is to be draw on
    
    Returns:
    axis extent in pixels
  - getExtent
```
public int getExtent(java.awt.Graphics g,
            java.lang.String typicalString)
```
    Gets the dimension of the axis parallel to the direction of the tickmark - i.e. the ticklength + the text height + the label height.
    
    Parameters:
    g - graphics handle the axis is being draw on
    typicalString - typical label string for a tick
    
    Returns:
    axisextent in pixels
  - isLogScale
```
public boolean isLogScale()
```
  - setLogScale
```
public void setLogScale(boolean logScale)
```
  - isDrawLine
```
public boolean isDrawLine()
```
  - setDrawLine
```
public void setDrawLine(boolean drawLine)
```
  - getFormat
```
public java.lang.String getFormat()
```
  - setFormat
```
public void setFormat(java.lang.String format)
```
    Set the format string for writing out numbers on the axis.
    
    Parameters:
    format - format string
  - setAutoFormat
```
public void setAutoFormat(boolean isInteger)
```
    Automatically set the format of axis labels based on the types of numbers in there.
  - getAutoFormat
```
public java.lang.String getAutoFormat(boolean isInteger)
```
  - getAutoFormat
```
public static java.lang.String getAutoFormat(double minVal,
                             double maxVal,
                             boolean isInteger)
```
  - getNumDecPlaces
```
public static int getNumDecPlaces(double value)
```
  - isIntegerFormat
```
public boolean isIntegerFormat()
```
  - getLabel
```
public java.lang.String getLabel()
```
  - setLabel
```
public void setLabel(java.lang.String label)
```
  - getLabelPos
```
public int getLabelPos()
```
  - setLabelPos
```
public void setLabelPos(int labelPos)
```
  - getTickPosition
```
public int getTickPosition()
```
  - setTickPosition
```
public void setTickPosition(int tickPosition)
```
  - getMaxVal
```
public double getMaxVal()
```
  - setMaxVal
```
public void setMaxVal(double maxVal)
```
  - getMinVal
```
public double getMinVal()
```
  - setMinVal
```
public void setMinVal(double minVal)
```
  - getAutoLabelFormat
```
public java.lang.String getAutoLabelFormat()
```
    Work out the optimal format for the axis labels based on analysis of previously used axis labels.
    
    Returns:
    some kind of sensible format string !
  - getDefaultScaleEnd
```
public static double getDefaultScaleEnd(double val,
                        double otherVal)
```
  - setForceFirstVal
```
public void setForceFirstVal(boolean forceFirstVal,
                    double forcedFirstVal)
```
  - isLogTenthsScale
```
public boolean isLogTenthsScale()
```
  - setLogTenthsScale
```
public void setLogTenthsScale(boolean logTenthsScale)
```
  - getAxisValues
```
public java.util.ArrayList<java.lang.Double> getAxisValues()
```
  - getX1
```
public int getX1()
```
  - setX1
```
public void setX1(int x1)
```
  - getX2
```
public int getX2()
```
  - setX2
```
public void setX2(int x2)
```
  - getY1
```
public int getY1()
```
  - setY1
```
public void setY1(int y1)
```
  - getY2
```
public int getY2()
```
  - setY2
```
public void setY2(int y2)
```
  - getPosition
```
public double getPosition(double dataValue)
```
    The axis knows all about scale and can tell us the pixel value for any given data value.
    
    Parameters:
    dataValue -
    
    Returns:
    position in pixels along the axis for a given data value.
  - getDataValue
```
public double getDataValue(double position)
```
    Converts a position on the plot into a data value based on the axis max, min and scale.
    This is the exact compliment of getPosition()
    
    Parameters:
    position - position along the axis in pixels.
    
    Returns:
    data value.
  - isAllowScaleMultiples
```
public boolean isAllowScaleMultiples()
```
  - setAllowScaleMultiples
```
public void setAllowScaleMultiples(boolean allowScaleMultiples)
```
  - setAngleScales
```
public void setAngleScales(boolean angleScales)
```
    Easy way to make scales end at 45, 90, 180, etc and step in sensible 45, 90, etc. steps.
    
    Parameters:
    angleScales -
  - isFractionalScale
```
public boolean isFractionalScale()
```
  - setFractionalScale
```
public void setFractionalScale(boolean fractionalScale)
```
  - getExtraAxisStartLabel
```
public java.lang.String getExtraAxisStartLabel()
```
    Returns:
    the extraAxStartLabel
  - setExtraAxisStartLabel
```
public void setExtraAxisStartLabel(java.lang.String extraAxStartLabel)
```
    Parameters:
    extraAxStartLabel - the extraAxStartLabel to set
  - getExtraAxisEndLabel
```
public java.lang.String getExtraAxisEndLabel()
```
    Returns:
    the extraAxisEndLabel
  - setExtraAxisEndLabel
```
public void setExtraAxisEndLabel(java.lang.String extraAxisEndLabel)
```
    Parameters:
    extraAxisEndLabel - the extraAxisEndLabel to set
  - isCrampLabels
```
public boolean isCrampLabels()
```
    Cramped labels means that when drawing an axis, the end labels will be shifted to remain within the bounds of the axis itself.
    
    Returns:
    the crampLables
  - setCrampLabels
```
public void setCrampLabels(boolean crampLabels)
```
    Cramped labels means that when drawing an axis, the end labels will be shifted to remain within the bounds of the axis itself.
    
    Parameters:
    crampLabels - the crampLables to set
  - overrideAxisColour
```
public void overrideAxisColour(java.awt.Color color)
```
    Overrides the standard axis color;
    
    Parameters:
    color- - null if default colour.

Class PamAxis

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INTERVAL_AUTO

ABOVE_LEFT

BELOW_RIGHT

BOTH_SIDES

LABEL_NEAR_MAX

LABEL_NEAR_MIN

LABEL_NEAR_CENTRE

Constructor Detail

PamAxis

PamAxis

Method Detail

setPosition

setInterval

setRange

drawAxis

drawAxis

getAxisPoints

drawGrid

drawGrid

getExtent2

getExtent2

getExtent

getExtent

isLogScale

setLogScale

isDrawLine

setDrawLine

getFormat

setFormat

setAutoFormat

getAutoFormat

getAutoFormat

getNumDecPlaces

isIntegerFormat

getLabel

setLabel

getLabelPos

setLabelPos

getTickPosition

setTickPosition

getMaxVal

setMaxVal

getMinVal

setMinVal

getAutoLabelFormat

getDefaultScaleEnd

setForceFirstVal

isLogTenthsScale

setLogTenthsScale

getAxisValues

getX1

setX1

getX2

setX2

getY1

setY1

getY2

setY2

getPosition

getDataValue

isAllowScaleMultiples

setAllowScaleMultiples

setAngleScales

isFractionalScale

setFractionalScale

getExtraAxisStartLabel

setExtraAxisStartLabel

getExtraAxisEndLabel

setExtraAxisEndLabel

isCrampLabels

setCrampLabels

overrideAxisColour