Utils (BAR 1.5.2-SNAPSHOT API)

java.lang.Object
- bar.Utils

All Implemented Interfaces:

PlugIn
```
public class Utils
extends Object
implements PlugIn
```
A collection of utilities to interact with BAR, including scripting aids for ImageJ. Most methods are designed so that they can be called by the IJ macro language (BTW, Note that the IJ1 macro interpreter converts all returned objects into their String values).

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BUILD_DATE` A reference to the build date
`static String`	`BUILD_YEAR` A reference to the build year
`static String`	`VERSION` The BAR version

Constructor Summary

Constructors
Constructor and Description

Utils()

Constructors
Constructor and Description
`Utils()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static boolean`	`fileExists(File file)` Tests whether a file or directory exists.
`static boolean`	`fileExists(String filepath)` Tests whether a file or directory exists at the specified path.
`static ResultsTable`	`generateGaussianData()` Returns a `ResultsTable` containing Gaussian ("normally") distributed values without displaying it.
`static String`	`getBARDir()` Returns the path to the root directory of BAR.
`static URL`	`getBARresource(String resourcePath)`
`static String`	`getClipboardText()` Retrieves text from the system clipboard.
`static String`	`getDocURL()` Returns the URL of BAR's documentation page.
`static String`	`getJavadocURL()` Returns the URL of BAR's API.
`static String`	`getLibDir()` Returns the path to `BAR/lib/`.
`static String`	`getMyRoutinesDir()` Returns the path to `BAR/My_Routines/`, creating it .
`static String`	`getPluginsBasedBARDir()` The absolute path to the legacy /BAR directory on the "plugins" folder.
`static ResultsTable`	`getResultsTable()` Returns a reference to the default IJ Results table.
`static String`	`getSnippetsDir()` Deprecated.
`static String`	`getSourceURL()` Returns the URL of BAR's Git repository.
`static ResultsTable`	`getTable()` Variant of `getTable(boolean, WindowListener)` that ignores WindowListeners.
`static ResultsTable`	`getTable(boolean displayInResults, WindowListener listener)` Prompts the user for tabular data, retrieved from several sources including 1) Importing a new text/csv file; 2) Trying to import data from the system clipboard; 3) Importing a demo dataset populated by random (Gaussian) values; 4) the `ResultsTable` of any `TextWindow` or a `PlotWindow` currently being displayed in ImageJ.
`static ResultsTable`	`getTable(Component relativeComponent, boolean displayInResults, boolean offerSampleChoice, WindowListener listener)`
`static ResultsTable`	`getTable(String textWindowTitle)` Returns the ResultsTable associated with the specified TextWindow.
`static void`	`listDirectory(String dir)` Prints the contents of a directory to a dedicated TextWindow displayed on the center of the screen.
`static void`	`listDirectory(String dir, boolean cascade)` Prints the contents of a directory to a dedicated TextWindow allowed to be displayed with a slight offset from frontmost window.
`static void`	`listDirectory(String dir, int xPos, int yPos)` Prints the contents of a directory to a dedicated TextWindow displayed at the specified location.
`static ResultsTable`	`openAndDisplayTable(String path, String title, WindowListener listener)` Opens a tab or comma delimited text file.
`static ResultsTable`	`openAndDisplayTable(String path, String title, WindowListener listener, boolean silent)` Opens a tab or comma delimited text file.
`static void`	`openIJ1Script(String dir, String filename)` Opens the specified file in the ImageJ1 built-in editor.
`static void`	`openIJ2Script(File file)` Opens the specified file in the ImageJ2 Script Editor.
`static void`	`openLib(String filename)` Opens the specified file in the "lib" directory of BAR.
`static void`	`openScript(String dir, String filename)` Alias for `openIJ2Script(File)`
`static void`	`openSnippet(String filename)` Opens the specified file in the "My Routines" directory of BAR.
`static void`	`revealFile(File file)` "Reveals" the specified file path in the operating system.
`static void`	`revealFile(String filePath)` "Reveals" the file associated with the specified file path in the operating system.
`void`	`run(String arg)`
`static void`	`shiftClickWarning()` Displays a status-bar warning on "open by Shift-click" being disabled for pre-compiled plugins.
`static void`	`zapCompiledFiles(File directory)` Removes `$py.class`, `.class`, `.pyc` and `.pyo` files from the specified directory.
`static void`	`zapCompiledLibs()` Removes `$py.class`, `.class`, `.pyc` and `.pyo` files from the "lib" directory of BAR.

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

- Field Detail
  - VERSION
```
public static String VERSION
```
    The BAR version
  - BUILD_DATE
```
public static String BUILD_DATE
```
    A reference to the build date
  - BUILD_YEAR
```
public static String BUILD_YEAR
```
    A reference to the build year
- Constructor Detail
  - Utils
```
public Utils()
```
- Method Detail
  - run
```
public void run(String arg)
```
    Specified by:
    
    run in interface PlugIn
  - shiftClickWarning
```
public static void shiftClickWarning()
```
    Displays a status-bar warning on "open by Shift-click" being disabled for pre-compiled plugins. Used by BAR plugins.
  - getClipboardText
```
public static String getClipboardText()
```
    Retrieves text from the system clipboard.
    
    Returns:
    
    the text contents of the clipboard or an empty string if no text could be retrieved
  - listDirectory
```
public static void listDirectory(String dir,
                                 int xPos,
                                 int yPos)
