Package uk.ac.starlink.topcat.plot2
Class BasicCoordLayerControl
java.lang.Object
uk.ac.starlink.topcat.plot2.TabberControl
uk.ac.starlink.topcat.plot2.ConfigControl
uk.ac.starlink.topcat.plot2.BasicCoordLayerControl
- All Implemented Interfaces:
Configger
,Control
,LayerControl
- Direct Known Subclasses:
HealpixLayerControl
,SpectrogramLayerControl
LayerControl for a single plotter with coordinates.
- Since:
- 25 Nov 2013
- Author:
- Mark Taylor
-
Constructor Summary
ConstructorsConstructorDescriptionBasicCoordLayerControl
(uk.ac.starlink.ttools.plot2.Plotter<?> plotter, uk.ac.starlink.ttools.plot2.config.Specifier<ZoneId> zsel, PositionCoordPanel coordPanel, ListModel<TopcatModel> tablesModel, Configger baseConfigger, boolean autoPopulate) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionuk.ac.starlink.ttools.plot2.config.ConfigMap
Returns a single config map containing all of the config information gathered by this control.Returns a short string to label this control, visible in the stack.getCoordLabel
(String userCoordName) Returns a text label associated with one of the user coords for this control, typically the name of the column or expression supplying the data.protected PositionCoordPanel
Returns the coord panel.Returns the layers contributed by this control.uk.ac.starlink.ttools.plot2.LegendEntry[]
Returns legend entries associated with this control.Returns the selection widget for choosing which table this control is working with.uk.ac.starlink.ttools.plot2.config.Specifier<ZoneId>
Returns a specifier that determines which zone of a multi-zone plot this control's layers will be displayed in.void
setTopcatModel
(TopcatModel tcModel) Sets in the GUI the topcat model for which this control is making plots.void
submitReports
(Map<LayerId, uk.ac.starlink.ttools.plot2.ReportMap> reports) Accepts report information generated by plotting layers.protected void
tableChanged
(TopcatModel tcModel) Called when the TopcatModel for which this control is generating plots is changed.Methods inherited from class uk.ac.starlink.topcat.plot2.ConfigControl
addSpecifierTab, getConfigSpecifiers
Methods inherited from class uk.ac.starlink.topcat.plot2.TabberControl
addActionListener, addControlTab, addZoneTab, getActionForwarder, getControlIcon, getPanel, getTabber, removeActionListener
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface uk.ac.starlink.topcat.plot2.Control
addActionListener, getControlIcon, getPanel, removeActionListener
-
Constructor Details
-
BasicCoordLayerControl
public BasicCoordLayerControl(uk.ac.starlink.ttools.plot2.Plotter<?> plotter, uk.ac.starlink.ttools.plot2.config.Specifier<ZoneId> zsel, PositionCoordPanel coordPanel, ListModel<TopcatModel> tablesModel, Configger baseConfigger, boolean autoPopulate) Constructor.- Parameters:
plotter
- plotterzsel
- zone id specifier, may be null for single-zone casecoordPanel
- panel which displays the plotter's coordinates, and supplies a DataGeomtablesModel
- list of available tablesbaseConfigger
- provides global configuration infoautoPopulate
- if true, when the table is changed an attempt will be made to initialise the coordinate fields with some suitable values
-
-
Method Details
-
getControlLabel
Description copied from interface:Control
Returns a short string to label this control, visible in the stack.- Specified by:
getControlLabel
in interfaceControl
- Overrides:
getControlLabel
in classTabberControl
- Returns:
- label
-
getLayers
Description copied from interface:LayerControl
Returns the layers contributed by this control.- Specified by:
getLayers
in interfaceLayerControl
- Returns:
- layers
-
getCoordLabel
Description copied from interface:LayerControl
Returns a text label associated with one of the user coords for this control, typically the name of the column or expression supplying the data. Null may be returned if there's no good answer.- Specified by:
getCoordLabel
in interfaceLayerControl
- Parameters:
userCoordName
- name of one of the user value infos of an input coord for this control- Returns:
- text label associated with user coordinate
-
getLegendEntries
public uk.ac.starlink.ttools.plot2.LegendEntry[] getLegendEntries()Description copied from interface:LayerControl
Returns legend entries associated with this control.- Specified by:
getLegendEntries
in interfaceLayerControl
- Returns:
- legend entries
-
getZoneSpecifier
Description copied from interface:LayerControl
Returns a specifier that determines which zone of a multi-zone plot this control's layers will be displayed in. If this control is known to be used in a single-zone context, null should be returned.- Specified by:
getZoneSpecifier
in interfaceLayerControl
- Returns:
- zone id specifier, or null
-
getTableSelector
Description copied from interface:LayerControl
Returns the selection widget for choosing which table this control is working with. If this control does not use a table, null is returned. The assumption is (currently) that a given control uses a maximum of one table.- Specified by:
getTableSelector
in interfaceLayerControl
- Returns:
- table selector, or null
-
getConfig
public uk.ac.starlink.ttools.plot2.config.ConfigMap getConfig()Description copied from class:ConfigControl
Returns a single config map containing all of the config information gathered by this control. The returned map is the union of all the configs gathered from the specifiers added by theaddSpecifierTab
method.- Specified by:
getConfig
in interfaceConfigger
- Overrides:
getConfig
in classConfigControl
- Returns:
- all configuration information gathered by this control
-
submitReports
Description copied from interface:LayerControl
Accepts report information generated by plotting layers. The submitted map may contain entries unrelated to this layer. Null map values are permitted, with the same meaning as an empty map.- Specified by:
submitReports
in interfaceLayerControl
- Parameters:
reports
- per-layer plot reports for layers generated on behalf of this and possibly other controls
-
setTopcatModel
Sets in the GUI the topcat model for which this control is making plots.- Parameters:
tcModel
- new topcat model
-
getCoordPanel
Returns the coord panel.- Returns:
- coord panel
-
tableChanged
Called when the TopcatModel for which this control is generating plots is changed. Usually this will be because the user has selected a new table from the table selector.- Parameters:
tcModel
- new topcat model, may be null
-