InteractionDisplayLocationSupporter (adams-pom 24.5.0-SNAPSHOT API)

All Superinterfaces:

Destroyable, OptionHandler

All Known Implementing Classes:

EnterManyValues, EnterValue, PromptUser, SelectDirectory, SelectFile
```
public interface InteractionDisplayLocationSupporter
extends OptionHandler
```
Interface for classes that allow the user to choose where to display their interaction.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`displayLocationTipText()`	Returns the tip text for this property.
`InteractionDisplayLocation`	`getDisplayLocation()`	Returns where the interaction is being displayed.
`void`	`setDisplayLocation(InteractionDisplayLocation value)`	Sets where the interaction is being displayed.

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

- Method Detail
  - setDisplayLocation
```
void setDisplayLocation(InteractionDisplayLocation value)
```
    Sets where the interaction is being displayed.
    
    Parameters:
    
    value - the location
  - getDisplayLocation
```
InteractionDisplayLocation getDisplayLocation()
```
    Returns where the interaction is being displayed.
    
    Returns:
    
    the location
  - displayLocationTipText
```
String displayLocationTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.