public interface SurfaceFormat extends MangoPluginType
Modifier and Type | Method and Description |
---|---|
String |
getOptions()
Returns options.
|
JPanel |
getOptionsPanel(Surface[] data,
Shape[] shapes,
SurfaceController controller)
Deprecated.
|
String |
getPreferredFileExtension()
Returns the preferred file extension of this format.
|
boolean |
isThisFormat(File file)
Used to determine if a file is of this format (e.g., read magic number, check file size, check file extension, etc).
|
Surface[] |
readSurfaceFile(File file,
ViewerController controller,
Vector<Shape> shapes,
boolean baseSurface)
Deprecated.
|
Surface[] |
readSurfaceHeader(File file,
Vector<Shape> shapes)
Reads surface header (meta data) from file.
|
void |
setOptions(String options)
Sets the options.
|
void |
writeSurfaceFile(File file,
Surface[] surfaces,
Shape[] shapes,
SurfaceController controller)
Deprecated.
|
getMinimumVersionSupported, getPluginName, getPluginURL, getVersion, hasNewerVersion
String getOptions()
@Deprecated JPanel getOptionsPanel(Surface[] data, Shape[] shapes, SurfaceController controller)
String getPreferredFileExtension()
boolean isThisFormat(File file)
file
- the file to read@Deprecated Surface[] readSurfaceFile(File file, ViewerController controller, Vector<Shape> shapes, boolean baseSurface) throws SurfaceFormatException
file
- the file to readcontroller
- the ViewerController object can be used to access image dimensions, orientation, lookup tables, etc.shapes
- shape objects can be stored herebaseSurface
- true if the viewer does not yet exist, false if you are loading shapes into an existing viewerSurfaceFormatException
- surface format exceptionSurface[] readSurfaceHeader(File file, Vector<Shape> shapes) throws SurfaceFormatException
file
- the file to readshapes
- shape objects can be stored hereSurfaceFormatException
- surface format exceptionvoid setOptions(String options)
options
- the options@Deprecated void writeSurfaceFile(File file, Surface[] surfaces, Shape[] shapes, SurfaceController controller) throws SurfaceFormatException
file
- the file to writesurfaces
- an array of surfaces; the first index is the base surfaceshapes
- an array of shapescontroller
- the SurfaceControllerSurfaceFormatException
- surface format exception