org.mdi.app.swing

Class DefaultMDIDialogBuilder

java.lang.Object

org.mdi.app.swing.DefaultMDIDialogBuilder

All Implemented Interfaces:

MDIDialogBuilder

public class DefaultMDIDialogBuilder
extends java.lang.Object
implements MDIDialogBuilder

A default MDIDialogBuilder, which has one or more parts which are layout vertically.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DefaultMDIDialogBuilder.DefaultDialogPart Represents a dialog part.
static interface	DefaultMDIDialogBuilder.DialogListener Listens to apply or cancel on the dialog.

Nested classes/interfaces inherited from interface org.mdi.bootstrap.swing.MDIDialogBuilder

MDIDialogBuilder.DialogPart

Field Summary

Fields inherited from interface org.mdi.bootstrap.swing.MDIDialogBuilder

CUSTOM_DIALOG, ERROR_MESSAGE, INFORMATION_MESSAGE, OK_DIALOG, OK_PRINT_DIALOG, PLAIN_MESSAGE, QUESTION_MESSAGE, WARNING_MESSAGE, YES_CANCEL_DIALOG

Constructor Summary

Constructors

Constructor and Description
DefaultMDIDialogBuilder()
DefaultMDIDialogBuilder(java.lang.String title) Constructor.
DefaultMDIDialogBuilder(java.lang.String title, short dialogType, int messageType) Constructor.

Method Summary

