SpreadsheetLauncher (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.overlays.SpreadsheetLauncher

public class SpreadsheetLauncher
extends Object

Launches an external spreadsheet application.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`LIN_PATH` Default path to spreadsheet (OpenOffice) on Linux computers.
`protected static String`	`MAC_PATH` Default path to spreadsheet (Excel) on Macintosh computers.
`protected String`	`path` Path to spreadsheet executable.
`protected static String`	`WIN_PATH` Default path to spreadsheet (Excel) on Windows computers.

Constructor Summary

Constructors
Constructor and Description

SpreadsheetLauncher()
Constructs a spreadsheet launcher.

Constructors
Constructor and Description
`SpreadsheetLauncher()` Constructs a spreadsheet launcher.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getDefaultApplicationPath()` Returns the default spreadsheet application path for the current OS.
`protected static boolean`	`isLinux()` Whether OS is Linux.
`protected static boolean`	`isMac()` Whether the OS is mac.
`protected static boolean`	`isWindows()` Whether the OS is windows.
`void`	`launchSpreadsheet(File file)` Tries to launch the appropriate spreadsheet application.
`void`	`launchSpreadsheet(File file, String appPath)` Tries to launch the appropriate spreadsheet application.
`protected static String`	`makeCantIdentifyOSMessage()` Returns an error message indicating the OS could not be identified.
`protected String`	`makeCommandErrorMessage(String command)` Makes an error message from the given command.
`protected String`	`makeFileDoesNotExistMessage(File file)` Makes an error message from the given file.

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

- Field Detail
  - WIN_PATH
```
protected static final String WIN_PATH
```
    Default path to spreadsheet (Excel) on Windows computers.
    
    See Also:
    
    Constant Field Values
  - LIN_PATH
```
protected static final String LIN_PATH
```
    Default path to spreadsheet (OpenOffice) on Linux computers.
    
    See Also:
    
    Constant Field Values
  - MAC_PATH
```
protected static final String MAC_PATH
```
    Default path to spreadsheet (Excel) on Macintosh computers.
    
    See Also:
    
    Constant Field Values
  - path
```
protected final String path
```
    Path to spreadsheet executable.
- Constructor Detail
  - SpreadsheetLauncher
```
public SpreadsheetLauncher()
                    throws SpreadsheetLaunchException
```
    Constructs a spreadsheet launcher.
    
    Throws:
    
    SpreadsheetLaunchException
- Method Detail
  - getDefaultApplicationPath
```
public static String getDefaultApplicationPath()
                                        throws SpreadsheetLaunchException
```
    Returns the default spreadsheet application path for the current OS.
    
    Throws:
    
    SpreadsheetLaunchException
  - launchSpreadsheet
```
public void launchSpreadsheet(File file)
                       throws SpreadsheetLaunchException
```
    Tries to launch the appropriate spreadsheet application.
    
    Throws:
    
    SpreadsheetLaunchException
  - launchSpreadsheet
```
public void launchSpreadsheet(File file,
                              String appPath)
                       throws SpreadsheetLaunchException
```
    Tries to launch the appropriate spreadsheet application.
    
    Throws:
    
    SpreadsheetLaunchException
  - isWindows
```
protected static boolean isWindows()
```
    Whether the OS is windows.
  - isMac
```
protected static boolean isMac()
```
    Whether the OS is mac.
  - isLinux
```
protected static boolean isLinux()
```
    Whether OS is Linux.
  - makeCommandErrorMessage
```
protected String makeCommandErrorMessage(String command)
```
    Makes an error message from the given command.
  - makeFileDoesNotExistMessage
```
protected String makeFileDoesNotExistMessage(File file)
```
    Makes an error message from the given file.
  - makeCantIdentifyOSMessage
```
protected static String makeCantIdentifyOSMessage()
```
    Returns an error message indicating the OS could not be identified.

Class SpreadsheetLauncher

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WIN_PATH

LIN_PATH

MAC_PATH

path

Constructor Detail

SpreadsheetLauncher

Method Detail

getDefaultApplicationPath

launchSpreadsheet

launchSpreadsheet

isWindows

isMac

isLinux

makeCommandErrorMessage

makeFileDoesNotExistMessage

makeCantIdentifyOSMessage