NullCaptioner (Starjava TTOOLS API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

All Implemented Interfaces:

Captioner
```
public class NullCaptioner
extends java.lang.Object
implements Captioner
```
Captioner implementation that writes no text. The non-existent text takes up no space.
This is a singleton class, see the static INSTANCE member.

Since:

13 Jan 2016

Author:

Mark Taylor

Field Summary

Fields
Modifier and Type Field and Description

static NullCaptioner INSTANCE
Sole instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`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.

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

- Field Detail
  - INSTANCE
```
public static final NullCaptioner INSTANCE
```
    Sole instance.
- 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

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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