Modifier and Type	Method and Description
DefaultMDIDialogBuilder.DefaultDialogPart	addHorizontalDialogPart() Add a dialog part where the components are layout horizontally.
DefaultMDIDialogBuilder.DefaultDialogPart	addHorizontalDialogPart(javax.swing.JComponent... content) Add a dialog part where the components are layout horizontally.
DefaultMDIDialogBuilder.DefaultDialogPart	addHorizontalDialogPart(java.lang.String id) Add a dialog part where the components are layout horizontally.
DefaultMDIDialogBuilder.DefaultDialogPart	addHorizontalDialogPart(java.lang.String title, javax.swing.JComponent... content) Add a dialog part where the components are layout horizontally.
DefaultMDIDialogBuilder.DefaultDialogPart	addHorizontalDialogPart(java.lang.String id, java.lang.String title, javax.swing.JComponent... content) Add a dialog part where the components are layout horizontally.
DefaultMDIDialogBuilder.DefaultDialogPart	addVerticalDialogPart() Add a dialog part where the components are layout vertically.
DefaultMDIDialogBuilder.DefaultDialogPart	addVerticalDialogPart(javax.swing.JComponent... content) Add a dialog part where the components are layout vertically.
DefaultMDIDialogBuilder.DefaultDialogPart	addVerticalDialogPart(java.lang.String id) Add a dialog part where the components are layout vertically.
DefaultMDIDialogBuilder.DefaultDialogPart	addVerticalDialogPart(java.lang.String title, javax.swing.JComponent... content) Add a dialog part where the components are layout vertically.
DefaultMDIDialogBuilder.DefaultDialogPart	addVerticalDialogPart(java.lang.String id, java.lang.String title, javax.swing.JComponent... content) Add a dialog part where the components are layout vertically.
void	apply() Fired if the user validates the dialog, which is: Click on "Yes", for a MDIDialogBuilder.YES_CANCEL_DIALOG Click on "OK", for a MDIDialogBuilder.OK_DIALOG
void	cancel() Fired if the user cancels the dialog, which is: Click on "Cancel", for a MDIDialogBuilder.YES_CANCEL_DIALOG
javax.swing.JPanel	createApplyPanel() Creates the Apply panel, in the MDIDialogBuilder.CUSTOM_DIALOG type.
javax.swing.JPanel	createDialogContent() Create the dialog main panel or component.
java.lang.String	getCancelLabel() Return the label for the "Cancel" button, in a MDIDialogBuilder.YES_CANCEL_DIALOG.
java.util.Map<java.lang.String,MDIDialogBuilder.DialogPart>	getDialogPartsByID() Return the dialog parts by ID.
java.lang.String	getDialogTitle() Return the dialog title.
short	getDialogType() Return the dialog type.
int	getHorizontalMenusSeparation() Return the horizontal menus separation.
java.lang.String	getID() Return the ID of the Dialog.By default the ID is "MDIDialogBuilder".
javax.swing.JMenuBar	getJMenuBar() Return the dialog menu bar.
javax.swing.JToolBar	getJToolBar() Return the dialog toolbar.
MDIBuilderDialog	getMDIBuilderDialog() Return the MDIBuilderDialog.
int	getMessageType() Return the message type, specifyng the type of icon which will be presented in the dialog.
java.lang.String	getPrintFileExtension() Return the print file extension.
java.lang.String	getPrintLabel() Return the label for the "Print" button, in a MDIDialogBuilder.OK_PRINT_DIALOG.
java.awt.Dimension	getSize() Return the dimension of the dialog.
int	getVerticalMenusSeparation() Return the vertical menus separation.
java.lang.String	getYesLabel() Return the label for the "Yes" button, in a MDIDialogBuilder.YES_CANCEL_DIALOG, or the "OK" button in the MDIDialogBuilder.OK_DIALOG.
boolean	isModal() Return true if the dialog window is modal.
boolean	isResizable() Return true if the dialog window is resizable.
void	print(java.io.File file) Fired if the user prints the dialog content, which is: Click on "Print", for a MDIDialogBuilder.OK_PRINT_DIALOG
void	setApplyPanel(javax.swing.JPanel applyPanel) Set the Apply panel
void	setCancelLabel(java.lang.String label) Set the label for the "Cancel" button, used in a MDIDialogBuilder.YES_CANCEL_DIALOG.
void	setDialogTitle(java.lang.String title) Set the dialog title.
void	setDialogType(short dialogType) Set the dialog type.
void	setHorizontalMenusSeparation(int horizontalSeparation) Set the horizontal menus separation.
void	setID(java.lang.String dialogID) Set the dialog ID.
void	setJMenuBar(javax.swing.JMenuBar menubar) Set the dialog menu bar.
void	setJToolBar(javax.swing.JToolBar toolbar) Set the dialog toolbar.
void	setListener(DefaultMDIDialogBuilder.DialogListener listener) Set the listener which will listen to the Yes / OK / Cancel user action.
void	setMDIBuilderDialog(MDIBuilderDialog mdiDialog) Set the MDIBuilderDialog.
void	setMessageType(int messageType) Set the message type.
void	setModal(boolean isModal) Set if the dialog window is modal.
void	setPrintFileExtension(java.lang.String extension) Set the File extension for the "Print" button, used in a MDIDialogBuilder.OK_PRINT_DIALOG.
void	setPrintLabel(java.lang.String label) Set the label for the "Print" button, used in a MDIDialogBuilder.OK_PRINT_DIALOG.
void	setResizable(boolean isResizable) Set if the dialog window is resizable.
void	setSize(java.awt.Dimension size) Set the dimension of the dialog.
void	setVerticalMenusSeparation(int verticalSeparation) Set the vertical menus separation.
void	setYesLabel(java.lang.String label) Set the label for the "Yes" button, used in a MDIDialogBuilder.YES_CANCEL_DIALOG, or the "OK" button in the MDIDialogBuilder.OK_DIALOG.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mdi.bootstrap.swing.MDIDialogBuilder

getContentBorder

Constructor Detail

DefaultMDIDialogBuilder

public DefaultMDIDialogBuilder()

DefaultMDIDialogBuilder

public DefaultMDIDialogBuilder(java.lang.String title)

Constructor.

Parameters:

title - the title

DefaultMDIDialogBuilder

public DefaultMDIDialogBuilder(java.lang.String title,
                               short dialogType,
                               int messageType)

Constructor.

Parameters:

title - the title

dialogType - the dialog type

messageType - the message type

Method Detail

setListener

