BasicCaptioner (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.plot2.BasicCaptioner

All Implemented Interfaces:

Captioner
```
public class BasicCaptioner
extends java.lang.Object
implements Captioner
```
Captioner implementation that uses Swing text drawing classes.

Since:

12 Feb 2013

Author:

Mark Taylor

Constructor Summary

Constructors
Constructor	Description
`BasicCaptioner()`	Constructs a captioner that will use a default font.
`BasicCaptioner(java.awt.Font font, java.lang.Boolean antialias)`	Constructs a captioner that uses a given font.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`drawCaption(java.lang.String label, java.awt.Graphics g)`	Draws a caption such that the left end of the text baseline is at the origin of the supplied graphics context.
`boolean`	`equals(java.lang.Object o)`
`java.awt.Rectangle`	`getCaptionBounds(java.lang.String label)`	Returns a bounding box for the caption drawn by a corresponding call to `Captioner.drawCaption(java.lang.String, java.awt.Graphics)`.
`int`	`getPad()`	Returns a suitable padding value for separating captions from the reference position or other graphical elements.
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BasicCaptioner
```
public BasicCaptioner()
```
    Constructs a captioner that will use a default font.
  - BasicCaptioner
```
public BasicCaptioner(java.awt.Font font,
                      java.lang.Boolean antialias)
```
    Constructs a captioner that uses a given font.
    
    Parameters:
    
    font - font
- Method Detail
  - drawCaption
```
public void drawCaption(java.lang.String label,
                        java.awt.Graphics g)
```
    Description copied from interface: Captioner
    
    Draws a caption such that the left end of the text baseline is at the origin of the supplied graphics context.
    
    Specified by:
    
    drawCaption in interface Captioner
    
    Parameters:
    
    label - caption text
    
    g - graphics context
  - getCaptionBounds
```
public java.awt.Rectangle getCaptionBounds(java.lang.String label)
```
    Description copied from interface: Captioner
    
    Returns a bounding box for the caption drawn by a corresponding call to Captioner.drawCaption(java.lang.String, java.awt.Graphics).
    
    Specified by:
    
    getCaptionBounds in interface Captioner
    
    Parameters:
    
    label - caption text
    
    Returns:
    
    bounding box for caption drawn at the origin
  - getPad
```
public int getPad()
```
    Description copied from interface: Captioner
    
    Returns a suitable padding value for separating captions from the reference position or other graphical elements.
    
    Specified by:
    
    getPad in interface Captioner
    
    Returns:
    
    pad value in pixels
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class BasicCaptioner

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicCaptioner

BasicCaptioner

Method Detail

drawCaption

getCaptionBounds

getPad

equals

hashCode