Class ScrollableOptionsEditor

  • All Implemented Interfaces:
    OptionsEditor

    public class ScrollableOptionsEditor
    extends java.lang.Object
    implements OptionsEditor
    Panel that shows each property in an Options category or a Group in an Options category
    • Constructor Summary

      Constructors 
      Constructor Description
      ScrollableOptionsEditor​(java.lang.String title)
      Creates a panel for editing options.
      ScrollableOptionsEditor​(java.lang.String title, java.util.List<java.lang.String> optionNames)
      Creates a panel for editing options.
    • Constructor Detail

      • ScrollableOptionsEditor

        public ScrollableOptionsEditor​(java.lang.String title,
                                       java.util.List<java.lang.String> optionNames)
        Creates a panel for editing options. This version of the constructor allows the client to specify the option names to put them in some order other than the default alphabetical ordering.
        Parameters:
        title - The title of the options panel
        optionNames - the names of the options for this panel
      • ScrollableOptionsEditor

        public ScrollableOptionsEditor​(java.lang.String title)
        Creates a panel for editing options. This version of the constructor will get the options names from the options object when getEditorComponent(Options, EditorStateFactory) is called.
        Parameters:
        title - the title for the panel
    • Method Detail

      • reload

        public void reload()
        Description copied from interface: OptionsEditor
        A signal to reload the GUI widgets in the component created by this editor. This will happen when the options change out from under the editor, such as when the user restores the default options values.
        Specified by:
        reload in interface OptionsEditor
      • getEditorComponent

        public javax.swing.JComponent getEditorComponent​(Options options,
                                                         EditorStateFactory factory)
        Description copied from interface: OptionsEditor
        Get the editor component.
        Specified by:
        getEditorComponent in interface OptionsEditor
        Parameters:
        options - The editable options that for which a GUI component will be created
        factory - The factory that will provide state objects this options editor
      • getComponent

        public javax.swing.JComponent getComponent()