org.mdiutil.swing

Class DialogBuilder

java.lang.Object

org.mdiutil.swing.DialogBuilder

All Implemented Interfaces:

IDialogBuilder

public class DialogBuilder
extends Object
implements IDialogBuilder

The DialogBuilder allows to create a dialog with one or more parts which are layout vertically or horizontally.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DialogBuilder.DialogPart Represents a dialog part.

Field Summary

Fields inherited from interface org.mdiutil.swing.IDialogBuilder

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

Constructor Summary

Constructors

Constructor and Description
DialogBuilder()
DialogBuilder(String title) Constructor.
DialogBuilder(String title, short dialogType, int messageType) Constructor.

Method Summary

Modifier and Type	Method and Description
DialogBuilder.DialogPart	addHorizontalDialogPart() Add a dialog part where the components are layout horizontally.
DialogBuilder.DialogPart	addHorizontalDialogPart(JComponent... content) Add a dialog part where the components are layout horizontally.
DialogBuilder.DialogPart	addHorizontalDialogPart(String id) Add a dialog part where the components are layout horizontally.
DialogBuilder.DialogPart	addHorizontalDialogPart(String title, JComponent... content) Add a dialog part where the components are layout horizontally.
DialogBuilder.DialogPart	addHorizontalDialogPart(String id, String title, JComponent... content) Add a dialog part where the components are layout horizontally.
DialogBuilder.DialogPart	addVerticalDialogPart() Add a dialog part where the components are layout vertically.
DialogBuilder.DialogPart	addVerticalDialogPart(JComponent... content) Add a dialog part where the components are layout vertically.
DialogBuilder.DialogPart	addVerticalDialogPart(String id) Add a dialog part where the components are layout vertically.
DialogBuilder.DialogPart	addVerticalDialogPart(String title, JComponent... content) Add a dialog part where the components are layout vertically.
DialogBuilder.DialogPart	addVerticalDialogPart(String id, String title, JComponent... content) Add a dialog part where the components are layout vertically.
JPanel	createApplyPanel() Creates the Apply panel, in the IDialogBuilder.CUSTOM_DIALOG type.
JDialogBuilderDialog	createDialog(Component parent) Show a dialog with the default dialog opening type.
JPanel	createDialogContent() Create the dialog main panel or component.
JDialogBuilderDialog	createMessageDialog(Component parent, String title, int messageType, boolean isModal, boolean isResizable, String... messages) Show a message dialog, with an OK button.
String	getCancelLabel() Return the label for the "Cancel" button, in a IDialogBuilder.YES_CANCEL_DIALOG.
String	getDialogTitle() Return the dialog title.
short	getDialogType() Return the dialog type.
int	getHorizontalMenusSeparation() Return the horizontal menus separation.
Insets	getInsets() Return the insets of each component in the resulting dialog.
JMenuBar	getJMenuBar() Return the dialog menu bar.
JToolBar	getJToolBar() Return the dialog toolbar.
int	getMessageType() Return the message type, specifyng the type of icon which will be presented in the dialog.
Dimension	getSize() Return the dimension of the dialog.
int	getVerticalMenusSeparation() Return the vertical menus separation.
String	getYesLabel() Return the label for the "Yes" button, in a IDialogBuilder.YES_CANCEL_DIALOG, or the "OK" button in the IDialogBuilder.OK_DIALOG.
boolean	isModal() Return true if the dialog window is modal.
boolean	isResizable() Return true if the dialog window is resizable.
void	setApplyPanel(JPanel applyPanel) Set the Apply panel
void	setCancelLabel(String label) Set the label for the "Cancel" button, used in a IDialogBuilder.YES_CANCEL_DIALOG.
void	setDialogTitle(String title) Set the dialog title.
void	setDialogType(short dialogType) Set the dialog type.
void	setHorizontalMenusSeparation(int horizontalSeparation) Set the horizontal menus separation.
void	setInsets(Insets insets) Set the insets of each component in the resulting dialog.
void	setInsets(int insets) Set the insets of each component in the resulting dialog.
void	setJMenuBar(JMenuBar menubar) Set the dialog menu bar.
void	setJToolBar(JToolBar toolbar) Set the dialog toolbar.
void	setMessageType(int messageType) Set the message type.
void	setModal(boolean isModal) Set if the dialog window is modal.
void	setResizable(boolean isResizable) Set if the dialog window is resizable.
void	setSize(Dimension size) Set the dimension of the dialog.
void	setVerticalMenusSeparation(int verticalSeparation) Set the vertical menus separation.
void	setYesLabel(String label) Set the label for the "Yes" button, used in a IDialogBuilder.YES_CANCEL_DIALOG, or the "OK" button in the IDialogBuilder.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.mdiutil.swing.IDialogBuilder

getContentBorder

Constructor Detail

DialogBuilder

public DialogBuilder()

DialogBuilder

public DialogBuilder(String title)

Constructor.

Parameters:

title - the title

DialogBuilder

public DialogBuilder(String title,
                     short dialogType,
                     int messageType)

Constructor.

Parameters:

title - the title

dialogType - the dialog type

messageType - the message type

Method Detail

setInsets

public void setInsets(int insets)

Set the insets of each component in the resulting dialog.

Parameters:

insets - the insets

setInsets

public void setInsets(Insets insets)

