icy.main

Class Icy

java.lang.Object

icy.main.Icy

public class Icy
extends java.lang.Object

Icy - copyright 2017 Institut Pasteur

An open community platform for bio image analysis
http://icy.bioimageanalysis.org

Icy has been created by the Bio Image Analysis team at Institut Pasteur
https://research.pasteur.fr/fr/team/bioimage-analysis

Icy is free and open source, it has been funded both by Institut Pasteur and the FBI consortium
https://france-bioimaging.org

Source code is always provided in the main application package (in the icy.jar archive file) but can be also browsed from the GitHub repository
https://github.com/Icy-imaging/Icy-Kernel

Author:

Stephane Dallongeville, Fabrice de Chaumont

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXIT_FORCE_DELAY
static java.lang.String	LIB_PATH
static Version	version Icy Version

Constructor Summary

Constructors

Constructor and Description
Icy()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addSequence(Sequence sequence) Deprecated. Uses Icy.getMainInterface().addSequence(Sequence) instead.
static void	announceRestart() Show announcement to restart application
static void	announceRestart(java.lang.String message) Show announcement to restart application (custom message)
static boolean	canExit(boolean showConfirm) Returns true if application can exit.
static void	clearCommandLinePluginArgs() Clear the plugin command line arguments.
static void	confirmRestart() Restart application with user confirmation
static void	confirmRestart(java.lang.String message) Restart application with user confirmation (custom message)
static boolean	exit(boolean restart) Exit Icy, returns true if the operation should success.
static boolean	exit(boolean restart, boolean force) Deprecated. use exit(boolean) instead
static java.lang.String	getChangeLog() Return content of the CHANGELOG.txt file
static java.lang.String[]	getCommandLineArgs() Returns the command line arguments
static java.lang.String[]	getCommandLinePluginArgs() Returns the plugin command line arguments
static java.lang.String	getLicense() Return content of the COPYING.txt file
static MainInterface	getMainInterface() Return the main Icy interface.
static java.lang.String	getReadMe() Return content of the README.txt file
static Plugin	getStartupPlugin() Returns the startup plugin if any
static boolean	isExiting() Return true is the application is currently exiting.
static boolean	isHeadLess() Deprecated. Use MainInterface.isHeadLess() instead.
static boolean	isItkLibraryLoaded() Return true is VTK library loaded.
static boolean	isVtkLibraryLoaded() Return true is VTK library loaded.
static void	main(java.lang.String[] args)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LIB_PATH

public static final java.lang.String LIB_PATH

See Also:

Constant Field Values

EXIT_FORCE_DELAY

public static final int EXIT_FORCE_DELAY

See Also:

Constant Field Values

version

public static Version version

Icy Version

Constructor Detail

Icy

public Icy()

Method Detail

main

public static void main(java.lang.String[] args)

Parameters:

args - Received from the command line.

confirmRestart

public static void confirmRestart()

Restart application with user confirmation

confirmRestart

public static void confirmRestart(java.lang.String message)

Restart application with user confirmation (custom message)

announceRestart

public static void announceRestart()

Show announcement to restart application

announceRestart

public static void announceRestart(java.lang.String message)

Show announcement to restart application (custom message)

canExit

public static boolean canExit(boolean showConfirm)

Returns true if application can exit.
Shows a confirmation dialog if setting requires it or if it's unsafe to exit now.

exit

public static boolean exit(boolean restart)

Exit Icy, returns true if the operation should success.
Note that the method is asynchronous so you still have a bit of time to execute some stuff before the application actually exit.

exit

@Deprecated
public static boolean exit(boolean restart,
                      boolean force)

Deprecated. use exit(boolean) instead

Parameters:

force -

isVtkLibraryLoaded

public static boolean isVtkLibraryLoaded()

Return true is VTK library loaded.

isItkLibraryLoaded

public static boolean isItkLibraryLoaded()

Return true is VTK library loaded.

isHeadLess

@Deprecated
public static boolean isHeadLess()

Deprecated. Use MainInterface.isHeadLess() instead.

isExiting

public static boolean isExiting()

Return true is the application is currently exiting.

getMainInterface

public static MainInterface getMainInterface()

Return the main Icy interface.

getCommandLineArgs

public static java.lang.String[] getCommandLineArgs()

Returns the command line arguments

getCommandLinePluginArgs

public static java.lang.String[] getCommandLinePluginArgs()

Returns the plugin command line arguments

clearCommandLinePluginArgs

public static void clearCommandLinePluginArgs()

Clear the plugin command line arguments.
This method should be called after the launching plugin actually 'consumed' the startup arguments.

getStartupPlugin

public static Plugin getStartupPlugin()

Returns the startup plugin if any

getChangeLog

public static java.lang.String getChangeLog()

Return content of the CHANGELOG.txt file

getLicense

public static java.lang.String getLicense()

Return content of the COPYING.txt file

getReadMe

public static java.lang.String getReadMe()

Return content of the README.txt file

addSequence

@Deprecated
public static void addSequence(Sequence sequence)

Deprecated. Uses Icy.getMainInterface().addSequence(Sequence) instead.