TextSupplier (adams-pom 24.11.0-SNAPSHOT API)

All Superinterfaces:

TextSupporter

All Known Implementing Classes:

AbstractMultiView.ViewWrapper, AbstractScatterPlot, AbstractTextAndComponentDisplayPanel, AbstractTextDisplayPanel, AbstractTextualDisplay, ConsoleWindow, ContainerDisplay, Display, DisplayPanelManager, DOMDisplay, EmailViewer, FlowDisplay, Histogram, Histogram, HistoryDisplay, Html4Display, JsonDisplay, PropertiesDisplay, ReportDisplay, ScatterDisplay, ScatterPlot, ScatterPlotSimple, SequencePlotter, SimplePlot, SpreadSheetDisplay, SpreadSheetDisplay.SpreadSheetDisplayPanel, SpreadSheetRowViewer, TabView, TextEditorPanel, WekaInstancesDisplay, WekaInstanceViewer
```
public interface TextSupplier
extends TextSupporter
```
Interface for sinks that supply a string. This can be used for saving this text.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getCustomSupplyTextMenuItemCaption()`	Returns the text for the menu item.
`ExtensionFileFilter`	`getCustomTextFileFilter()`	Returns a custom file filter for the file chooser.
`String`	`supplyText()`	Supplies the text.

- Method Detail
  - getCustomSupplyTextMenuItemCaption
```
String getCustomSupplyTextMenuItemCaption()
```
    Returns the text for the menu item.
    
    Returns:
    
    the menu item text, null for default
  - getCustomTextFileFilter
```
ExtensionFileFilter getCustomTextFileFilter()
```
    Returns a custom file filter for the file chooser.
    
    Returns:
    
    the file filter, null if to use default one
  - supplyText
```
String supplyText()
```
    Supplies the text. May get called even if actor hasn't been executed yet.
    
    Specified by:
    
    supplyText in interface TextSupporter
    
    Returns:
    
    the text, null if none available