public void setListener(DefaultMDIDialogBuilder.DialogListener listener)

Set the listener which will listen to the Yes / OK / Cancel user action.

Parameters:

listener - the listener

setHorizontalMenusSeparation

public void setHorizontalMenusSeparation(int horizontalSeparation)

Set the horizontal menus separation.

Parameters:

horizontalSeparation - the horizontal menus separation

getHorizontalMenusSeparation

public int getHorizontalMenusSeparation()

Return the horizontal menus separation.

Returns:

the horizontal menus separation

setVerticalMenusSeparation

public void setVerticalMenusSeparation(int verticalSeparation)

Set the vertical menus separation.

Parameters:

verticalSeparation - the vertical menus separation

getVerticalMenusSeparation

public int getVerticalMenusSeparation()

Return the vertical menus separation.

Returns:

the vertical menus separation

createDialogContent

public javax.swing.JPanel createDialogContent()

Create the dialog main panel or component.

Specified by:

createDialogContent in interface MDIDialogBuilder

Returns:

the dialog main panel

getDialogPartsByID

public java.util.Map<java.lang.String,MDIDialogBuilder.DialogPart> getDialogPartsByID()

Return the dialog parts by ID.

Specified by:

getDialogPartsByID in interface MDIDialogBuilder

Returns:

the dialog parts by ID

setModal

public void setModal(boolean isModal)

Set if the dialog window is modal.

Parameters:

isModal - true if the dialog window is modal

isModal

public boolean isModal()

Return true if the dialog window is modal. Return true by default.

Specified by:

isModal in interface MDIDialogBuilder

Returns:

true if the dialog window is modal

setResizable

public void setResizable(boolean isResizable)

Set if the dialog window is resizable.

Parameters:

isResizable - true if the dialog window is resizable

isResizable

public boolean isResizable()

Return true if the dialog window is resizable. Return false by default.

Specified by:

isResizable in interface MDIDialogBuilder

Returns:

true if the dialog window is resizable

setSize

public void setSize(java.awt.Dimension size)

Set the dimension of the dialog.

Parameters:

size - the dimension of the dialog

getSize

public java.awt.Dimension getSize()

Return the dimension of the dialog. Return null by default.

Specified by:

getSize in interface MDIDialogBuilder

Returns:

the dimension of the dialog

setDialogType

public void setDialogType(short dialogType)

Set the dialog type. It can be:

• MDIDialogBuilder.OK_DIALOG for an OK Dialog
• MDIDialogBuilder.YES_CANCEL_DIALOG for an Yes / Cancel Dialog
• MDIDialogBuilder.CUSTOM_DIALOG for a custom Dialog

Parameters:

dialogType - the dialog type

getDialogType

public short getDialogType()

Return the dialog type. Return MDIDialogBuilder.OK_DIALOG by default.

Specified by:

getDialogType in interface MDIDialogBuilder

Returns:

the dialog type

setMessageType

public void setMessageType(int messageType)

Set the message type. It can be:

• MDIDialogBuilder.PLAIN_MESSAGE for a default dialog without any icon
• MDIDialogBuilder.ERROR_MESSAGE for a dialog with an error icon
• MDIDialogBuilder.INFORMATION_MESSAGE for a dialog with an information icon
• MDIDialogBuilder.QUESTION_MESSAGE for a dialog with a question icon

Parameters:

messageType - the message type

getMessageType

public int getMessageType()

Return the message type, specifyng the type of icon which will be presented in the dialog. Return MDIDialogBuilder.PLAIN_MESSAGE by default, which means that there will be no icon.

Specified by:

getMessageType in interface MDIDialogBuilder

Returns:

the message type

setDialogTitle

public void setDialogTitle(java.lang.String title)

Set the dialog title.

Parameters:

title - the dialog title

getDialogTitle

public java.lang.String getDialogTitle()

Return the dialog title. Return "Dialog" by default.

Specified by:

getDialogTitle in interface MDIDialogBuilder

Returns:

the dialog title

setYesLabel

public void setYesLabel(java.lang.String label)

