Class PairLinkForm
- java.lang.Object
-
- uk.ac.starlink.ttools.plot2.layer.PairLinkForm
-
- All Implemented Interfaces:
ModePlotter.Form
,ShapeForm
public class PairLinkForm extends java.lang.Object implements ShapeForm
Draws a line between two related positions. Singleton class.- Since:
- 28 Nov 2013
- Author:
- Mark Taylor
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DataGeom
adjustGeom(DataGeom geom)
Provides a DataGeom to be used by the layer this form makes, given a DataGeom that characterises the plotting environment.Outliner
createOutliner(ConfigMap config)
Returns an object which will do the work of drawing shapes when supplied with the appropriate style information and data.ConfigKey<?>[]
getConfigKeys()
Returns style configuration keys specific to this form.Coord[]
getExtraCoords()
Returns data coordinates additional to the basic position which are required to plot a point.java.lang.String
getFormDescription()
Returns a description of this mode as an XML string.javax.swing.Icon
getFormIcon()
Returns an icon to identify this form in the GUI.java.lang.String
getFormName()
Returns the user-directed name for this form.static PairLinkForm
getInstance()
Returns the singleton instance of this class.int
getPositionCount()
Returns the number of data positions per tuple used by this form.
-
-
-
Field Detail
-
THICK_KEY
public static final ConfigKey<java.lang.Integer> THICK_KEY
Line thickness config key.
-
-
Method Detail
-
getFormName
public java.lang.String 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
public javax.swing.Icon 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
public java.lang.String 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
-
getPositionCount
public int getPositionCount()
Description copied from interface:ShapeForm
Returns the number of data positions per tuple used by this form.- Specified by:
getPositionCount
in interfaceShapeForm
- Returns:
- number of sets of positional coordinates
-
getExtraCoords
public Coord[] 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
-
adjustGeom
public DataGeom adjustGeom(DataGeom geom)
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 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 geom- Returns:
- geom to use for data interpretation, the same or similar to the input
-
getConfigKeys
public ConfigKey<?>[] 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
public Outliner createOutliner(ConfigMap config)
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
public static PairLinkForm getInstance()
Returns the singleton instance of this class.- Returns:
- sole instance
-
-