Package VASSAL.build.module.map.deck

Interface DeckKeyCommand

All Known Implementing Classes:
AbstractDeckKeyCommand, DeckSendKeyCommand, DeckSortKeyCommand
public interface DeckKeyCommand

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    deregisterListeners()
    Remove any Listener previously registered for this DeckKeyCommand
    String[]
    getAdditionalReportProperties()
    Return an array of additional report parameters that can be used in the Report format message of a Deck Key Command
    List<KeyCommand>
    getKeyCommands(Deck deck)
    Return a list of KeyCommands provided by this DeckKeyCommand
    void
    registerListeners(Deck deck)
    Register any Listeners for Keystroke provided by this DeckKeyCommand

  • Method Details

    • getKeyCommands

      List<KeyCommand> getKeyCommands(Deck deck)
      Return a list of KeyCommands provided by this DeckKeyCommand
      Parameters:
      deck - The Deck to perform the Commands on
      Returns:
      List of KeyCommands

    • registerListeners

      void registerListeners(Deck deck)
      Register any Listeners for Keystroke provided by this DeckKeyCommand
      Parameters:
      deck - The Deck to perform the actions on if KeyStroke seem

    • deregisterListeners

      void deregisterListeners()
      Remove any Listener previously registered for this DeckKeyCommand

    • getAdditionalReportProperties

      String[] getAdditionalReportProperties()
      Return an array of additional report parameters that can be used in the Report format message of a Deck Key Command
      Returns:
      Array of property names