uk.ac.starlink.ttools.plot2.geom
Class PlaneAxisAnnotation

java.lang.Object
  extended by uk.ac.starlink.ttools.plot2.geom.PlaneAxisAnnotation
All Implemented Interfaces:
AxisAnnotation

public class PlaneAxisAnnotation
extends Object
implements AxisAnnotation

AxisAnnotation implementation for 2D surfaces.

Since:
26 Jul 2013
Author:
Mark Taylor

Field Summary
static boolean INVERT_Y
           
static Orientation X_ORIENT
           
static Orientation Y_ORIENT
           
 
Constructor Summary
PlaneAxisAnnotation(int gxlo, int gxhi, int gylo, int gyhi, Axis xaxis, Axis yaxis, Tick[] xticks, Tick[] yticks, String xlabel, String ylabel, Captioner captioner)
          Constructor.
 
Method Summary
 void drawLabels(Graphics g)
          Paints the annotations.
 Insets getPadding(boolean withScroll)
          Returns the padding insets around the edge of a plot bounds rectangle required to accommodate the labels painted by this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INVERT_Y

public static final boolean INVERT_Y
See Also:
Constant Field Values

X_ORIENT

public static final Orientation X_ORIENT

Y_ORIENT

public static final Orientation Y_ORIENT
Constructor Detail

PlaneAxisAnnotation

public PlaneAxisAnnotation(int gxlo,
                           int gxhi,
                           int gylo,
                           int gyhi,
                           Axis xaxis,
                           Axis yaxis,
                           Tick[] xticks,
                           Tick[] yticks,
                           String xlabel,
                           String ylabel,
                           Captioner captioner)
Constructor.

Parameters:
gxlo - graphics X coordinate lower bound
gxhi - graphics X coordinate upper bound
gylo - graphics Y coordinate lower bound
gyhi - graphics Y coordinate upper bound
xaxis - X axis object
yaxis - Y axis object
xticks - array of ticks along the X axis
yticks - array of ticks along the Y axis
xlabel - text label on X axis
ylabel - text label on Y axis
captioner - text renderer for axis labels etc
Method Detail

drawLabels

public void drawLabels(Graphics g)
Description copied from interface: AxisAnnotation
Paints the annotations. They should fit in the padding region defined by the result of the {link #getPadding} method.

Specified by:
drawLabels in interface AxisAnnotation
Parameters:
g - graphics context

getPadding

public Insets getPadding(boolean withScroll)
Description copied from interface: AxisAnnotation
Returns the padding insets around the edge of a plot bounds rectangle required to accommodate the labels painted by this object.

Specified by:
getPadding in interface AxisAnnotation
Parameters:
withScroll - true if the padding should be large enough to accommodate labelling requirements if the surface is scrolled
Returns:
padding insets


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.