Package VASSAL.configure

Interface ConfigurableList

All Known Implementing Classes:
DynamicKeyCommandListConfigurer, FormattedStringArrayConfigurer, NamedKeyStrokeArrayConfigurer, StringArrayConfigurer
public interface ConfigurableList
An interface to be implemented by Configurers that manage variable sized lists. See also ConfigurableListEntry, ConfigurableListController

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static int
    DEFAULT_ICON_SIZE
    The Default Icon Size to use for all Configurable List related button icons

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addEntry()
    Add a new list entry after the currently selected entry, or at the bottom of the list if no entries selected.
    void
    deleteEntry​(ConfigurableListEntry entry)
    Remove the specified entry from the list.
    void
    entryChanged​(ConfigurableListEntry entry)
    An entry has had it's value changed
    JComponent
    getListController()
    Return the ListController associated with this Configurable List
    int
    getSelectedEntryIndex()
    Return the index of the currently selected entry
    void
    moveEntryDown()
    Move the currently selected list entry down one position The moved entry should retain the selection
    void
    moveEntryUp()
    Move the currently selected list entry up one position The moved entry should retain the selection
    void
    repack()
    Repack the Configurer
    void
    selectEntry​(ConfigurableListEntry entry)
    Set the selection to the specified list entry.
    void
    setSelectedEntryIndex​(int index)
    Set the currently selected entry

  • Field Details

    • DEFAULT_ICON_SIZE

      static final int DEFAULT_ICON_SIZE
      The Default Icon Size to use for all Configurable List related button icons
      See Also:
      Constant Field Values

  • Method Details

    • moveEntryUp

      void moveEntryUp()
      Move the currently selected list entry up one position The moved entry should retain the selection

    • moveEntryDown

      void moveEntryDown()
      Move the currently selected list entry down one position The moved entry should retain the selection

    • addEntry

      void addEntry()
      Add a new list entry after the currently selected entry, or at the bottom of the list if no entries selected. The new entry should be selected.

    • deleteEntry

      void deleteEntry​(ConfigurableListEntry entry)
      Remove the specified entry from the list. The entry following the removed entry should be selected, or the last entry in the list if the deleted entry was last.
      Parameters:
      entry - Entry to delete.

    • getListController

      JComponent getListController()
      Return the ListController associated with this Configurable List
      Returns:
      List Controller

    • selectEntry

      void selectEntry​(ConfigurableListEntry entry)
      Set the selection to the specified list entry.
      Parameters:
      entry - Entry to select

    • repack

      void repack()
      Repack the Configurer

    • setSelectedEntryIndex

      void setSelectedEntryIndex​(int index)
      Set the currently selected entry
      Parameters:
      index - Index of currently selected entry

    • getSelectedEntryIndex

      int getSelectedEntryIndex()
      Return the index of the currently selected entry
      Returns:
      currently selected entry index

    • entryChanged

      void entryChanged​(ConfigurableListEntry entry)
      An entry has had it's value changed
      Parameters:
      entry - Changed Entry