```
    Prints the contents of a directory to a dedicated TextWindow displayed at the specified location. The location reverts to the center of the screen if one of the specified coordinates is invalid).
    An error message is displayed in a dialog box if directory could not be found or if directory is empty (see fileExists(File)).
    A FileDrop listener is attached to the TextWindow, which means that, once displayed, the method can be triggered by dragging and dropping files from the native file manager.
    Some system files (hidden files, Thumbs.db) are excluded from the list. If the directory is empty, users are prompted with the option to reveal the file in the native file browser (see revealFile(String)).
    Users can double click on a listed file path to have it open by ImageJ.
    
    Parameters:
    
    dir - Path of the directory to be listed
    
    xPos - The screen x location (from top-left corner) where the TextWindow should be displayed
    
    yPos - The screen y location (from top-left corner) where the TextWindow should be displayed
    
    See Also:
    
    listDirectory(String), listDirectory(String, boolean)
  - listDirectory
```
public static void listDirectory(String dir)
```
    Prints the contents of a directory to a dedicated TextWindow displayed on the center of the screen.
    
    Parameters:
    
    dir - the path of the directory to be listed
    
    See Also:
    
    listDirectory(String, int, int), listDirectory(String, boolean)
  - listDirectory
```
public static void listDirectory(String dir,
                                 boolean cascade)
```
    Prints the contents of a directory to a dedicated TextWindow allowed to be displayed with a slight offset from frontmost window. This "cascade" positioning defaults to the center of the screen if frontmost window could not be retrieved or is too close to screen boundaries.
    
    Parameters:
    
    dir - the path of the directory to be listed
    
    cascade - if true TextWindow "cascades" from ImageJ's frontmost window. If false, TextWidow is displayed in the center of the screen
    
    See Also:
    
    listDirectory(String, int, int), listDirectory(String)
  - openScript
```
public static void openScript(String dir,
                              String filename)
```
    Alias for openIJ2Script(File)
  - openIJ1Script
```
public static void openIJ1Script(String dir,
                                 String filename)
