uk.ac.starlink.ttools.plottask
Class PaintMode

java.lang.Object
  extended by uk.ac.starlink.ttools.plottask.PaintMode

public abstract class PaintMode
extends Object

Defines a mode for disposing of a plot.

Since:
4 Aug 2008
Author:
Mark Taylor

Field Summary
static PaintMode DEFAULT_MODE
          Mode used by default.
 
Constructor Summary
protected PaintMode(String name)
          Constructor.
 
Method Summary
abstract  Painter createPainter(uk.ac.starlink.task.Environment env, PaintModeParameter param)
          Constructs a new painter object given the state of the environment.
abstract  String getDescription(PaintModeParameter modeParam)
          Returns a short XML description (no enclosing tag) of this mode's behaviour.
static GraphicExporter[] getKnownExporters()
          Returns a list of all available graphics exporters.
static PaintMode[] getKnownModes()
          Returns a list of all available paint modes.
abstract  String getModeUsage(PaintModeParameter modeParam)
          Returns a short text usage message describing usage of associated parameters, if any.
 String getName()
          Returns this mode's name.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_MODE

public static final PaintMode DEFAULT_MODE
Mode used by default.

Constructor Detail

PaintMode

protected PaintMode(String name)
Constructor.

Parameters:
name - mode name
Method Detail

createPainter

public abstract Painter createPainter(uk.ac.starlink.task.Environment env,
                                      PaintModeParameter param)
                               throws uk.ac.starlink.task.TaskException
Constructs a new painter object given the state of the environment.

Parameters:
env - execution environment
param - paint mode parameter instance
Throws:
uk.ac.starlink.task.TaskException

getDescription

public abstract String getDescription(PaintModeParameter modeParam)
Returns a short XML description (no enclosing tag) of this mode's behaviour.

Parameters:
modeParam - mode parameter for context
Returns:
PCDATA

getModeUsage

public abstract String getModeUsage(PaintModeParameter modeParam)
Returns a short text usage message describing usage of associated parameters, if any. If no other parameters are referenced, an empty string should be returned.

Parameters:
modeParam - mode parameter for context
Returns:
plain text

getName

public String getName()
Returns this mode's name.

Returns:
name

toString

public String toString()
Overrides:
toString in class Object

getKnownModes

public static PaintMode[] getKnownModes()
Returns a list of all available paint modes.

Returns:
known paint modes

getKnownExporters

public static GraphicExporter[] getKnownExporters()
Returns a list of all available graphics exporters.

Returns:
known graphic exporters


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