MDIDialogBuilder (MDIFramework API)

All Known Implementing Classes:

DefaultMDIDialogBuilder
```
public interface MDIDialogBuilder
```
This interface cab be implemented to create za built-in dialog in the GUIApplication. By default only the createDialogContent() method must be implemented.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface MDIDialogBuilder.DialogPart

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`MDIDialogBuilder.DialogPart`

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`CUSTOM_DIALOG` The Custom dialog dialog type.
`static int`	`ERROR_MESSAGE` The error message type.
`static int`	`INFORMATION_MESSAGE` The information message type.
`static short`	`OK_DIALOG` The OK dialog dialog type.
`static short`	`OK_PRINT_DIALOG` The OK / print dialog dialog type.
`static int`	`PLAIN_MESSAGE` The plain message type.
`static int`	`QUESTION_MESSAGE` The question message type.
`static int`	`WARNING_MESSAGE` The warning message type.
`static short`	`YES_CANCEL_DIALOG` The Yes / Cancel dialog dialog type.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`apply()` Fired if the user validates the dialog, which is: Click on "Yes", for a `YES_CANCEL_DIALOG` Click on "OK", for a `OK_DIALOG`
`default void`	`cancel()` Fired if the user cancels the dialog, which is: Click on "Cancel", for a `YES_CANCEL_DIALOG`
`default javax.swing.JPanel`	`createApplyPanel()` Creates the Apply panel, in the `CUSTOM_DIALOG` type.
`javax.swing.JComponent`	`createDialogContent()` Create the dialog main panel or component.
`default java.lang.String`	`getCancelLabel()` Return the label for the "Cancel" button, in a `YES_CANCEL_DIALOG`.
`default javax.swing.border.Border`	`getContentBorder()` Return the Border around the dialog content.
`default java.util.Map<java.lang.String,MDIDialogBuilder.DialogPart>`	`getDialogPartsByID()` Return the dialog parts by ID.
`default java.lang.String`	`getDialogTitle()` Return the dialog title.
`default short`	`getDialogType()` Return the dialog type.
`default java.lang.String`	`getID()` Return the ID of the Dialog.
`default javax.swing.JMenuBar`	`getJMenuBar()` Return the dialog menubar.
`default javax.swing.JToolBar`	`getJToolBar()` Return the dialog toolbar.
`default MDIBuilderDialog`	`getMDIBuilderDialog()` Return the MDIDialog.
`default int`	`getMessageType()` Return the message type, specifyng the type of icon which will be presented in the dialog.
`default java.lang.String`	`getPrintFileExtension()` Return the print file extension.
`default java.lang.String`	`getPrintLabel()` Return the label for the "Print" button, in a `OK_PRINT_DIALOG`.
`default java.awt.Dimension`	`getSize()` Return the dimension of the dialog.
`default java.lang.String`	`getYesLabel()` Return the label for the "Yes" button, in a `YES_CANCEL_DIALOG`, or the "OK" button in the `OK_DIALOG` or `OK_PRINT_DIALOG`.
`default boolean`	`isModal()` Return true if the dialog window is modal.
`default boolean`	`isResizable()` Return true if the dialog window is resizable.
`default void`	`print(java.io.File file)` Fired if the user ask to print the dialog content, which is: Click on "Print", for a `OK_PRINT_DIALOG`
`default void`	`setMDIBuilderDialog(MDIBuilderDialog mdiDialog)` Set the MDIDialog.

- Field Detail
  - YES_CANCEL_DIALOG
```
static final short YES_CANCEL_DIALOG
```
    The Yes / Cancel dialog dialog type.
    
    See Also:
    
    Constant Field Values
  - OK_DIALOG
```
static final short OK_DIALOG
```
    The OK dialog dialog type.
    
    See Also:
    
    Constant Field Values
  - OK_PRINT_DIALOG
```
static final short OK_PRINT_DIALOG
```
    The OK / print dialog dialog type.
    
    See Also:
    
    Constant Field Values
  - CUSTOM_DIALOG
```
static final short CUSTOM_DIALOG
```
    The Custom dialog dialog type. In that case, the createApplyPanel() method will be used to create the Apply panel.
    
    See Also:
    
    Constant Field Values
  - PLAIN_MESSAGE
```
static final int PLAIN_MESSAGE
```
    The plain message type.
    
    See Also:
    
    Constant Field Values
  - INFORMATION_MESSAGE
```
static final int INFORMATION_MESSAGE
```
    The information message type.
    
    See Also:
    
    Constant Field Values
  - QUESTION_MESSAGE
```
static final int QUESTION_MESSAGE
```
    The question message type.
    
    See Also:
    
    Constant Field Values
  - WARNING_MESSAGE
```
static final int WARNING_MESSAGE
```
    The warning message type.
    
    See Also:
    
    Constant Field Values
  - ERROR_MESSAGE
```
static final int ERROR_MESSAGE
```
    The error message type.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isModal
```
default boolean isModal()
```
    Return true if the dialog window is modal. Return true by default.
    
    Returns:
    
    true if the dialog window is modal
  - isResizable
```
default boolean isResizable()
```
    Return true if the dialog window is resizable. Return false by default.
    
    Returns:
    
    true if the dialog window is resizable
  - getSize
