Package VASSAL.build

Interface Configurable

All Superinterfaces:
Buildable, Translatable
All Known Subinterfaces:
AutoConfigurable
All Known Implementing Classes:
AboutScreen, AbstractConfigurable, AbstractScript, AbstractToolbarItem, ActionScript, BasicModule, BasicPreference, Board, BoardPicker, BooleanPreference, BoxWidget, BrowserHelpFile, BrowserHelpFile.ConfigSupport, BrowserPDFFile, BshPlugin, CardSlot, ChangePropertyButton, Chart, ChartWindow, ChessClock, ChessClockControl, ColorManager, ColorSwatch, CounterDetailViewer, CounterTurnLevel, DeckGlobalKeyCommand, DiceButton, DieManager, DoActionButton, Documentation, DoublePreference, DrawPile, EnumPreference, Flare, FontManager, FontStyle, GameModule, GamePieceImage, GamePieceImageDefinitions, GamePieceLayout, GamePieceLayoutsContainer, GeneralScript, GlobalKeyCommand, GlobalMap, GlobalMap.CounterViewer, GlobalOptions, GlobalProperties, GlobalProperty, GlobalTranslatableMessage, GlobalTranslatableMessages, HandMetrics, HelpFile, HexGrid, HexGridNumbering, HidePiecesButton, HighlightLastMoved, HtmlChart, IconFamily, ImageItem, ImageItemInstance, ImageSaver, IntegerPreference, InternetDiceButton, Inventory, Item, ItemInstance, Language, LayerControl, LayeredPieceCollection, ListTurnLevel, ListWidget, Localization, LOS_Thread, Map, MapShader, MapWidget, MassKeyCommand, MultiActionButton, NotesWindow, PanelWidget, PieceRecenterer, PieceSlot, PieceWindow, PlayerHand, PlayerRoster, Plugin, PredefinedSetup, PrivateMap, PrototypeDefinition, PrototypesContainer, RandomTextButton, Region, RegionGrid, RegularGridNumbering, ScriptContainer, SelectionHighlighter, SelectionHighlighters, SetupStack, ShapeItem, ShapeItemInstance, SpecialDiceButton, SpecialDie, SpecialDieFace, SquareGrid, SquareGridNumbering, StackMetrics, StartupGlobalKeyCommand, StringPreference, SymbolItem, SymbolItemInstance, TabWidget, TextBoxItem, TextBoxItemInstance, TextItem, TextItemInstance, TextPreference, TextSaver, ToolbarMenu, TranslatableMarker, Translation, TurnComponent, TurnGlobalHotkey, TurnLevel, TurnTracker, Tutorial, VassalTranslation, Widget, WidgetMap, Zone, ZonedGrid, ZonedGridHighlighter, ZoneHighlight, ZoneProperty, Zoomer
public interface Configurable extends Translatable
An object that implements the Configurable interface, in addition to being built from a configuration XML file (because this class ultimately extends Buildable, can be manipulated by the user directly in the VASSAL module editor via the Configuration window. It also extends the Translatable interface which provides methods for the getting and setting of XML attributes and adds i18n translation infrastructure.

  • Field Details

  • Method Details

    • removeFrom

      void removeFrom​(Buildable parent)
      Remove this component from its parent

    • remove

      void remove​(Buildable child)
      Remove a child component

    • getConfigureName

      String getConfigureName()
      The name of this Configurable Object

    • getHelpFile

      HelpFile getHelpFile()
      Returns:
      a HelpFile describing how to use and configure * this component

    • getConfigureComponents

      Configurable[] getConfigureComponents()
      Returns:
      an array of Configurer objects representing the Configurable children of this Configurable object

    • getConfigurer

      Configurer getConfigurer()
      Returns:
      a Configurer object which can be used to set the attributes of this object

    • getAllowableConfigureComponents

      Class[] getAllowableConfigureComponents()
      Returns:
      a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

    • addPropertyChangeListener

      void addPropertyChangeListener​(PropertyChangeListener l)
      Add a PropertyChangeListener. A PropertyChangeEvent should be fired with property name NAME_PROPERTY when the value returned from getConfigureName() has changed