```
    Opens the specified file in the ImageJ1 built-in editor. No tests assessing the existence of specified file/directory are performed.
    
    Parameters:
    
    dir - the directory containing the file to be opened
    
    filename - the filename of the file to be opened
    
    See Also:
    
    openScript(String, String)
  - openIJ2Script
```
public static void openIJ2Script(File file)
```
    Opens the specified file in the ImageJ2 Script Editor. No tests assessing the existence of the specified file are performed.
    
    Parameters:
    
    file - the file to be opened
    
    See Also:
    
    openScript(String, String), openIJ1Script(String, String)
  - openSnippet
```
public static void openSnippet(String filename)
```
    Opens the specified file in the "My Routines" directory of BAR. No tests assessing the existence of the specified file are performed.
    
    Parameters:
    
    filename - the filename of the script to be opened
    
    See Also:
    
    getMyRoutinesDir(), openScript(String, String)
  - zapCompiledLibs
```
public static void zapCompiledLibs()
```
    Removes $py.class, .class, .pyc and .pyo files from the "lib" directory of BAR.
    
    See Also:
    
    getLibDir(), zapCompiledLibs()
  - zapCompiledFiles
```
public static void zapCompiledFiles(File directory)
```
    Removes $py.class, .class, .pyc and .pyo files from the specified directory.
    
    Parameters:
    
    directory - the directory to be cleansed
    
    See Also:
    
    zapCompiledLibs()
  - openLib
```
public static void openLib(String filename)
```
    Opens the specified file in the "lib" directory of BAR. No tests assessing the existence of the specified file are performed.
    
    Parameters:
    
    filename - the filename of the lib/ file to be opened
    
    See Also:
    
    openScript(String, String), getLibDir()
  - fileExists
```
public static boolean fileExists(File file)
```
    Tests whether a file or directory exists. An error message is displayed in a dialog box if file cannot be found
    
    Parameters:
    
    file - the File to be tested
    
    Returns:
    
    true, if successful.
    
    See Also:
    
    fileExists(String)
  - fileExists
```
public static boolean fileExists(String filepath)
```
    Tests whether a file or directory exists at the specified path. An error message is displayed in a dialog box if file path is invalid
    
    Parameters:
    
    filepath - the file path to be tested
    
    Returns:
    
    true, if successful
    
    See Also:
    
    fileExists(File)
  - revealFile
```
public static void revealFile(String filePath)
```
    "Reveals" the file associated with the specified file path in the operating system. Described in revealFile(File)
    
    Parameters:
    
    filePath - the file path to be opened by the operating system
    
    See Also:
    
    fileExists(File)
  - revealFile
```
public static void revealFile(File file)
```
    "Reveals" the specified file path in the operating system. If file is a directory, opens it in the file manager of the operating system, otherwise the application associated with the file type will be launched. An error message is displayed in a dialog box if file path is invalid, or if the operating system could not be detected.
    
    Parameters:
    
    file - the file to be opened by the operating system
    
    See Also:
    
    fileExists(File)
  - getLibDir
```
public static String getLibDir()
```
    Returns the path to BAR/lib/.
    
    Returns:
    
    the absolute path to the "lib" directory
  - getBARDir
```
public static String getBARDir()
```
    Returns the path to the root directory of BAR.
    
    Returns:
    
    the absolute path to the root directory of BAR
  - getPluginsBasedBARDir
```
public static String getPluginsBasedBARDir()
```
    The absolute path to the legacy /BAR directory on the "plugins" folder. It is no longer used but it was used prior to BAR v1.5. Included here for convenience.
    
    Returns:
    
    the absolute path to the root directory of BAR prior to v1.5
  - getMyRoutinesDir
```
public static String getMyRoutinesDir()
```
    Returns the path to BAR/My_Routines/, creating it .
    
    Returns:
    
    the absolute path to the "My Routines" directory
  - getSnippetsDir
```
@Deprecated
public static String getSnippetsDir()
```
    Deprecated.
  - getJavadocURL
```
public static String getJavadocURL()
```
    Returns the URL of BAR's API.
    
    Returns:
    
    the API (javadoc) URL
  - getDocURL
```
public static String getDocURL()
```
    Returns the URL of BAR's documentation page.
    
    Returns:
    
    the documentation URL
  - getSourceURL
```
public static String getSourceURL()
```
    Returns the URL of BAR's Git repository.
    
    Returns:
    
    the GitHub URL of BAR
  - getResultsTable
```
public static ResultsTable getResultsTable()
```
    Returns a reference to the default IJ Results table. It the Results table is not displayed or is empty, prompts the user for data to populate it (by using getTable(boolean, WindowListener) to display data in the "Results" window). This method is thought for IJ macros, since the IJ macro language can only interact with the "Results" window. Note that any previous data in the "Results" window will be lost.
    
    Returns:
    
    A reference to the populated ResultsTable in the "Results" window or null if chosen source did not contain valid data. Note that the IJ1 macro interpreter converts all returned objects into their String values
    
    See Also:
    
    getTable()
  - getTable
```
public static ResultsTable getTable()
```
    Variant of getTable(boolean, WindowListener) that ignores WindowListeners.
    
    Returns:
    
    A reference to the chosen ResultsTable or null if chosen source did not contain valid data
    
    See Also:
    
    getTable(boolean, WindowListener), getResultsTable()
  - getTable
```
public static ResultsTable getTable(String textWindowTitle)
```
    Returns the ResultsTable associated with the specified TextWindow.
    
    Parameters:
    
    textWindowTitle - The title of the TextWindow holding the TextPanel and associated ResultsTable
    
    Returns:
    
    The ResultsTable associated with the specified TextWindow title or an empty ResultsTable if no table exists.
    
    See Also:
    
    getTable(boolean, WindowListener), getResultsTable()
  - getTable
```
public static ResultsTable getTable(boolean displayInResults,
                                    WindowListener listener)