Set the label for the "Yes" button, used in a MDIDialogBuilder.YES_CANCEL_DIALOG, or the "OK" button in the MDIDialogBuilder.OK_DIALOG.

Parameters:

label - the label

getYesLabel

public java.lang.String getYesLabel()

Return the label for the "Yes" button, in a MDIDialogBuilder.YES_CANCEL_DIALOG, or the "OK" button in the MDIDialogBuilder.OK_DIALOG. Return "Yes" by default, for a MDIDialogBuilder.YES_CANCEL_DIALOG or "OK", for a MDIDialogBuilder.OK_DIALOG.

Specified by:

getYesLabel in interface MDIDialogBuilder

Returns:

the label.

setCancelLabel

public void setCancelLabel(java.lang.String label)

Set the label for the "Cancel" button, used in a MDIDialogBuilder.YES_CANCEL_DIALOG.

Parameters:

label - the label

getCancelLabel

public java.lang.String getCancelLabel()

Return the label for the "Cancel" button, in a MDIDialogBuilder.YES_CANCEL_DIALOG. Return "Cancel" by default, for a MDIDialogBuilder.OK_DIALOG.

Specified by:

getCancelLabel in interface MDIDialogBuilder

Returns:

the label.

setPrintLabel

public void setPrintLabel(java.lang.String label)

Set the label for the "Print" button, used in a MDIDialogBuilder.OK_PRINT_DIALOG.

Parameters:

label - the label

setPrintFileExtension

public void setPrintFileExtension(java.lang.String extension)

Set the File extension for the "Print" button, used in a MDIDialogBuilder.OK_PRINT_DIALOG.

Parameters:

extension - the extension

getPrintFileExtension

public java.lang.String getPrintFileExtension()

Return the print file extension.

Specified by:

getPrintFileExtension in interface MDIDialogBuilder

Returns:

the print file extension

getPrintLabel

public java.lang.String getPrintLabel()

Return the label for the "Print" button, in a MDIDialogBuilder.OK_PRINT_DIALOG. Return "Print" by default, for a MDIDialogBuilder.OK_PRINT_DIALOG.

Specified by:

getPrintLabel in interface MDIDialogBuilder

Returns:

the label.

setJMenuBar

public void setJMenuBar(javax.swing.JMenuBar menubar)

Set the dialog menu bar.

Parameters:

menubar - the menu bar

getJMenuBar

public javax.swing.JMenuBar getJMenuBar()

Return the dialog menu bar.

Specified by:

getJMenuBar in interface MDIDialogBuilder

Returns:

the menu bar

setJToolBar

public void setJToolBar(javax.swing.JToolBar toolbar)

Set the dialog toolbar.

Parameters:

toolbar - the toolbar

getJToolBar

public javax.swing.JToolBar getJToolBar()

Return the dialog toolbar.

Specified by:

getJToolBar in interface MDIDialogBuilder

Returns:

the toolbar

setApplyPanel

public void setApplyPanel(javax.swing.JPanel applyPanel)

Set the Apply panel

Parameters:

applyPanel - the panel

createApplyPanel

public javax.swing.JPanel createApplyPanel()

Creates the Apply panel, in the MDIDialogBuilder.CUSTOM_DIALOG type. By dfualt retuens an empty panel.

Specified by:

createApplyPanel in interface MDIDialogBuilder

Returns:

the Apply panel

apply

public void apply()

Fired if the user validates the dialog, which is:

• Click on "Yes", for a MDIDialogBuilder.YES_CANCEL_DIALOG
• Click on "OK", for a MDIDialogBuilder.OK_DIALOG

Specified by:

apply in interface MDIDialogBuilder

cancel

public void cancel()

Fired if the user cancels the dialog, which is:

• Click on "Cancel", for a MDIDialogBuilder.YES_CANCEL_DIALOG

Specified by:

cancel in interface MDIDialogBuilder

print

public void print(java.io.File file)

Fired if the user prints the dialog content, which is:

