|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.task.ShapeFamilyLayerType
public class ShapeFamilyLayerType
LayerType that represents a family of ShapeModePlotters.
Field Summary | |
---|---|
static String |
SHADING_PREFIX
Base name of associated Shading parameter. |
Constructor Summary | |
---|---|
ShapeFamilyLayerType(ShapeForm form,
List<ShapePlotter.ShapeModePlotter> plotters)
Constructor. |
Method Summary | |
---|---|
ChoiceParameter<ShapeMode> |
createShapeModeParameter(String suffix)
Returns the ShapeMode parameter that is required alongside this LayerType in order to determine the Plotter to use. |
Parameter[] |
getAssociatedParameters(String suffix)
Returns a list of zero or more additional parameters associated with this layer type that may be required to turn it into the specification of an actual Plotter object. |
Coord[] |
getExtraCoords()
Returns a list of any non-positional coordinates associated with this layer. |
String |
getName()
Returns the name of this layer type. |
Plotter |
getPlotter(Environment env,
String suffix)
Acquires a Plotter for this layer type. |
int |
getPositionCount()
Returns the number of coordinate positions associated with this layer. |
ShapeForm |
getShapeForm()
Returns the fixed form associated with this layer type. |
ShapePlotter.ShapeModePlotter[] |
getShapeModePlotters()
Returns the family of plotters associated with this layer type. |
ConfigKey[] |
getStyleKeys()
Returns the style keys associated with this layer type. |
String |
getXmlDescription()
Returns an XML description of this layer type. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String SHADING_PREFIX
Constructor Detail |
---|
public ShapeFamilyLayerType(ShapeForm form, List<ShapePlotter.ShapeModePlotter> plotters)
form
- shape formplotters
- list of plotters with the given Form;
this list may be adjusted during the life of the
object (with care)Method Detail |
---|
public ShapeForm getShapeForm()
public ShapePlotter.ShapeModePlotter[] getShapeModePlotters()
public String getName()
LayerType
getName
in interface LayerType
public String getXmlDescription()
LayerType
getXmlDescription
in interface LayerType
public Parameter[] getAssociatedParameters(String suffix)
LayerType
getAssociatedParameters
in interface LayerType
suffix
- layer suffix string for use in the execution environment
public Plotter getPlotter(Environment env, String suffix) throws TaskException
LayerType
getPlotter
in interface LayerType
env
- execution environmentsuffix
- layer suffix string
TaskException
public int getPositionCount()
LayerType
getPositionCount
in interface LayerType
public Coord[] getExtraCoords()
LayerType
getExtraCoords
in interface LayerType
public ConfigKey[] getStyleKeys()
LayerType
getStyleKeys
in interface LayerType
public ChoiceParameter<ShapeMode> createShapeModeParameter(String suffix)
suffix
- layer suffix
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |