AbstractSwingUI (SciJava Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - org.scijava.plugin.AbstractRichPlugin
  - - org.scijava.ui.AbstractUserInterface
    - - org.scijava.ui.swing.AbstractSwingUI

All Implemented Interfaces:

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

Direct Known Subclasses:

SwingMdiUI, SwingSDIUI
```
public abstract class AbstractSwingUI
extends AbstractUserInterface
implements SwingUI
```
Abstract superclass for Swing-based user interfaces.

Author:

Curtis Rueden, Lee Kamentsky, Barry DeZonia, Grant Harris

Field Summary
- Fields inherited from interface org.scijava.ui.swing.SwingUI
  NAME

Constructor Summary

Constructors
Constructor and Description

AbstractSwingUI()

Constructors
Constructor and Description
`AbstractSwingUI()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`File`	`chooseFile(File file, String style)` Prompts the user to choose a file.
`File[]`	`chooseFiles(File parent, File[] files, FileFilter filter, String style)` Prompts the user to choose a list of files.
`protected JMenuBar`	`createConsoleMenu()`
`protected JMenuBar`	`createMenus()` Creates a `JMenuBar` from the master `ShadowMenu` structure.
`protected void`	`createUI()` Subclasses override to control UI creation.
`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).
`SwingApplicationFrame`	`getApplicationFrame()` Gets the main SciJava application frame, or null if not applicable.
`SwingConsolePane`	`getConsolePane()` Gets the main SciJava console pane, or null if not applicable.
`SwingStatusBar`	`getStatusBar()` Gets the main SciJava status bar, or null if not applicable.
`SystemClipboard`	`getSystemClipboard()` Gets the system clipboard associated with this UI, or null if not applicable.
`SwingToolBar`	`getToolBar()` Gets the main SciJava toolbar, or null if not applicable.
`boolean`	`requiresEDT()` Returns true if this UI requires the EDT.
`protected abstract void`	`setupAppFrame()` Configures the application frame for subclass-specific settings (e.g., SDI or MDI).
`protected abstract void`	`setupConsole()` Configures the console for subclass-specific settings (e.g., SDI or MDI).
`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.ui.AbstractUserInterface
isVisible, restoreLocation, saveLocation, show, show, show

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.ui.UserInterface
chooseFile, chooseFiles, createDisplayWindow, dialogPrompt, getDesktop, show

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

- Constructor Detail
  - AbstractSwingUI
```
public AbstractSwingUI()
```
- Method Detail
  - getApplicationFrame
```
public SwingApplicationFrame 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 SwingToolBar getToolBar()
```
    Description copied from interface: UserInterface
    
    Gets the main SciJava toolbar, or null if not applicable.
    
    Specified by:
    
    getToolBar in interface UserInterface
  - getStatusBar
```
public SwingStatusBar 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 SwingConsolePane getConsolePane()
```
    Description copied from interface: UserInterface
    
    Gets the main SciJava console pane, or null if not applicable.
    
    Specified by:
    
    getConsolePane in interface UserInterface
  - getSystemClipboard
```
public SystemClipboard getSystemClipboard()
```
    Description copied from interface: UserInterface
    
    Gets the system clipboard associated with this UI, or null if not applicable.
    
    Specified by:
    
    getSystemClipboard 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
    Returns:
    
    The File chosen by the user, or null if prompt is not available
  - chooseFiles
```
public File[] chooseFiles(File parent,
                          File[] files,
                          FileFilter filter,
                          String style)
```
    Description copied from interface: UserInterface
    
    Prompts the user to choose a list of files.
    
    Specified by:
    
    chooseFiles in interface UserInterface
    
    Parameters:
    
    parent - Parent folder for file selection
    
    files - The initial value displayed in the file chooser prompt.
    
    filter - A filter allowing to restrict file choice.
    
    style - File selection style (files, directories, or both) and optional filters
    
    Returns:
    
    The selected Files chosen by the user, or null if the user cancels the prompt.
  - 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
  - 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
  - createUI
```
protected void createUI()
```
    Description copied from class: AbstractUserInterface
    
    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).
    
    Overrides:
    
    createUI in class AbstractUserInterface
  - createMenus
```
protected JMenuBar createMenus()
```
    Creates a JMenuBar from the master ShadowMenu structure.
  - createConsoleMenu
```
protected JMenuBar createConsoleMenu()
```
  - setupAppFrame
```
protected abstract void setupAppFrame()
```
    Configures the application frame for subclass-specific settings (e.g., SDI or MDI).
  - setupConsole
```
protected abstract void setupConsole()
```
    Configures the console for subclass-specific settings (e.g., SDI or MDI).

Class AbstractSwingUI

Field Summary

Fields inherited from interface org.scijava.ui.swing.SwingUI

Constructor Summary

Method Summary

Methods inherited from class org.scijava.ui.AbstractUserInterface

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.ui.UserInterface

Methods inherited from interface org.scijava.plugin.RichPlugin

Methods inherited from interface org.scijava.Contextual

Methods inherited from interface org.scijava.Prioritized

Methods inherited from interface org.scijava.plugin.HasPluginInfo

Methods inherited from interface org.scijava.Locatable

Methods inherited from interface org.scijava.Versioned

Constructor Detail

AbstractSwingUI

Method Detail

getApplicationFrame

getToolBar

getStatusBar

getConsolePane

getSystemClipboard

chooseFile

chooseFiles

showContextMenu

requiresEDT

dispose

createUI

createMenus

createConsoleMenu

setupAppFrame

setupConsole