Package org.scijava.ui.headless

Class HeadlessUI

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.ui.headless.HeadlessUI

All Implemented Interfaces:

Comparable<Prioritized>, Contextual, Disposable, Identifiable, Locatable, Logged, HasPluginInfo, RichPlugin, SciJavaPlugin, Prioritized, UserInterface, Versioned

Direct Known Subclasses:

HeadlessUI

public class HeadlessUI
extends AbstractRichPlugin
implements UserInterface

A no-op user interface used when the application is running headless.

Most operations do nothing. Attempting to show an object via one of the show() methods logs the object via the LogService.

Author:

Richard Domander (Royal Veterinary College, London), Curtis Rueden

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Constructor Summary

Constructors

Constructor	Description
HeadlessUI()

Method Summary

Modifier and Type	Method	Description
File	chooseFile(String title, File file, String style)	Prompts the user to choose a file.
DisplayWindow	createDisplayWindow(Display<?> display)	Creates a new display window housing the given display, or null if not applicable.
DialogPrompt	dialogPrompt(String message, String title, DialogPrompt.MessageType messageType, DialogPrompt.OptionType optionType)	Creates a dialog prompter.
void	dispose()	Performs any needed cleanup of the object's services, in preparation for the object being retired (e.g., to make garbage collection possible).
boolean	isVisible()	Whether this UI is visible onscreen.
boolean	requiresEDT()	Returns true if this UI requires the EDT.
void	restoreLocation()	Restores the application frame's current location.
void	saveLocation()	Persists the application frame's current location.
void	show()	Shows the UI.
void	show(String name, Object o)	Shows the object onscreen using an appropriate UI widget.
void	show(Display<?> display)	Shows the display onscreen using an appropriate UI widget.
void	showContextMenu(String menuRoot, Display<?> display, int x, int y)	Displays a popup context menu for the given display at the specified position.

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.ui.UserInterface

chooseFile, chooseFiles, chooseFiles, getApplicationFrame, getConsolePane, getDesktop, getStatusBar, getSystemClipboard, getToolBar, show

Methods inherited from interface org.scijava.Versioned

getVersion

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

HeadlessUI

public HeadlessUI()

Method Detail

show

public void show()

Description copied from interface: UserInterface

Shows the UI.

Note that the actual UI components are created lazily when this method is called, rather then upon the UI's initial construction.

Specified by:

show in interface UserInterface

isVisible

public boolean isVisible()

Description copied from interface: UserInterface

Whether this UI is visible onscreen.

Specified by:

isVisible in interface UserInterface

show

public void show(String name,
                 Object o)

Description copied from interface: UserInterface

Shows the object onscreen using an appropriate UI widget.

Specified by:

show in interface UserInterface

Parameters:

name - The name to use when displaying the object.

o - The object to be displayed.

show

public void show(Display<?> display)

Description copied from interface: UserInterface

Shows the display onscreen using an appropriate UI widget.

Specified by:

show in interface UserInterface

createDisplayWindow

public DisplayWindow createDisplayWindow(Display<?> display)

Description copied from interface: UserInterface

Creates a new display window housing the given display, or null if not applicable.

Specified by:

createDisplayWindow in interface UserInterface

dialogPrompt

public DialogPrompt dialogPrompt(String message,
                                 String title,
                                 DialogPrompt.MessageType messageType,
                                 DialogPrompt.OptionType optionType)

Description copied from interface: UserInterface

Creates a dialog prompter.

Specified by:

dialogPrompt in interface UserInterface

Parameters:

message - The message in the dialog itself.

title - The title of the dialog.

messageType - The type of message. This typically is rendered as an icon next to the message. For example, DialogPrompt.MessageType.WARNING_MESSAGE typically appears as an exclamation point.

optionType - The choices available when dismissing the dialog. These choices are typically rendered as buttons for the user to click.

Returns:

The newly created DialogPrompt object, or null if not applicable.

chooseFile

public File chooseFile(String title,
                       File file,
                       String style)

Description copied from interface: UserInterface

Prompts the user to choose a file.

Specified by:

chooseFile in interface UserInterface

Parameters:

title - Title to use in the file chooser dialog.

file - The initial value displayed in the file chooser prompt.

style - The style of chooser to use:

• FileWidget.OPEN_STYLE
• FileWidget.SAVE_STYLE
• FileWidget.DIRECTORY_STYLE
• FileWidget.FILE_AND_DIRECTORY_STYLE

Returns:

The File chosen by the user, or null if prompt is not available

showContextMenu

public void showContextMenu(String menuRoot,
                            Display<?> display,
                            int x,
                            int y)

Description copied from interface: UserInterface

Displays a popup context menu for the given display at the specified position.

Specified by:

showContextMenu in interface UserInterface

saveLocation

public void saveLocation()

Description copied from interface: UserInterface

Persists the application frame's current location.

Specified by:

saveLocation in interface UserInterface

restoreLocation

public void restoreLocation()

Description copied from interface: UserInterface

Restores the application frame's current location.

Specified by:

restoreLocation in interface UserInterface

requiresEDT

public boolean requiresEDT()

Description copied from interface: UserInterface

Returns true if this UI requires the EDT.

Specified by:

requiresEDT in interface UserInterface

dispose

public void dispose()

Description copied from interface: Disposable

Performs any needed cleanup of the object's services, in preparation for the object being retired (e.g., to make garbage collection possible).

Specified by:

dispose in interface Disposable