BioOption (LOCI Javadocs 0-SNAPSHOT API)

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- loci.visbio.state.BioOption

All Implemented Interfaces:

Saveable

Direct Known Subclasses:

BooleanOption, CustomOption, ListOption, NumericOption, ResolutionOption, ResolutionToggleOption, SpreadsheetLaunchOption, StringOption
```
public abstract class BioOption
extends Object
implements Saveable
```
BioOption represents an option in the VisBio Options dialog.

Field Summary

Fields
Modifier and Type Field and Description

protected String text
String identifying this option.

Constructor Summary

Constructors
Constructor and Description

BioOption(String text)
Constructs a new option.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract Component`	`getComponent()` Gets a GUI component representing this option.
`String`	`getText()` Gets text identifying this option.
`void`	`restoreState(Element el)` Restores the current state from the given DOM element ("Options").
`void`	`saveState(Element el)` Writes the current state to the given DOM element ("Options").

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - text
```
protected String text
```
    String identifying this option.
- Constructor Detail
  - BioOption
```
public BioOption(String text)
```
    Constructs a new option.
- Method Detail
  - getText
```
public String getText()
```
    Gets text identifying this option.
  - getComponent
```
public abstract Component getComponent()
```
    Gets a GUI component representing this option.
  - saveState
```
public void saveState(Element el)
               throws SaveException
```
    Writes the current state to the given DOM element ("Options").
    
    Specified by:
    
    saveState in interface Saveable
    
    Throws:
    
    SaveException
  - restoreState
```
public void restoreState(Element el)
                  throws SaveException
```
    Restores the current state from the given DOM element ("Options").
    
    Specified by:
    
    restoreState in interface Saveable
    
    Throws:
    
    SaveException

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015–2022 SciJava. All rights reserved.