Class PairLinkForm
java.lang.Object
uk.ac.starlink.ttools.plot2.layer.PairLinkForm
- All Implemented Interfaces:
ModePlotter.Form
,ShapeForm
Draws a line between two related positions.
Singleton class.
- Since:
- 28 Nov 2013
- Author:
- Mark Taylor
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionadjustGeom
(DataGeom geom, DataSpec dataSpec, ShapeStyle style) Provides a DataGeom to be used by the layer this form makes, given a DataGeom that characterises the plotting environment.createOutliner
(ConfigMap config) Returns an object which will do the work of drawing shapes when supplied with the appropriate style information and data.int
Returns the number of basic data positions per tuple used by this form.ConfigKey<?>[]
Returns style configuration keys specific to this form.Coord[]
Returns data coordinates additional to the basic position which are required to plot a point.int
Returns the number of extra coordinates that can be interpreted as positions.Returns a description of this mode as an XML string.Returns an icon to identify this form in the GUI.Returns the user-directed name for this form.static PairLinkForm
Returns the singleton instance of this class.
-
Field Details
-
THICK_KEY
Line thickness config key.
-
-
Method Details
-
getFormName
Description copied from interface:ModePlotter.Form
Returns the user-directed name for this form.- Specified by:
getFormName
in interfaceModePlotter.Form
- Returns:
- form name
-
getFormIcon
Description copied from interface:ModePlotter.Form
Returns an icon to identify this form in the GUI.- Specified by:
getFormIcon
in interfaceModePlotter.Form
- Returns:
- form icon
-
getFormDescription
Description copied from interface:ShapeForm
Returns a description of this mode as an XML string. The return value should be one or more <p> elements.- Specified by:
getFormDescription
in interfaceShapeForm
- Returns:
- XML description of form
-
getBasicPositionCount
public int getBasicPositionCount()Description copied from interface:ShapeForm
Returns the number of basic data positions per tuple used by this form.- Specified by:
getBasicPositionCount
in interfaceShapeForm
- Returns:
- number of basic sets of positional coordinates
-
getExtraCoords
Description copied from interface:ShapeForm
Returns data coordinates additional to the basic position which are required to plot a point.- Specified by:
getExtraCoords
in interfaceShapeForm
- Returns:
- additional plot coordinates
-
getExtraPositionCount
public int getExtraPositionCount()Description copied from interface:ShapeForm
Returns the number of extra coordinates that can be interpreted as positions.- Specified by:
getExtraPositionCount
in interfaceShapeForm
- Returns:
- number of positional extra coordinates
-
adjustGeom
Description copied from interface:ShapeForm
Provides a DataGeom to be used by the layer this form makes, given a DataGeom that characterises the plotting environment. The output should be similar to the input, for instance implementing the same plotType-specific DataGeom subtype.In most cases the supplied DataGeom instance can be returned unchanged, but instances with special requirements may want to adjust how the data is interpreted.
- Specified by:
adjustGeom
in interfaceShapeForm
- Parameters:
geom
- context geomdataSpec
- data specification with which the geom will be usedstyle
- style with which the geom will be used- Returns:
- geom to use for data interpretation, the same or similar to the input
-
getConfigKeys
Description copied from interface:ShapeForm
Returns style configuration keys specific to this form. These keys will be used in the config map supplied toShapeForm.createOutliner(uk.ac.starlink.ttools.plot2.config.ConfigMap)
.- Specified by:
getConfigKeys
in interfaceShapeForm
- Returns:
- config keys
-
createOutliner
Description copied from interface:ShapeForm
Returns an object which will do the work of drawing shapes when supplied with the appropriate style information and data. The significant keys in the supplied config map are those given byShapeForm.getConfigKeys()
.- Specified by:
createOutliner
in interfaceShapeForm
- Parameters:
config
- configuration map from which values for this form's config keys will be extracted- Returns:
- new outliner object
-
getInstance
Returns the singleton instance of this class.- Returns:
- sole instance
-