Class FormLayerControl

java.lang.Object
uk.ac.starlink.topcat.plot2.TabberControl
uk.ac.starlink.topcat.plot2.FormLayerControl
All Implemented Interfaces:
Control, LayerControl
Direct Known Subclasses:
MultiFormLayerControl, SingleFormLayerControl
public abstract class FormLayerControl extends TabberControl implements LayerControl
Plot layer control which manages coordinates and subsets in a common way for multiple layers defined by one or more forms. It provides a tab for common coordinates (including table) and a tab for configuring subset-specific defaults. Concrete subclasses must provide their form panels.
Since:
8 Jan 2014
Author:
Mark Taylor

  • Constructor Details

    • FormLayerControl

      protected FormLayerControl(PlotTypeGui<?,?> plotTypeGui, PositionCoordPanel posCoordPanel, ListModel<TopcatModel> tablesModel, uk.ac.starlink.ttools.plot2.config.Specifier<ZoneId> zsel, boolean autoPopulate, NextSupplier nextSupplier, TopcatListener tcListener, Icon controlIcon)
      Constructor.
      Parameters:
      plotTypeGui - plot type
      posCoordPanel - panel for entering table and basic positional coordinates
      tablesModel - list of available tables
      zsel - zone id specifier, may be null for single-zone plots
      autoPopulate - if true, when the table is changed an attempt will be made to initialise the coordinate fields with some suitable values
      nextSupplier - manages global dispensing for some style options
      tcListener - listener for TopcatEvents; this manager will arrange for it to listen to whatever is the currently selected TopcatModel
      controlIcon - icon for control stack

  • Method Details

    • getControlLabel

      public String getControlLabel()
      Description copied from interface: Control
      Returns a short string to label this control, visible in the stack.
      Specified by:
      getControlLabel in interface Control
      Overrides:
      getControlLabel in class TabberControl
      Returns:
      label

    • getPositionCoordPanel

      public PositionCoordPanel getPositionCoordPanel()
      Returns the panel in which positional coordinates are entered.
      Returns:
      positional coordinate panel

    • getSubsetManager

      public SubsetConfigManager getSubsetManager()
      Returns this control's per-subset configuration manager.
      Returns:
      subset manager

    • getSubsetStack

      public SubsetStack getSubsetStack()
      Returns this control's selectable stack of subsets.
      Returns:
      subset stack

    • getFormControls

      protected abstract FormControl[] getFormControls()
      Returns a list of all the form controls, active or not, currently managd by this layer control.
      Returns:
      list of all form controls

    • isControlActive

      protected abstract boolean isControlActive(FormControl fc)
      Indicates whether a given form control is contributing the the plot on behalf of this layer control.
      Parameters:
      fc - form control managed by this layer control
      Returns:
      true iff fc is active (contributing to plot)

    • getPlotters

      public uk.ac.starlink.ttools.plot2.Plotter<?>[] getPlotters()
      Description copied from interface: LayerControl
      Returns a list of the plotters that will be used by this control to create layers.
      Specified by:
      getPlotters in interface LayerControl
      Returns:
      list of active plotters

    • hasLayers

      public boolean hasLayers()
      Description copied from interface: LayerControl
      Indicates whether this control will yield any layers in its current state. It returns true if getLayers will return a non-empty array. False positives are best avoided, but permitted.
      Specified by:
      hasLayers in interface LayerControl
      Returns:
      true if there is a non-zero number of layers

    • getLayers

      public TopcatLayer[] getLayers(uk.ac.starlink.ttools.plot2.Ganger<?,?> ganger)
      Description copied from interface: LayerControl
      Returns the layers contributed by this control.
      Specified by:
      getLayers in interface LayerControl
      Parameters:
      ganger - ganger within which layers will be used
      Returns:
      layers

    • 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 interface LayerControl
      Returns:
      legend entries

    • getLegendLabel

      public String getLegendLabel(RowSubset rset)
      Returns the label to use in the legend for a given row subset controlled by this control. Null means the item should not appear in the legend.
      Parameters:
      rset - row subset
      Returns:
      legend label, or null if absent from legend

    • getZoneSpecifier

      public uk.ac.starlink.ttools.plot2.config.Specifier<ZoneId> 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 interface LayerControl
      Returns:
      zone id specifier, or null

    • getTableSelector

      public TablesListComboBox 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 interface LayerControl
      Returns:
      table selector, or null

    • submitReports

      public void submitReports(Map<LayerId, uk.ac.starlink.ttools.plot2.ReportMap> reports, uk.ac.starlink.ttools.plot2.Ganger<?,?> ganger)
      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 interface LayerControl
      Parameters:
      reports - per-layer plot reports for layers generated on behalf of this and possibly other controls
      ganger - ganger within which layers will be used

    • getActiveFormControls

      public FormControl[] getActiveFormControls()
      Returns the controls in the form control list which are contributing to the plot. Controls that the user has deactivated (unchecked) are ignored.
      Returns:
      list of active form controls

    • getCoordLabel

      public String getCoordLabel(String userCoordName)
      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 interface LayerControl
      Parameters:
      userCoordName - name of one of the user value infos of an input coord for this control
      Returns:
      text label associated with user coordinate

    • setTopcatModel

      public void setTopcatModel(TopcatModel tcModel)
      Sets in the GUI the topcat model for which this control is making plots.
      Parameters:
      tcModel - new topcat model

    • getTopcatModel

      public TopcatModel getTopcatModel()
      Returns the table for which this control is currently making plots.
      Returns:
      topcat model