Package VASSAL.search

Interface ImageSearchTarget

All Known Implementing Classes:
AboutScreen, AbstractBuildable, AbstractConfigurable, AbstractImageFinder, AbstractScript, AbstractToolbarItem, ActionButton, ActionScript, AreaOfEffect, BasicModule, BasicPiece, BasicPreference, Board, BoardPicker, BooleanPreference, BoxWidget, BrowserHelpFile, BrowserPDFFile, BshPlugin, CalculatedProperty, CardSlot, ChangePropertyButton, Chart, ChartWindow, ChatServerControls, ChessClock, ChessClockControl, Clone, ColorManager, ColorSwatch, ConnectionWindow, CounterDetailViewer, CounterGlobalKeyCommand, CounterTurnLevel, Deck, DeckGlobalKeyCommand, Decorator, Delete, Deselect, DiceButton, DieManager, DoActionButton, Documentation, DoublePreference, DrawPile, DynamicProperty, Embellishment, Embellishment0, EnumPreference, EventLog, Flare, FontManager, FontStyle, Footprint, FreeRotator, GameModule, GamePieceImage, GamePieceImageDefinitions, GamePieceLayout, GamePieceLayoutsContainer, GeneralScript, 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, MapCenterer, MapShader, MapWidget, Marker, MassKeyCommand, MenuSeparator, ModuleExtension, ModulePlugin, MovementMarkable, MultiActionButton, NonRectangular, NotesWindow, Obscurable, PanelWidget, PieceMover, PieceRecenterer, PieceSlot, PieceWindow, Pivot, PlaceMarker, PlayerHand, PlayerRoster, PlaySound, Plugin, PredefinedSetup, PrivateMap, PropertySheet, PrototypeDefinition, PrototypesContainer, RandomTextButton, Region, RegionGrid, RegularGridNumbering, Replace, ReportState, RestrictCommands, Restricted, ReturnToDeck, ScriptContainer, Scroller, SelectionHighlighter, SelectionHighlighters, SendToLocation, SetGlobalProperty, SetupStack, ShapeItem, ShapeItemInstance, SpecialDiceButton, SpecialDie, SpecialDieFace, SquareGrid, SquareGridNumbering, Stack, 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 ImageSearchTarget
An interface for "things that contain images" to ship off convenient packages of filename. Used for finding what images can be removed from a module. Also will probably get added to search functions. Implemented by AbstractBuildable (for most module components)

  • Method Details

    • getAllImageNames

      SortedSet<String> getAllImageNames()
      Returns:
      names of all images used by the component and any children

    • addImageNamesRecursively

      void addImageNamesRecursively​(Collection<String> s)
      Adds all images used by this component AND any children to the collection
      Parameters:
      s - Collection to add image names to

    • getLocalImageNames

      SortedSet<String> getLocalImageNames()
      Returns:
      names of all images used by this item

    • addLocalImageNames

      void addLocalImageNames​(Collection<String> s)
      Implementing classes should add the names of any image files they use to the collection.
      Parameters:
      s - Collection to add image names to