AbstractPlotter (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.plot2.layer.AbstractPlotter<S>

All Implemented Interfaces:

Plotter<S>

Direct Known Subclasses:

ContourPlotter, FillPlotter, FunctionPlotter, HealpixPlotter, LabelPlotter, LinearFitPlotter, ShapePlotter, SimpleDecalPlotter, SpotPlotter, TracePlotter
```
public abstract class AbstractPlotter<S extends Style>
extends java.lang.Object
implements Plotter<S>
```
Skeleton implementation of Plotter. This doesn't do anything clever, just manages the basic members supplied at construction time.

Since:

22 Nov 2013

Author:

Mark Taylor

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractPlotter(java.lang.String name, javax.swing.Icon icon)` Constructs a plotter with no data coordinates or reports.
`protected`	`AbstractPlotter(java.lang.String name, javax.swing.Icon icon, CoordGroup coordGrp, boolean hasReports)` Constructs a plotter with a given coordinate group and indication of reporting status.
`protected`	`AbstractPlotter(java.lang.String name, javax.swing.Icon icon, int npos, Coord[] extraCoords)` Constructs a plotter with specified data positions and additional coordinates, no report keys.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CoordGroup`	`getCoordGroup()` Returns an object describing which data coordinates are used for this plotter and how they are arranged in supplied DataSpec objects.
`javax.swing.Icon`	`getPlotterIcon()` Returns an icon for this plotter for use in user interface.
`java.lang.String`	`getPlotterName()` Returns the name of this plotter for use in user interface.
`boolean`	`hasReports()` Indicates whether the drawings produced by this plotter will return general interest report information to upstream plotting code.

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

Methods inherited from interface uk.ac.starlink.ttools.plot2.Plotter
createLayer, createStyle, getPlotterDescription, getStyleKeys

- Constructor Detail
  - AbstractPlotter
```
protected AbstractPlotter(java.lang.String name,
                          javax.swing.Icon icon,
                          CoordGroup coordGrp,
                          boolean hasReports)
```
    Constructs a plotter with a given coordinate group and indication of reporting status.
    
    Parameters:
    
    name - plotter name
    
    icon - plotter icon
    
    coordGrp - coordinate group
    
    hasReports - whether plot reports are generated
  - AbstractPlotter
```
protected AbstractPlotter(java.lang.String name,
                          javax.swing.Icon icon)
```
    Constructs a plotter with no data coordinates or reports.
    
    Parameters:
    
    name - plotter name
    
    icon - plotter icon
  - AbstractPlotter
```
protected AbstractPlotter(java.lang.String name,
                          javax.swing.Icon icon,
                          int npos,
                          Coord[] extraCoords)
```
    Constructs a plotter with specified data positions and additional coordinates, no report keys.
    
    Parameters:
    
    name - plotter name
    
    icon - plotter icon
    
    npos - number of sets of positional coordinates
    
    extraCoords - coordinates other than positional coordinates
- Method Detail
  - getPlotterName
```
public java.lang.String getPlotterName()
```
    Description copied from interface: Plotter
    
    Returns the name of this plotter for use in user interface.
    
    Specified by:
    
    getPlotterName in interface Plotter<S extends Style>
    
    Returns:
    
    user-directed plotter name
  - getPlotterIcon
```
public javax.swing.Icon getPlotterIcon()
```
    Description copied from interface: Plotter
    
    Returns an icon for this plotter for use in user interface.
    
    Specified by:
    
    getPlotterIcon in interface Plotter<S extends Style>
    
    Returns:
    
    plotter icon
  - getCoordGroup
```
public CoordGroup getCoordGroup()
```
    Description copied from interface: Plotter
    
    Returns an object describing which data coordinates are used for this plotter and how they are arranged in supplied DataSpec objects.
    
    Specified by:
    
    getCoordGroup in interface Plotter<S extends Style>
    
    Returns:
    
    coordinate group
  - hasReports
```
public boolean hasReports()
```
    Description copied from interface: Plotter
    
    Indicates whether the drawings produced by this plotter will return general interest report information to upstream plotting code.
    
    Specified by:
    
    hasReports in interface Plotter<S extends Style>
    
    Returns:
    
    true if the plot report may return interesting information
    
    See Also:
    
    Drawing.getReport(java.lang.Object)

Class AbstractPlotter<S extends Style>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface uk.ac.starlink.ttools.plot2.Plotter

Constructor Detail

AbstractPlotter

AbstractPlotter

AbstractPlotter

Method Detail

getPlotterName

getPlotterIcon

getCoordGroup

hasReports