SwingDialog (SciJava Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.ui.swing.SwingDialog

```
public class SwingDialog
extends Object
```
A resizable dialog box containing a particular component.
It is very similar to the dialog generated by JOptionPane.showConfirmDialog(Component, Object, String, int, int), except that it has a few extra features:
- It can limit the size of the dialog based on the actual screen size.
- It can be create either a modal or non-modal dialog. In the case of a non-modal dialog, the usual buttons (OK, Cancel, etc.) are suppressed.
- It can optionally add a scroll bar around the provided Component in case it is too large.
- It can start with a particular Component having the keyboard focus.
Author:

Curtis Rueden

Field Summary

Fields
Modifier and Type Field and Description

static int UNKNOWN_OPTION
Catch-all return value of show() if return value is non-integer.

Fields
Modifier and Type	Field and Description
`static int`	`UNKNOWN_OPTION` Catch-all return value of `show()` if return value is non-integer.

Constructor Summary

Constructors
Constructor and Description
`SwingDialog(Component c, int messageType, boolean scrollBars)` Creates a dialog box containing the given component.
`SwingDialog(Component c, int optionType, int messageType, boolean scrollBars)` Creates a dialog box containing the given component.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Component`	`getFocus()` Gets the `Component` that will have the initial keyboard focus.
`Component`	`getParent()` Gets the frame in which the dialog is displayed.
`String`	`getTitle()` Gets the title string that will be displayed in the dialog title bar.
`boolean`	`isModal()` Gets whether the dialog is modal.
`boolean`	`isResizable()` Gets whether the dialog is resizable by the user.
`boolean`	`isSizeLimited()` Gets whether the dialog's size is limited by the screen size.
`boolean`	`isVisible()` Whether the dialog is currently being shown onscreen.
`void`	`setFocus(Component focusComponent)` Sets the `Component` that will have the initial keyboard focus.
`void`	`setModal(boolean modal)` Specifies whether this dialog should be modal.
`void`	`setParent(Component parentComponent)` Sets the frame in which the dialog is displayed; if the `parentComponent` has no `Frame`, a default one is used.
`void`	`setResizable(boolean resizable)` Sets whether this dialog is resizable by the user.
`void`	`setSizeLimited(boolean sizeLimited)` Sets whether this dialog's size is limited by the screen size.
`void`	`setTitle(String title)` Sets the title string to display in the dialog title bar.
`int`	`show()` Shows the dialog.

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

- Field Detail
  - UNKNOWN_OPTION
```
public static final int UNKNOWN_OPTION
```
    Catch-all return value of show() if return value is non-integer.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SwingDialog
```
public SwingDialog(Component c,
                   int messageType,
                   boolean scrollBars)
```
    Creates a dialog box containing the given component.
    By default, the dialog is modal, resizable, and size limited, with no parent component and no explicit focus component.
    
    If shown as a modal dialog, there will be a single OK button; otherwise, no buttons will be displayed.
    
    Parameters:
    
    c - the Component to display
    
    messageType - the type of message to be displayed: JOptionPane.ERROR_MESSAGE, JOptionPane.INFORMATION_MESSAGE, JOptionPane.WARNING_MESSAGE, JOptionPane.QUESTION_MESSAGE, or JOptionPane.PLAIN_MESSAGE
    
    scrollBars - whether to show scroll bars if the content is too large to fit in the window.
  - SwingDialog
```
public SwingDialog(Component c,
                   int optionType,
                   int messageType,
                   boolean scrollBars)
```
    Creates a dialog box containing the given component.
    By default, the dialog is modal, resizable, and size limited, with no parent component and no explicit focus component.
    
    If shown as a modal dialog, there will be buttons corresponding to the specified optionType; otherwise, no buttons will be displayed.
    
    Parameters:
    
    c - the Component to display
    
    optionType - the options to display in the pane: JOptionPane.DEFAULT_OPTION, JOptionPane.YES_NO_OPTION, JOptionPane.YES_NO_CANCEL_OPTION, or JOptionPane.OK_CANCEL_OPTION
    
    messageType - the type of message to be displayed: JOptionPane.ERROR_MESSAGE, JOptionPane.INFORMATION_MESSAGE, JOptionPane.WARNING_MESSAGE, JOptionPane.QUESTION_MESSAGE, or JOptionPane.PLAIN_MESSAGE
    
    scrollBars - whether to show scroll bars if the content is too large to fit in the window.
- Method Detail
  - getParent
```
public Component getParent()
```
    Gets the frame in which the dialog is displayed.
  - setParent
```
public void setParent(Component parentComponent)
```
    Sets the frame in which the dialog is displayed; if the parentComponent has no Frame, a default one is used.
  - getFocus
```
public Component getFocus()
```
    Gets the Component that will have the initial keyboard focus.
  - setFocus
```
public void setFocus(Component focusComponent)
```
    Sets the Component that will have the initial keyboard focus.
  - getTitle
```
public String getTitle()
```
    Gets the title string that will be displayed in the dialog title bar.
  - setTitle
```
public void setTitle(String title)
```
    Sets the title string to display in the dialog title bar.
  - isModal
```
public boolean isModal()
```
    Gets whether the dialog is modal.
  - setModal
```
public void setModal(boolean modal)
```
    Specifies whether this dialog should be modal.
    Note that non-modal dialogs do not show any buttons (e.g., OK or Cancel), regardless of the specified optionType, since the show() method does not block in that case.
    
    Parameters:
    
    modal - specifies whether dialog blocks input to other windows when shown
  - isResizable
```
public boolean isResizable()
```
    Gets whether the dialog is resizable by the user.
  - setResizable
```
public void setResizable(boolean resizable)
```
    Sets whether this dialog is resizable by the user.
    
    Parameters:
    
    resizable - true if the user can resize this dialog; false otherwise.
    
    See Also:
    
    Dialog.isResizable()
  - isSizeLimited
```
public boolean isSizeLimited()
```
    Gets whether the dialog's size is limited by the screen size.
  - setSizeLimited
```
public void setSizeLimited(boolean sizeLimited)
```
    Sets whether this dialog's size is limited by the screen size.
  - show
```
public int show()
```
    Shows the dialog.
    Returns:
    the option selected by the user. Depending on the dialog's optionType, will be one of:
    
    JOptionPane.YES_OPTION
    
    JOptionPane.NO_OPTION
    
    JOptionPane.CANCEL_OPTION
    
    JOptionPane.OK_OPTION
    
    JOptionPane.CLOSED_OPTION
    
    UNKNOWN_OPTION
    
    If the dialog is non-modal, JOptionPane.OK_OPTION is always returned, regardless of the specified optionType.
  - isVisible
```
public boolean isVisible()
```
    Whether the dialog is currently being shown onscreen.

Class SwingDialog

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNKNOWN_OPTION

Constructor Detail

SwingDialog

SwingDialog

Method Detail

getParent

setParent

getFocus

setFocus

getTitle

setTitle

isModal

setModal

isResizable

setResizable

isSizeLimited

setSizeLimited

show

isVisible