|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plottask.PaintMode
public abstract class PaintMode
Defines a mode for disposing of a plot.
Field Summary | |
---|---|
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. |
Constructor Summary | |
---|---|
protected |
PaintMode(String name)
Constructor. |
Method Summary | |
---|---|
abstract Painter |
createPainter(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 PaintMode[] |
getKnownModes(GraphicExporter[] exporters)
Returns a list of all available paint modes, given a list of available GraphicExporter objects. |
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 |
---|
public static final PaintMode SWING_MODE
public static final PaintMode CGI_MODE
public static final PaintMode DISCARD_MODE
Constructor Detail |
---|
protected PaintMode(String name)
name
- mode nameMethod Detail |
---|
public abstract Painter createPainter(Environment env, PaintModeParameter param) throws TaskException
env
- execution environmentparam
- paint mode parameter instance
TaskException
public abstract String getDescription(PaintModeParameter modeParam)
modeParam
- mode parameter for context
public abstract String getModeUsage(PaintModeParameter modeParam)
modeParam
- mode parameter for context
public String getName()
public String toString()
toString
in class Object
public static PaintMode[] getKnownModes(GraphicExporter[] exporters)
exporters
- known graphic exporters
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |