org.scijava.ui

Class AbstractUserInterface

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.ui.AbstractUserInterface

All Implemented Interfaces:

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

public abstract class AbstractUserInterface
extends AbstractRichPlugin
implements UserInterface

Abstract superclass for UserInterface implementations.

Author:

Curtis Rueden

Constructor Summary

Constructors

Constructor and Description
AbstractUserInterface()

Method Summary

Modifier and Type	Method and Description
File	chooseFile(File file, String style) Prompts the user to choose a file.
File	chooseFile(String title, File file, String style) Deprecated.
protected void	createUI() Subclasses override to control UI creation.
protected String	fileChooserTitle(String style) Gets a default file chooser title to use when none is given.
ApplicationFrame	getApplicationFrame() Gets the main SciJava application frame, or null if not applicable.
ConsolePane<?>	getConsolePane() Gets the main SciJava console pane, or null if not applicable.
Desktop	getDesktop() Gets the desktop, for use with multi-document interfaces (MDI).
StatusBar	getStatusBar() Gets the main SciJava status bar, or null if not applicable.
ToolBar	getToolBar() Gets the main SciJava toolbar, or null if not applicable.
boolean	isVisible() Whether this UI is visible onscreen.
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(Display<?> display) Shows the display onscreen using an appropriate UI widget.
void	show(Object o) Shows the object onscreen using an appropriate UI widget.
void	show(String name, Object o) Shows the object onscreen using an appropriate UI widget.

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.ui.UserInterface

createDisplayWindow, dialogPrompt, getSystemClipboard, requiresEDT, showContextMenu

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.Disposable

dispose

Constructor Detail

AbstractUserInterface

public AbstractUserInterface()

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(Object o)

Description copied from interface: UserInterface

Shows the object onscreen using an appropriate UI widget.

Specified by:

show 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

getDesktop

public Desktop getDesktop()

Description copied from interface: UserInterface

Gets the desktop, for use with multi-document interfaces (MDI).

Specified by:

getDesktop in interface UserInterface

getApplicationFrame

public ApplicationFrame getApplicationFrame()

Description copied from interface: UserInterface

Gets the main SciJava application frame, or null if not applicable.

Specified by:

getApplicationFrame in interface UserInterface

getToolBar

public ToolBar getToolBar()

Description copied from interface: UserInterface

Gets the main SciJava toolbar, or null if not applicable.

Specified by:

getToolBar in interface UserInterface

getStatusBar

public StatusBar getStatusBar()

Description copied from interface: UserInterface

Gets the main SciJava status bar, or null if not applicable.

Specified by:

getStatusBar in interface UserInterface

getConsolePane

public ConsolePane<?> getConsolePane()

Description copied from interface: UserInterface

Gets the main SciJava console pane, or null if not applicable.

Specified by:

getConsolePane in interface UserInterface

chooseFile

public File chooseFile(File file,
                       String style)

Description copied from interface: UserInterface

Prompts the user to choose a file.

Specified by:

chooseFile in interface UserInterface

Parameters:

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

chooseFile

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

Deprecated.

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

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

createUI

protected void createUI()

Subclasses override to control UI creation. They must also call super.createUI() after creating the ApplicationFrame but before showing it (assuming the UI has an ApplicationFrame).

fileChooserTitle

protected String fileChooserTitle(String style)

Gets a default file chooser title to use when none is given.