Set the insets of each component in the resulting dialog.

Parameters:

insets - the insets

getInsets

public Insets getInsets()

Return the insets of each component in the resulting dialog.

Returns:

the insets

createDialog

public JDialogBuilderDialog createDialog(Component parent)

Show a dialog with the default dialog opening type.

Parameters:

parent - the component parent

Returns:

the result, can be JFileChooser.APPROVE_OPTION, or JFileChooser.CANCEL_OPTION

createMessageDialog

public JDialogBuilderDialog createMessageDialog(Component parent,
                                                String title,
                                                int messageType,
                                                boolean isModal,
                                                boolean isResizable,
                                                String... messages)

Show a message dialog, with an OK button.

Parameters:

parent - the component parent

title - the dialog title

messageType - the message type

isModal - true if the dialog is modal

isResizable - true if the dialog is resizable

messages - the list of messages, which will be shown in a vertical grid

Returns:

the result, will be JFileChooser.APPROVE_OPTION

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 JPanel createDialogContent()

Create the dialog main panel or component.

Specified by:

createDialogContent in interface IDialogBuilder

Returns:

the dialog main panel

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 IDialogBuilder

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 IDialogBuilder

Returns:

true if the dialog window is resizable

setSize

public void setSize(Dimension size)

Set the dimension of the dialog.

Parameters:

size - the dimension of the dialog

getSize

public Dimension getSize()

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

Specified by:

getSize in interface IDialogBuilder

Returns:

the dimension of the dialog

setDialogType

public void setDialogType(short dialogType)

Set the dialog type. It can be:

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

Parameters:

dialogType - the dialog type

getDialogType

public short getDialogType()

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

Specified by:

getDialogType in interface IDialogBuilder

Returns:

the dialog type

setMessageType

public void setMessageType(int messageType)

Set the message type. It can be:

• IDialogBuilder.PLAIN_MESSAGE for a default dialog without any icon
• IDialogBuilder.ERROR_MESSAGE for a dialog with an error icon
• IDialogBuilder.INFORMATION_MESSAGE for a dialog with an information icon
• IDialogBuilder.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 IDialogBuilder.PLAIN_MESSAGE by default, which means that there will be no icon.

Specified by:

getMessageType in interface IDialogBuilder

Returns:

the message type

setDialogTitle

public void setDialogTitle(String title)

Set the dialog title.

Parameters:

title - the dialog title

getDialogTitle

public String getDialogTitle()

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

Specified by:

getDialogTitle in interface IDialogBuilder

Returns:

the dialog title

setYesLabel

public void setYesLabel(String label)

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

Parameters:

label - the label

getYesLabel

public String getYesLabel()

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

Specified by:

getYesLabel in interface IDialogBuilder

Returns:

the label.

setCancelLabel

public void setCancelLabel(String label)

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

Parameters:

label - the label

getCancelLabel

public String getCancelLabel()

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

Specified by:

getCancelLabel in interface IDialogBuilder

Returns:

the label.

setJMenuBar

public void setJMenuBar(JMenuBar menubar)

Set the dialog menu bar.

Parameters:

menubar - the menu bar

getJMenuBar

public JMenuBar getJMenuBar()

Return the dialog menu bar.

Specified by:

getJMenuBar in interface IDialogBuilder

Returns:

the menu bar

setJToolBar

public void setJToolBar(JToolBar toolbar)

Set the dialog toolbar.

Parameters:

toolbar - the toolbar

getJToolBar

public JToolBar getJToolBar()

Return the dialog toolbar.

Specified by:

getJToolBar in interface IDialogBuilder

Returns:

the toolbar

setApplyPanel

public void setApplyPanel(JPanel applyPanel)

Set the Apply panel

Parameters:

applyPanel - the panel

createApplyPanel

public JPanel createApplyPanel()

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

Specified by:

createApplyPanel in interface IDialogBuilder

Returns:

the Apply panel

addHorizontalDialogPart

public DialogBuilder.DialogPart addHorizontalDialogPart(String title,
                                                        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 DialogBuilder.DialogPart addHorizontalDialogPart(String id,
                                                        String title,
                                                        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 DialogBuilder.DialogPart addVerticalDialogPart(String title,
                                                      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 DialogBuilder.DialogPart addVerticalDialogPart(String id,
                                                      String title,
                                                      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 DialogBuilder.DialogPart addVerticalDialogPart(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 DialogBuilder.DialogPart addHorizontalDialogPart(JComponent... content)

Add a dialog part where the components are layout horizontally.

Parameters:

content - the dialog part content

Returns:

the dialog part

addVerticalDialogPart

public DialogBuilder.DialogPart addVerticalDialogPart()

Add a dialog part where the components are layout vertically.

Returns:

the dialog part

addVerticalDialogPart

public DialogBuilder.DialogPart addVerticalDialogPart(String id)

Add a dialog part where the components are layout vertically.

Parameters:

id - the dialog part id

Returns:

the dialog part

addHorizontalDialogPart

public DialogBuilder.DialogPart addHorizontalDialogPart()

Add a dialog part where the components are layout horizontally.

Returns:

the dialog part

addHorizontalDialogPart

public DialogBuilder.DialogPart addHorizontalDialogPart(String id)

Add a dialog part where the components are layout horizontally.

Parameters:

id - the id of the dialog part

Returns:

the dialog part