uk.ac.starlink.topcat.plot2
Class OptionalConfigSpecifier

java.lang.Object
  extended by uk.ac.starlink.ttools.plot2.config.SpecifierPanel<uk.ac.starlink.ttools.plot2.config.ConfigMap>
      extended by uk.ac.starlink.topcat.plot2.ConfigSpecifier
          extended by uk.ac.starlink.topcat.plot2.OptionalConfigSpecifier
All Implemented Interfaces:
uk.ac.starlink.ttools.plot2.config.Specifier<uk.ac.starlink.ttools.plot2.config.ConfigMap>

public class OptionalConfigSpecifier
extends ConfigSpecifier

ConfigSpecifier subclass that adds checkboxes for some of its component specifiers, indicating whether those specifiers should be used for the result or not. Where they are not used, the relevant GUI controls are disabled.

This is quite like AutoConfigSpecifier, but the override value is not reflected in the GUI. Perhaps the two classes should be combined?

Since:
18 Mar 2013
Author:
Mark Taylor

Nested Class Summary
 
Nested classes/interfaces inherited from class uk.ac.starlink.topcat.plot2.ConfigSpecifier
ConfigSpecifier.ComponentGui
 
Constructor Summary
OptionalConfigSpecifier(uk.ac.starlink.ttools.plot2.config.ConfigKey<?>[] allKeys, uk.ac.starlink.ttools.plot2.config.ConfigKey<?>[] optKeys, String optionText)
          Constructor.
 
Method Summary
 void configureFrom(OptionalConfigSpecifier template)
          Configures this specifier with the current state of a supplied template.
 uk.ac.starlink.ttools.plot2.config.ConfigMap getSpecifiedValue()
           
 
Methods inherited from class uk.ac.starlink.topcat.plot2.ConfigSpecifier
checkConfig, checkRangeSense, createComponent, getConfigKeys, getSpecifier, reportError, setSpecifiedValue, submitReport
 
Methods inherited from class uk.ac.starlink.ttools.plot2.config.SpecifierPanel
addActionListener, fireAction, getActionForwarder, getChangeForwarder, getComponent, isXFill, removeActionListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OptionalConfigSpecifier

public OptionalConfigSpecifier(uk.ac.starlink.ttools.plot2.config.ConfigKey<?>[] allKeys,
                               uk.ac.starlink.ttools.plot2.config.ConfigKey<?>[] optKeys,
                               String optionText)
Constructor.

Parameters:
allKeys - all of the keys
optKeys - subset of allKeys which should be annotated with activation checkboxes; any entries not contained in allKeys are ignored
optionText - text to annotate the checkboxes
Method Detail

getSpecifiedValue

public uk.ac.starlink.ttools.plot2.config.ConfigMap getSpecifiedValue()
Specified by:
getSpecifiedValue in interface uk.ac.starlink.ttools.plot2.config.Specifier<uk.ac.starlink.ttools.plot2.config.ConfigMap>
Overrides:
getSpecifiedValue in class ConfigSpecifier

configureFrom

public void configureFrom(OptionalConfigSpecifier template)
Configures this specifier with the current state of a supplied template.

Parameters:
template - specifier supplying required configuration


Copyright © 2003-2018 CCLRC: Council for the Central Laboratory of the Research Councils. All Rights Reserved.