gui.dialog
Class DialogContentPane.Layout

java.lang.Object
  gui.dialog.DialogContentPane.Layout

Enclosing class:

DialogContentPane

public static class DialogContentPane.Layout
extends java.lang.Object

Defines the general layout of a dialog.

Field Summary

private boolean	m_bCentered
private javax.swing.Icon	m_icon
private int	m_messageType
private java.lang.String	m_strTitle

Constructor Summary

DialogContentPane.Layout()
Creates a new Layout for the dialog content pane.

DialogContentPane.Layout(javax.swing.Icon a_icon)
Creates a new Layout for the dialog content pane.

DialogContentPane.Layout(int a_messageType)
Creates a new Layout for the dialog content pane.

DialogContentPane.Layout(int a_messageType, javax.swing.Icon a_icon)
Creates a new Layout for the dialog content pane.

DialogContentPane.Layout(java.lang.String a_strTitle)
Creates a new Layout for the dialog content pane.

DialogContentPane.Layout(java.lang.String a_strTitle, javax.swing.Icon a_icon)
Creates a new Layout for the dialog content pane.

DialogContentPane.Layout(java.lang.String a_strTitle, int a_messageType)
Creates a new Layout for the dialog content pane.

DialogContentPane.Layout(java.lang.String a_strTitle, int a_messageType, javax.swing.Icon a_icon)
Creates a new Layout for the dialog content pane.

Method Summary

javax.swing.Icon	getIcon() Returns the icon for the content pane.
int	getMessageType() The content pane's message type, e.g.
java.lang.String	getTitle() Returns the title of the content pane that is shown in a TitledBorder.
boolean	isCentered()

Methods inherited from class java.lang.Object

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

Field Detail

m_strTitle

private java.lang.String m_strTitle

m_messageType

private int m_messageType

m_icon

private javax.swing.Icon m_icon

m_bCentered

private boolean m_bCentered

Constructor Detail

DialogContentPane.Layout

public DialogContentPane.Layout()

Creates a new Layout for the dialog content pane. The title is empty, therefore a status bar will be shown in the content pane.

Parameters:

a_messageType - The content pane's message type, e.g. MESSAGE_TYPE_PLAIN, MESSAGE_TYPE_ERROR, ...

DialogContentPane.Layout

public DialogContentPane.Layout(int a_messageType)

Creates a new Layout for the dialog content pane. The title is empty, therefore a status bar will be shown in the content pane.

Parameters:

a_messageType - The content pane's message type, e.g. MESSAGE_TYPE_PLAIN, MESSAGE_TYPE_ERROR, ...

DialogContentPane.Layout

public DialogContentPane.Layout(java.lang.String a_strTitle)

Creates a new Layout for the dialog content pane.

Parameters:

a_strTitle - A title for the content pane that is shown in a TitledBorder. If the title is null or empty, no border is shown around the content pane. If the title is not null (may be an empty String), a status bar is shown between the content pane and the buttons.

DialogContentPane.Layout

public DialogContentPane.Layout(javax.swing.Icon a_icon)

Creates a new Layout for the dialog content pane. The title is empty, therefore a status bar will be shown in the content pane.

Parameters:

a_icon - The icon for the content pane. If is is null, the icon will be automatically chosen depending on the message type.

DialogContentPane.Layout

public DialogContentPane.Layout(int a_messageType,
                                javax.swing.Icon a_icon)

Creates a new Layout for the dialog content pane. The title is empty, therefore a status bar will be shown in the content pane.

Parameters:

a_messageType - The content pane's message type, e.g. MESSAGE_TYPE_PLAIN, MESSAGE_TYPE_ERROR, ...

a_icon - The icon for the content pane. If is is null, the icon will be automatically chosen depending on the message type.

DialogContentPane.Layout

public DialogContentPane.Layout(java.lang.String a_strTitle,
                                int a_messageType)

Creates a new Layout for the dialog content pane.

Parameters:

a_strTitle - A title for the content pane that is shown in a TitledBorder. If the title is null or empty, no border is shown around the content pane. If the title is not null (may be an empty String), a status bar is shown between the content pane and the buttons.

a_messageType - The content pane's message type, e.g. MESSAGE_TYPE_PLAIN, MESSAGE_TYPE_ERROR, ... depending on the message type.

DialogContentPane.Layout

public DialogContentPane.Layout(java.lang.String a_strTitle,
                                javax.swing.Icon a_icon)

Creates a new Layout for the dialog content pane.

Parameters:

a_strTitle - A title for the content pane that is shown in a TitledBorder. If the title is null or empty, no border is shown around the content pane. If the title is not null (may be an empty String), a status bar is shown between the content pane and the buttons.

a_icon - The icon for the content pane. If is is null, the icon will be automatically chosen depending on the message type.

DialogContentPane.Layout

public DialogContentPane.Layout(java.lang.String a_strTitle,
                                int a_messageType,
                                javax.swing.Icon a_icon)

Creates a new Layout for the dialog content pane.

Parameters:

a_strTitle - A title for the content pane that is shown in a TitledBorder. If the title is null or empty, no border is shown around the content pane. If the title is not null (may be an empty String), a status bar is shown between the content pane and the buttons.

a_messageType - The content pane's message type, e.g. MESSAGE_TYPE_PLAIN, MESSAGE_TYPE_ERROR, ...

a_icon - The icon for the content pane. If is is null, the icon will be automatically chosen depending on the message type.

Method Detail

isCentered

public boolean isCentered()

getTitle

public final java.lang.String getTitle()

Returns the title of the content pane that is shown in a TitledBorder. If the title is null or empty, no border is shown around the content pane. If the title is not null (may be an empty String), a status bar is shown between the content pane and the buttons.

Returns:

the title of the dialog content pane

getMessageType

public final int getMessageType()

The content pane's message type, e.g. MESSAGE_TYPE_PLAIN, MESSAGE_TYPE_ERROR, ...

Returns:

content pane's message type

getIcon

public final javax.swing.Icon getIcon()

Returns the icon for the content pane. If is is null, the icon will be automatically chosen depending on the message type.

Returns:

icon for the content pane.