Class CompositeChooser

All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, TabComponent

public class CompositeChooser extends JPanel implements TabComponent
The CompositeChooser class allows the user to select a red, green, and blue component variable for a color composite. The chooser signals a change in the composite specifications by firing a PropertyChangeEvent whose property name is CompositeChooser.RED_COMPONENT_PROPERTY, CompositeChooser.GREEN_COMPONENT_PROPERTY, or CompositeChooser.BLUE_COMPONENT_PROPERTY and new value contains a string for the new variable name. The chooser signals a change in composite mode by firing a CompositeChooser.COMPOSITE_MODE_PROPERTY with a boolean value.
Since:
3.1.7
Author:
Peter Hollemans
See Also:
  • Field Details

    • RED_COMPONENT_PROPERTY

      public static final String RED_COMPONENT_PROPERTY
      The red component property.
      See Also:
    • GREEN_COMPONENT_PROPERTY

      public static final String GREEN_COMPONENT_PROPERTY
      The green component property.
      See Also:
    • BLUE_COMPONENT_PROPERTY

      public static final String BLUE_COMPONENT_PROPERTY
      The blue component property.
      See Also:
    • COMPOSITE_MODE_PROPERTY

      public static final String COMPOSITE_MODE_PROPERTY
      The composite mode property.
      See Also:
  • Constructor Details

    • CompositeChooser

      public CompositeChooser(List<String> variableList)
      Creates a new composite chooser panel.
      Parameters:
      variableList - the list of variables to make available.
  • Method Details

    • getRedComponent

      public String getRedComponent()
      Gets the currently selected green component variable name.
      Returns:
      the red variable name.
    • getGreenComponent

      public String getGreenComponent()
      Gets the currently selected green component variable name.
      Returns:
      the green variable name.
    • getBlueComponent

      public String getBlueComponent()
      Gets the currently selected blue component variable name.
      Returns:
      the blue variable name.
    • getCompositeMode

      public boolean getCompositeMode()
      Gets the composite mode flag.
      Returns:
      the mode flag, true if color composite mode is on or false if not.
    • dispose

      public void dispose()
      Disposes of any resources used by this chooser.
      Since:
      3.3.1
    • getIcon

      public Icon getIcon()
      Description copied from interface: TabComponent
      Gets the tab icon.
      Specified by:
      getIcon in interface TabComponent
      Returns:
      the icon to be used if the tab is to have an icon beside the title label, or null if no icon is required.
    • getToolTip

      public String getToolTip()
      Description copied from interface: TabComponent
      Gets the tab tooltip.
      Specified by:
      getToolTip in interface TabComponent
      Returns:
      the tooltip text if the tab is to have an appearing tooltip when the mouse hovers over the tab, or null if no tooltip is required.
    • getTitle

      public String getTitle()
      Description copied from interface: TabComponent
      Gets the tab title.
      Specified by:
      getTitle in interface TabComponent
      Returns:
      the title to be used if the tab is to have a text label as a title, or null if no title is required.
    • main

      public static void main(String[] argv)
      Tests this class.
      Parameters:
      argv - the array of command line parameters.