```
default java.awt.Dimension getSize()
```
    Return the dimension of the dialog. Return null by default.
    
    Returns:
    
    the dimension of the dialog
  - getDialogType
```
default short getDialogType()
```
    Return the dialog type. Return OK_DIALOG by default.
    
    Returns:
    
    the dialog type
  - getMessageType
```
default int getMessageType()
```
    Return the message type, specifyng the type of icon which will be presented in the dialog. Return PLAIN_MESSAGE by default, which means that there will be no icon. The types can be:
    - PLAIN_MESSAGE for a default dialog without any icon
    - ERROR_MESSAGE for a dialog with an error icon
    - INFORMATION_MESSAGE for a dialog with an information icon
    - QUESTION_MESSAGE for a dialog with a question icon
    Returns:
    
    the message type
  - getDialogTitle
```
default java.lang.String getDialogTitle()
```
    Return the dialog title. Return "Dialog" by default.
    
    Returns:
    
    the dialog title
  - getContentBorder
```
default javax.swing.border.Border getContentBorder()
```
    Return the Border around the dialog content. Return null by default.
    
    Returns:
    
    the Border
  - createDialogContent
```
javax.swing.JComponent createDialogContent()
```
    Create the dialog main panel or component. It should contain the content of the dialog.
    
    Returns:
    
    the dialog main panel
  - getYesLabel
```
default java.lang.String getYesLabel()
```
    Return the label for the "Yes" button, in a YES_CANCEL_DIALOG, or the "OK" button in the OK_DIALOG or OK_PRINT_DIALOG. Return "Yes" by default, for a YES_CANCEL_DIALOG or "OK", for a OK_DIALOG or OK_PRINT_DIALOG.
    
    Returns:
    
    the label.
  - createApplyPanel
```
default javax.swing.JPanel createApplyPanel()
```
    Creates the Apply panel, in the CUSTOM_DIALOG type. By default returns an empty panel.
    
    Returns:
    
    the Apply panel
  - getJMenuBar
```
default javax.swing.JMenuBar getJMenuBar()
```
    Return the dialog menubar. Return null by default.
    
    Returns:
    
    the menubar
  - getJToolBar
```
default javax.swing.JToolBar getJToolBar()
```
    Return the dialog toolbar. Return null by default.
    
    Returns:
    
    the toolbar
  - getCancelLabel
```
default java.lang.String getCancelLabel()
```
    Return the label for the "Cancel" button, in a YES_CANCEL_DIALOG. Return "Cancel" by default, for a OK_DIALOG.
    
    Returns:
    
    the label.
  - getPrintLabel
```
default java.lang.String getPrintLabel()
```
    Return the label for the "Print" button, in a OK_PRINT_DIALOG. Return "Print" by default, for a OK_PRINT_DIALOG.
    
    Returns:
    
    the label.
  - getPrintFileExtension
```
default java.lang.String getPrintFileExtension()
```
    Return the print file extension.
    
    Returns:
    
    the print file extension
  - apply
```
default void apply()
```
    Fired if the user validates the dialog, which is:
    - Click on "Yes", for a YES_CANCEL_DIALOG
    - Click on "OK", for a OK_DIALOG
  - cancel
```
default void cancel()
```
    Fired if the user cancels the dialog, which is:
    - Click on "Cancel", for a YES_CANCEL_DIALOG
  - print
```
default void print(java.io.File file)
```
    Fired if the user ask to print the dialog content, which is:
    - Click on "Print", for a OK_PRINT_DIALOG
    Parameters:
    
    file - the File to print on
  - getID
```
default java.lang.String getID()
```
    Return the ID of the Dialog. By default the ID is null. The ID is useful if you are using the MDIDialogType.UNIQUE_INSTANCE option.
    
    Returns:
    
    the ID of the dialog
  - getDialogPartsByID
```
default java.util.Map<java.lang.String,MDIDialogBuilder.DialogPart> getDialogPartsByID()
```
    Return the dialog parts by ID.
    
    Returns:
    
    the dialog parts by ID
  - setMDIBuilderDialog
```
default void setMDIBuilderDialog(MDIBuilderDialog mdiDialog)
```
    Set the MDIDialog.
    
    Parameters:
    
    mdiDialog - the MDIDialog
  - getMDIBuilderDialog
```
default MDIBuilderDialog getMDIBuilderDialog()
```
    Return the MDIDialog.
    
    Returns:
    
    the MDIDialog

Interface MDIDialogBuilder

Nested Class Summary

Field Summary

Method Summary

Field Detail

YES_CANCEL_DIALOG

OK_DIALOG

OK_PRINT_DIALOG

CUSTOM_DIALOG

PLAIN_MESSAGE

INFORMATION_MESSAGE

QUESTION_MESSAGE

WARNING_MESSAGE

ERROR_MESSAGE

Method Detail

isModal

isResizable

getSize

getDialogType

getMessageType

getDialogTitle

getContentBorder

createDialogContent

getYesLabel

createApplyPanel

getJMenuBar

getJToolBar

getCancelLabel

getPrintLabel

getPrintFileExtension

apply

cancel

print

getID

getDialogPartsByID

setMDIBuilderDialog

getMDIBuilderDialog