hu.scelightapibase.gui.comp

Interface IDialog

All Known Subinterfaces:

IRepFiltersEditorDialog

public interface IDialog

A customized JDialog class.

The content pane of the dialog (JDialog.getContentPane()) will be an IBorderPanel.

The proper way to make an initialized and prepared IDialog visible:

 

 dialog.restoreDefaultSize();
 dialog.asDialog().setVisible( true );
 
 

Author:

Andras Belicza

See Also:

IGuiFactory.newDialog(Runnable), IGuiFactory.newDialog(java.awt.Frame, Runnable), IOverlayCard

Method Summary

Methods

Modifier and Type	Method and Description
IButton	addCloseButton(java.lang.String text) Adds a close button to the buttons panel (getButtonsPanel()) using the specified text.
javax.swing.JDialog	asDialog() Casts this instance to JDialog.
void	close() Closes the dialog.
void	enlargeDialog() Enlarges the dialog, maximizes it with a small margin.
javax.swing.JPanel	getButtonsPanel() Returns the buttons panel.
IBorderPanel	getCp() Returns the custom border panel functioning as the content panel.
java.awt.Dimension	getDefaultDefaultSize() Returns the default value of the default dialog size.
java.awt.Dimension	getDefaultSize() Returns the default size of the dialog.
void	restoreDefaultSize() Restores the default size of the dialog.
void	setDefaultSize(java.awt.Dimension defaultSize) Sets the default size of the dialog.
void	setFocusTargetOnFirstShow(javax.swing.JComponent focusTarget) Sets the component to be focused on first show (when dialog is first activated).

Method Detail

asDialog

javax.swing.JDialog asDialog()

Casts this instance to JDialog.

Returns:

this as a JDialog

setDefaultSize

void setDefaultSize(java.awt.Dimension defaultSize)

Sets the default size of the dialog.

Parameters:

defaultSize - default size to be set

getDefaultSize

java.awt.Dimension getDefaultSize()

Returns the default size of the dialog.

Returns:

the default size of the dialog

getDefaultDefaultSize

java.awt.Dimension getDefaultDefaultSize()

Returns the default value of the default dialog size.

You can use this if you want to create a dialog with a default size being a little smaller than the normal size (by setting a default size being a little smaller than the returned default-default size).

Returns:

the default value of the default dialog size

getCp

IBorderPanel getCp()

Returns the custom border panel functioning as the content panel.

Returns:

the custom border panel functioning as the content panel

enlargeDialog

void enlargeDialog()

Enlarges the dialog, maximizes it with a small margin.

restoreDefaultSize

void restoreDefaultSize()

Restores the default size of the dialog.

setFocusTargetOnFirstShow

void setFocusTargetOnFirstShow(javax.swing.JComponent focusTarget)

Sets the component to be focused on first show (when dialog is first activated).

Parameters:

focusTarget - focus target component on first show to be set

addCloseButton

IButton addCloseButton(java.lang.String text)

Adds a close button to the buttons panel (getButtonsPanel()) using the specified text.

Parameters:

text - text of the close button

Returns:

the close button that was just created and added

getButtonsPanel

javax.swing.JPanel getButtonsPanel()

Returns the buttons panel.

If this is the first call, the panel will be created, initialized and added to the south of the content pane.

Returns:

the buttons panel

close

void close()

Closes the dialog. IDialogs must always be closed with this method instead of Window.dispose().