public abstract class PaintMode
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static PaintMode |
CGI_MODE
Mode used for standard output in CGI form.
|
static PaintMode |
DISCARD_MODE
Mode used to perform the plot internally, but produce no output.
|
static PaintMode |
SWING_MODE
Mode used for displaying a live plot on the display.
|
Modifier | Constructor and Description |
---|---|
protected |
PaintMode(java.lang.String name)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
abstract Painter |
createPainter(uk.ac.starlink.task.Environment env,
PaintModeParameter param)
Constructs a new painter object given the state of the environment.
|
abstract java.lang.String |
getDescription(PaintModeParameter modeParam)
Returns a short XML description (no enclosing tag) of this mode's
behaviour.
|
static PaintMode[] |
getKnownModes(GraphicExporter[] exporters)
Returns a list of all available paint modes, given a list of
available GraphicExporter objects.
|
abstract java.lang.String |
getModeUsage(PaintModeParameter modeParam)
Returns a short text usage message describing usage of associated
parameters, if any.
|
java.lang.String |
getName()
Returns this mode's name.
|
java.lang.String |
toString() |
public static final PaintMode SWING_MODE
public static final PaintMode CGI_MODE
public static final PaintMode DISCARD_MODE
protected PaintMode(java.lang.String name)
name
- mode namepublic abstract Painter createPainter(uk.ac.starlink.task.Environment env, PaintModeParameter param) throws uk.ac.starlink.task.TaskException
env
- execution environmentparam
- paint mode parameter instanceuk.ac.starlink.task.TaskException
public abstract java.lang.String getDescription(PaintModeParameter modeParam)
modeParam
- mode parameter for contextpublic abstract java.lang.String getModeUsage(PaintModeParameter modeParam)
modeParam
- mode parameter for contextpublic java.lang.String getName()
public java.lang.String toString()
toString
in class java.lang.Object
public static PaintMode[] getKnownModes(GraphicExporter[] exporters)
exporters
- known graphic exportersCopyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.