Package VASSAL.search

Interface SearchTarget

All Known Implementing Classes:
AboutScreen, AbstractConfigurable, AbstractScript, AbstractToolbarItem, ActionButton, ActionScript, AreaOfEffect, BasicModule, BasicPreference, Board, BooleanPreference, BoxWidget, BrowserPDFFile, BshPlugin, CalculatedProperty, CardSlot, ChangePropertyButton, Chart, ChartWindow, ChessClock, ChessClockControl, Clone, ColorManager, ColorSwatch, CounterDetailViewer, CounterGlobalKeyCommand, CounterTurnLevel, DeckGlobalKeyCommand, Decorator, Delete, Deselect, DiceButton, DieManager, DoActionButton, Documentation, DoublePreference, DrawPile, DynamicProperty, Embellishment, Embellishment0, EnumPreference, Flare, FontManager, FontStyle, Footprint, FreeRotator, GameModule, GamePieceImage, GamePieceImageDefinitions, GamePieceLayout, GamePieceLayoutsContainer, GeneralScript, GlobalCommandTarget, GlobalHotKey, GlobalKeyCommand, GlobalMap, GlobalMap.CounterViewer, GlobalOptions, GlobalProperties, GlobalProperty, GlobalTranslatableMessage, GlobalTranslatableMessages, HandMetrics, HelpFile, HexGrid, HexGridNumbering, Hideable, HidePiecesButton, HighlightLastMoved, HtmlChart, IconFamily, ImageItem, ImageItemInstance, ImageSaver, Immobilized, IntegerPreference, InternetDiceButton, Inventory, Item, ItemInstance, Labeler, Language, LayerControl, LayeredPieceCollection, ListTurnLevel, ListWidget, Localization, LOS_Thread, Map, MapShader, MapWidget, Marker, MassKeyCommand, MenuSeparator, MovementMarkable, MultiActionButton, NonRectangular, NotesWindow, Obscurable, PanelWidget, PieceRecenterer, PieceSlot, PieceWindow, Pivot, PlaceMarker, PlayerHand, PlayerRoster, PlaySound, Plugin, PredefinedSetup, PrivateMap, PropertySheet, PrototypeDefinition, PrototypesContainer, RandomTextButton, Region, RegionGrid, RegularGridNumbering, Replace, ReportState, RestrictCommands, Restricted, ReturnToDeck, ScriptContainer, SelectionHighlighter, SelectionHighlighters, SendToLocation, SetGlobalProperty, SetupStack, ShapeItem, ShapeItemInstance, SpecialDiceButton, SpecialDie, SpecialDieFace, SquareGrid, SquareGridNumbering, StackMetrics, StartupGlobalKeyCommand, StringPreference, SubMenu, SymbolItem, SymbolItemInstance, TableInfo, TabWidget, TextBoxItem, TextBoxItemInstance, TextItem, TextItemInstance, TextPreference, TextSaver, ToolbarMenu, TranslatableMarker, TranslatableMessage, Translate, Translation, TriggerAction, TurnComponent, TurnGlobalHotkey, TurnLevel, TurnTracker, Tutorial, UsePrototype, VassalTranslation, Widget, WidgetMap, Zone, ZonedGrid, ZonedGridHighlighter, ZoneHighlight, ZoneProperty, Zoomer
public interface SearchTarget
An interface for "things the editor might search for with its 'Search' function" to ship off convenient packages of searchable strings in various categories. Implemented by things like AbstractConfigurable (for most module components) and Decorator (for piece traits)

  • Method Details

    • getExpressionList

      List<String> getExpressionList()
      Returns:
      a list of the item's string/expression fields if any (for search)

    • getFormattedStringList

      List<String> getFormattedStringList()
      Returns:
      a list of any Message Format strings referenced in the item, if any (for search)

    • getMenuTextList

      List<String> getMenuTextList()
      Returns:
      a list of any Menu/Button/Tooltip Text strings referenced in the item, if any (for search)

    • getNamedKeyStrokeList

      List<NamedKeyStroke> getNamedKeyStrokeList()
      Returns:
      a list of any Named KeyStrokes referenced in the item, if any (for search)

    • getPropertyList

      List<String> getPropertyList()
      Returns:
      a list of any Property Names referenced in the item, if any (for search)