• Click on "Print", for a MDIDialogBuilder.OK_PRINT_DIALOG

Specified by:

print in interface MDIDialogBuilder

Parameters:

file - the File to print on

setID

public void setID(java.lang.String dialogID)

Set the dialog ID.

Parameters:

dialogID - the dialog ID

getID

public java.lang.String getID()

Return the ID of the Dialog.By default the ID is "MDIDialogBuilder". The ID is useful if you are using the MDIDialogType.UNIQUE_INSTANCE option.

Specified by:

getID in interface MDIDialogBuilder

Returns:

the ID of the dialog

setMDIBuilderDialog

public void setMDIBuilderDialog(MDIBuilderDialog mdiDialog)

Set the MDIBuilderDialog.

Specified by:

setMDIBuilderDialog in interface MDIDialogBuilder

Parameters:

mdiDialog - the MDIBuilderDialog

getMDIBuilderDialog

public MDIBuilderDialog getMDIBuilderDialog()

Return the MDIBuilderDialog.

Specified by:

getMDIBuilderDialog in interface MDIDialogBuilder

Returns:

the MDIBuilderDialog

addHorizontalDialogPart

public DefaultMDIDialogBuilder.DefaultDialogPart addHorizontalDialogPart(java.lang.String title,
                                                                         javax.swing.JComponent... content)

Add a dialog part where the components are layout horizontally.

Parameters:

content - the dialog part content

title - the dialog part title

Returns:

the dialog part

addHorizontalDialogPart

public DefaultMDIDialogBuilder.DefaultDialogPart addHorizontalDialogPart(java.lang.String id,
                                                                         java.lang.String title,
                                                                         javax.swing.JComponent... content)

Add a dialog part where the components are layout horizontally.

Parameters:

id - the dialog part id

content - the dialog part content

title - the dialog part title

Returns:

the dialog part

addVerticalDialogPart

public DefaultMDIDialogBuilder.DefaultDialogPart addVerticalDialogPart(java.lang.String title,
                                                                       javax.swing.JComponent... content)

Add a dialog part where the components are layout vertically.

Parameters:

content - the dialog part content

title - the dialog part title

Returns:

the dialog part

addVerticalDialogPart

public DefaultMDIDialogBuilder.DefaultDialogPart addVerticalDialogPart(java.lang.String id,
                                                                       java.lang.String title,
                                                                       javax.swing.JComponent... content)

Add a dialog part where the components are layout vertically.

Parameters:

id - the dialog part id (can be null)

content - the dialog part content

title - the dialog part title (can be null)

Returns:

the dialog part

addVerticalDialogPart

public DefaultMDIDialogBuilder.DefaultDialogPart addVerticalDialogPart(javax.swing.JComponent... content)

Add a dialog part where the components are layout vertically.

Parameters:

content - the dialog part content components

Returns:

the dialog part

addHorizontalDialogPart

public DefaultMDIDialogBuilder.DefaultDialogPart addHorizontalDialogPart(javax.swing.JComponent... content)

Add a dialog part where the components are layout horizontally.

Parameters:

content - the dialog part content

Returns:

the dialog part

addVerticalDialogPart

public DefaultMDIDialogBuilder.DefaultDialogPart addVerticalDialogPart()

Add a dialog part where the components are layout vertically.

Returns:

the dialog part

addVerticalDialogPart

public DefaultMDIDialogBuilder.DefaultDialogPart addVerticalDialogPart(java.lang.String id)

Add a dialog part where the components are layout vertically.

Parameters:

id - the dialog part id

Returns:

the dialog part

addHorizontalDialogPart

public DefaultMDIDialogBuilder.DefaultDialogPart addHorizontalDialogPart()

Add a dialog part where the components are layout horizontally.

Returns:

the dialog part

addHorizontalDialogPart

public DefaultMDIDialogBuilder.DefaultDialogPart addHorizontalDialogPart(java.lang.String id)

Add a dialog part where the components are layout horizontally.

Parameters:

id - the id of the dialog part

Returns:

the dialog part