ImageLoader (Mango Plugin API)

All Superinterfaces:

MangoPluginType
```
public interface ImageLoader
extends MangoPluginType
```
An ImageLoader provides the application with a way to access an online library of images.

Field Summary

Fields
Modifier and Type Field and Description

static String NO_DATA_MESSAGE

Fields
Modifier and Type	Field and Description
`static String`	`NO_DATA_MESSAGE`

Method Summary

Methods
Modifier and Type	Method and Description
`byte[]`	`getData()` (Not yet implemented.)
`JPanel`	`getImageSelectionPanel(JButton loadButton)` This method should return a GUI allowing the user to select a base image.
`InputStream`	`getInputStream()` (Not yet implemented.)
`JPanel`	`getOverlaySelectionPanel(String imageName, ImageDimensions id, VoxelDimensions vd, JButton loadButton)` This method should return a GUI allowing the user to select an overlay image.
`JPanel`	`getROISelectionPanel(String imageName, ImageDimensions id, VoxelDimensions vd, JButton loadButton)` This method should return a GUI allowing the user to select a ROI.
`String`	`getSelectedAbsolutePath()` This method is called after the dialog has been closed using the load button.
`String`	`getSelectedRelativePath()` This method is called after the dialog has been closed using the load button (applet use only).
`boolean`	`isImportingInWorldSpace()` In the case of ROIs, this method should return true if the ROI is to be imported in world space.
`boolean`	`isImportingROI()` In the case of ROIs, this method should return true if the ROI is to be imported as an image, rather than ROI format.
`boolean`	`isParametricOverlay()` In the case of overlay, this method should return true if the overlay should load both in the positive and negative range.
`boolean`	`isPublic()` If an image is not public, its address will not be displayed (e.g., in the Image Info dialog) and it will not be added to the recent files list.
`boolean`	`isSaveable()` (Not yet implemented.)

Methods inherited from interface edu.uthscsa.ric.mango.MangoPluginType
getMinimumVersionSupported, getPluginName, getPluginURL, getVersion, hasNewerVersion

- Field Detail
  - NO_DATA_MESSAGE
```
static final String NO_DATA_MESSAGE
```
    See Also:
    Constant Field Values
- Method Detail
  - getData
```
byte[] getData()
```
    (Not yet implemented.)
    
    Returns:
    data
  - getImageSelectionPanel
```
JPanel getImageSelectionPanel(JButton loadButton)
```
    This method should return a GUI allowing the user to select a base image.
    
    Parameters:
    loadButton - the dialog load button is provided to intersect with the GUI (e.g., double-clicking selection can programatically click load button)
    
    Returns:
    the GUI panel or null if none is to be provided
  - getInputStream
```
InputStream getInputStream()
```
    (Not yet implemented.)
    
    Returns:
    input stream
  - getOverlaySelectionPanel
```
JPanel getOverlaySelectionPanel(String imageName,
                              ImageDimensions id,
                              VoxelDimensions vd,
                              JButton loadButton)
```
    This method should return a GUI allowing the user to select an overlay image.
    
    Parameters:
    imageName - the name of the loaded base image
    id - the image dimensions of the loaded base image
    vd - the voxel dimensions of the loaded base image
    loadButton - the dialog load button is provided to intersect with the GUI (e.g., double-clicking selection can programatically click load button)
    
    Returns:
    the GUI panel or null if none is to be provided
  - getROISelectionPanel
```
JPanel getROISelectionPanel(String imageName,
                          ImageDimensions id,
                          VoxelDimensions vd,
                          JButton loadButton)
```
    This method should return a GUI allowing the user to select a ROI. The ROI can either be in Mango ROI format (e.g., "myROI.roi.gz") or an image that will be imported as an ROI [see the importROI() method in ViewerController].
    
    Parameters:
    imageName - the name of the loaded base image
    id - the image dimensions of the loaded base image
    vd - the voxel dimensions of the loaded base image
    loadButton - the dialog load button is provided to intersect with the GUI (e.g., double-clicking selection can programatically click load button)
    
    Returns:
    the GUI panel or null if none is to be provided
  - getSelectedAbsolutePath
```
String getSelectedAbsolutePath()
```
    This method is called after the dialog has been closed using the load button. It should return an absolute URL to the data. For example, it may return the string "http://www.mywebsite.org/images/myimage". If null is returned, nothing will happen.
    
    Returns:
    the relative path
  - getSelectedRelativePath
```
String getSelectedRelativePath()
```
    This method is called after the dialog has been closed using the load button (applet use only). It should return a relative URL to the data. For example, it may return the string "images/myimage". This will be appended to the URL returned from the applet method getCodeBase(). If getCodeBase() returns "http://www.mywebsite.org", an attempt to access the data will be made at the URL: "http://www.mywebsite.org/images/myimage". If null is returned, nothing will happen.
    
    Returns:
    the relative path
  - isImportingInWorldSpace
```
boolean isImportingInWorldSpace()
```
    In the case of ROIs, this method should return true if the ROI is to be imported in world space. Note, this option is only considered if the user has not already opted to be in world space.
    
    Returns:
    true if the ROI should be imported in world space, false otherwise
  - isImportingROI
```
boolean isImportingROI()
```
    In the case of ROIs, this method should return true if the ROI is to be imported as an image, rather than ROI format.
    
    Returns:
    true if the ROI is importing, false otherwise
  - isParametricOverlay
```
boolean isParametricOverlay()
```
    In the case of overlay, this method should return true if the overlay should load both in the positive and negative range.
    
    Returns:
    true if the overlay is parametric, false otherwise
  - isPublic
```
boolean isPublic()
```
    If an image is not public, its address will not be displayed (e.g., in the Image Info dialog) and it will not be added to the recent files list.
    
    Returns:
    true if the image is publicly accessible, false otherwise
  - isSaveable
```
boolean isSaveable()
```
    (Not yet implemented.)
    
    Returns:
    true if saveable

Interface ImageLoader

Field Summary

Method Summary

Methods inherited from interface edu.uthscsa.ric.mango.MangoPluginType

Field Detail

NO_DATA_MESSAGE

Method Detail

getData

getImageSelectionPanel

getInputStream

getOverlaySelectionPanel

getROISelectionPanel

getSelectedAbsolutePath

getSelectedRelativePath

isImportingInWorldSpace

isImportingROI

isParametricOverlay

isPublic

isSaveable