AWTUI (SciJava Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - org.scijava.plugin.AbstractRichPlugin
  - - org.scijava.ui.AbstractUserInterface
    - - org.scijava.ui.awt.AWTUI

All Implemented Interfaces:

Comparable<Prioritized>, Contextual, Disposable, Identifiable, Locatable, Logged, HasPluginInfo, RichPlugin, SciJavaPlugin, Prioritized, UserInterface, Versioned
```
public class AWTUI
extends AbstractUserInterface
```
AWT-based user interface for ImageJ.

Author:

Curtis Rueden

Field Summary

Fields
Modifier and Type Field and Description

static String NAME

Fields
Modifier and Type	Field and Description
`static String`	`NAME`

Constructor Summary

Constructors
Constructor and Description

AWTUI()

Constructors
Constructor and Description
`AWTUI()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`File`	`chooseFile(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.
`protected void`	`createMenus()`
`protected void`	`createUI()` Subclasses override to control UI creation.
`DialogPrompt`	`dialogPrompt(String message, String title, DialogPrompt.MessageType msg, DialogPrompt.OptionType option)` 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).
`ApplicationFrame`	`getApplicationFrame()` Gets the main SciJava application frame, or null if not applicable.
`AWTStatusBar`	`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.
`AWTToolBar`	`getToolBar()` Gets the main SciJava toolbar, or null if not applicable.
`boolean`	`requiresEDT()` Returns true if this UI requires the EDT.
`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, chooseFiles, getConsolePane, 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

- Field Detail
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AWTUI
```
public AWTUI()
```
- Method Detail
  - getApplicationFrame
```
public ApplicationFrame getApplicationFrame()
```
    Description copied from interface: UserInterface
    
    Gets the main SciJava application frame, or null if not applicable.
  - getToolBar
```
public AWTToolBar getToolBar()
```
    Description copied from interface: UserInterface
    
    Gets the main SciJava toolbar, or null if not applicable.
  - getStatusBar
```
public AWTStatusBar getStatusBar()
```
    Description copied from interface: UserInterface
    
    Gets the main SciJava status bar, or null if not applicable.
  - getSystemClipboard
```
public SystemClipboard getSystemClipboard()
```
    Description copied from interface: UserInterface
    
    Gets the system clipboard associated with this UI, or null if not applicable.
  - 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.
  - dialogPrompt
```
public DialogPrompt dialogPrompt(String message,
                                 String title,
                                 DialogPrompt.MessageType msg,
                                 DialogPrompt.OptionType option)
```
    Description copied from interface: UserInterface
    
    Creates a dialog prompter.
    
    Parameters:
    
    message - The message in the dialog itself.
    
    title - The title of the dialog.
    
    msg - 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.
    
    option - 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(File file,
                       String style)
```
    Description copied from interface: UserInterface
    
    Prompts the user to choose a file.
    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
  - 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.
  - requiresEDT
```
public boolean requiresEDT()
```
    Description copied from interface: UserInterface
    
    Returns true if this UI requires the EDT.
  - 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).
  - 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 void createMenus()
```

Class AWTUI

Field Summary

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

Field Detail

NAME

Constructor Detail

AWTUI

Method Detail

getApplicationFrame

getToolBar

getStatusBar

getSystemClipboard

createDisplayWindow

dialogPrompt

chooseFile

showContextMenu

requiresEDT

dispose

createUI

createMenus