```
    Prompts the user for tabular data, retrieved from several sources including 1) Importing a new text/csv file; 2) Trying to import data from the system clipboard; 3) Importing a demo dataset populated by random (Gaussian) values; 4) the ResultsTable of any TextWindow or a PlotWindow currently being displayed in ImageJ. For 1) and 2) data is displayed in a new TextWindow.
    
    Parameters:
    
    displayInResults - If true chosen data is displayed in the "Results" window. Useful, since macros (and several plugins) can only work with the "Results" window. Note that any previous data in the "Results" window will be lost. If false chosen data is displayed on a dedicated window.
    
    listener - The WindowListener to be added to the window containing data (if retrieval was successful. It is ignored when null. Note that the window containing the data can either be a TextWindow or a PlotWindow
    
    Returns:
    
    A reference to the chosen ResultsTable or null if chosen source did not contain valid data
    
    See Also:
    
    getResultsTable(), getTable()
  - getTable
```
public static ResultsTable getTable(Component relativeComponent,
                                    boolean displayInResults,
                                    boolean offerSampleChoice,
                                    WindowListener listener)
```
  - openAndDisplayTable
```
public static ResultsTable openAndDisplayTable(String path,
                                               String title,
                                               WindowListener listener,
                                               boolean silent)
```
    Opens a tab or comma delimited text file.
    
    Parameters:
    
    path - The absolute pathname string of the file. A file open dialog is displayed if path is null or an empty string.
    
    title - The title of the window in which data is displayed. The filename is used if title is null or an empty string. To avoid windows with duplicated titles, title is made unique by WindowManager.
    
    listener - The WindowListener to be added to the window containing data if retrieval was successful. It is ignored when null.
    
    silent - If true I/O exceptions are silently ignored.
    
    Returns:
    
    A reference to the opened {link ResultsTable} or null if file could not be open.
    
    See Also:
    
    getTable(), Opener.openTable(String)
  - openAndDisplayTable
```
public static ResultsTable openAndDisplayTable(String path,
                                               String title,
                                               WindowListener listener)
                                        throws IOException
```
    Opens a tab or comma delimited text file.
    
    Parameters:
    
    path - The absolute pathname string of the file. A file open dialog is displayed if path is null or an empty string.
    
    title - The title of the window in which data is displayed. The filename is used if title is null or an empty string. To avoid windows with duplicated titles, title is made unique by WindowManager .
    
    listener - The WindowListener to be added to the window containing data if retrieval was successful. It is ignored when null.
    
    Returns:
    
    A reference to the opened {link ResultsTable} or null if table was empty.
    
    Throws:
    
    IOException - if file could not be opened
    
    See Also:
    
    getTable(), Opener.openTable(String)
  - generateGaussianData
```
public static ResultsTable generateGaussianData()
```
    Returns a ResultsTable containing Gaussian ("normally") distributed values without displaying it.
    
    Returns:
    
    the {link ResultsTable} containing the demo data
    
    See Also:
    
    getTable(boolean, WindowListener), getTable(), getResultsTable()
  - getBARresource
```
public static URL getBARresource(String resourcePath)
```

Class Utils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

BUILD_DATE

BUILD_YEAR

Constructor Detail

Utils

Method Detail

run

shiftClickWarning

getClipboardText

listDirectory

listDirectory

listDirectory

openScript

openIJ1Script

openIJ2Script

openSnippet

zapCompiledLibs

zapCompiledFiles

openLib

fileExists

fileExists

revealFile

revealFile

getLibDir

getBARDir

getPluginsBasedBARDir

getMyRoutinesDir

getSnippetsDir

getJavadocURL

getDocURL

getSourceURL

getResultsTable

getTable

getTable

getTable

getTable

openAndDisplayTable

openAndDisplayTable

generateGaussianData

getBARresource