Anchor.HorizontalAnchor (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.plot2.Anchor
- - uk.ac.starlink.ttools.plot2.Anchor.HorizontalAnchor

Enclosing class:: Anchor

public abstract static class Anchor.HorizontalAnchor
extends Anchor

Anchor for drawing horizontal text.

Nested Class Summary
- Nested classes/interfaces inherited from class uk.ac.starlink.ttools.plot2.Anchor
  Anchor.HorizontalAnchor

Field Summary
- Fields inherited from class uk.ac.starlink.ttools.plot2.Anchor
  E, N, S, W

Constructor Summary

Constructors
Constructor Description

HorizontalAnchor()

Constructors
Constructor	Description
`HorizontalAnchor()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`drawCaption(java.lang.String label, int px, int py, Captioner captioner, java.awt.Graphics g)`	Draws a text label onto a given graphics context.
`java.awt.Rectangle`	`getCaptionBounds(java.lang.String label, int px, int py, Captioner captioner)`	Returns a rectangle within which all of the given label will fall.
`protected abstract int[]`	`getOffset(java.awt.Rectangle bounds, int pad)`	Returns the positional offset from the reference point to position the graphics context at before calling drawCaption.

Methods inherited from class uk.ac.starlink.ttools.plot2.Anchor
createAngledAnchor

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

- Constructor Detail
  - HorizontalAnchor
```
public HorizontalAnchor()
```
- Method Detail
  - getCaptionBounds
```
public java.awt.Rectangle getCaptionBounds(java.lang.String label,
                                           int px,
                                           int py,
                                           Captioner captioner)
```
    Description copied from class: Anchor
    
    Returns a rectangle within which all of the given label will fall.
    
    Specified by:
    
    getCaptionBounds in class Anchor
    
    Parameters:
    
    label - text
    
    px - reference point X position
    
    py - reference point Y position
    
    captioner - object that can turn text into graphics
    
    Returns:
    
    plotted text bounding box
  - drawCaption
```
public void drawCaption(java.lang.String label,
                        int px,
                        int py,
                        Captioner captioner,
                        java.awt.Graphics g)
```
    Description copied from class: Anchor
    
    Draws a text label onto a given graphics context.
    
    Specified by:
    
    drawCaption in class Anchor
    
    Parameters:
    
    label - text
    
    px - reference point X position
    
    py - reference point Y position
    
    captioner - object that can turn text into graphics
    
    g - graphics context
  - getOffset
```
protected abstract int[] getOffset(java.awt.Rectangle bounds,
                                   int pad)
```
    Returns the positional offset from the reference point to position the graphics context at before calling drawCaption.
    
    Parameters:
    
    bounds - caption bounds
    
    pad - captioner-specific pad value

Class Anchor.HorizontalAnchor

Nested Class Summary

Nested classes/interfaces inherited from class uk.ac.starlink.ttools.plot2.Anchor

Field Summary

Fields inherited from class uk.ac.starlink.ttools.plot2.Anchor

Constructor Summary

Method Summary

Methods inherited from class uk.ac.starlink.ttools.plot2.Anchor

Methods inherited from class java.lang.Object

Constructor Detail

HorizontalAnchor

Method Detail

getCaptionBounds

drawCaption

getOffset