com.modeliosoft.modelio.api.ui

Class ModelioDialog

java.lang.Object

org.eclipse.jface.window.Window

org.eclipse.jface.dialogs.Dialog

org.eclipse.jface.dialogs.TrayDialog

com.modeliosoft.modelio.api.ui.ModelioDialog

All Implemented Interfaces:

IModelioDialog, org.eclipse.jface.window.IShellProvider

Direct Known Subclasses:

BrowserDialog, DiagramWizardDialog, ModelioWizardDialog

public abstract class ModelioDialog
extends org.eclipse.jface.dialogs.TrayDialog
implements IModelioDialog

Dialog template that has :

• a header with :
  • a left image, modifiable with setTitleLeftImage(Image)
  • a bold title, set with setTitle(String)
  • a logo image displayed on the right side, set with setLogoImage(Image)
  • a message, set with setMessage(String).
• a user defined content area defined with IModelioDialog.createContentArea(Composite).
• a button area with user defined buttons defined with IModelioDialog.addButtonsInButtonBar(Composite).
• An optional message area that display on top of the header area, showing a warning or error small icon and a message.
  See setWarningMessage(String) and setErrorMessage(String).

Structure Diagram

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jface.window.Window

org.eclipse.jface.window.Window.IExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static String	DLG_IMG_TITLE_BANNER

Fields inherited from class org.eclipse.jface.dialogs.Dialog

blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS

Fields inherited from class org.eclipse.jface.window.Window

CANCEL, OK

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelioDialog(org.eclipse.swt.widgets.Shell parentShell)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addDefaultButtons(org.eclipse.swt.widgets.Composite parent)
protected void	createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.swt.widgets.Control	createContents(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.swt.widgets.Control	createDialogArea(org.eclipse.swt.widgets.Composite parent)
protected String	getHelpId()
protected org.eclipse.swt.graphics.Point	getInitialSize()
void	setBlockOnOpen(boolean shouldBlock)
protected void	setErrorMessage(String newErrorMessage) Set an error message that will display in the message area on top of the header of the dialog, with an error small icon.
protected void	setLogoImage(org.eclipse.swt.graphics.Image newLogoImage) Set the logo image that displays on the right side of the header.
protected void	setMessage(String newMessage) Set a message that will display in the header of the dialog.
protected void	setMessage(String newMessage, int newType)
protected void	setTitle(String newTitle) Set the title that displays in bold in the dialog header.
protected void	setTitleLeftImage(org.eclipse.swt.graphics.Image newTitleImage) Set the header image that will display in the header.
protected void	setWarningMessage(String newMessage) Set a warning message that will display in the message area on top of the dialog, with a warning small icon.

Methods inherited from class org.eclipse.jface.dialogs.TrayDialog

close, closeTray, createButtonBar, createHelpControl, getLayout, getTray, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable

Methods inherited from class org.eclipse.jface.dialogs.Dialog

applyDialogFont, buttonPressed, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getOKButton, initializeBounds, initializeDialogUnits, isResizable, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

Methods inherited from class org.eclipse.jface.window.Window

canHandleShellCloseEvent, configureShell, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.modeliosoft.modelio.api.ui.IModelioDialog

addButtonsInButtonBar, createContentArea, init

Field Detail

DLG_IMG_TITLE_BANNER

public static final String DLG_IMG_TITLE_BANNER

See Also:

Constant Field Values

Constructor Detail

ModelioDialog

protected ModelioDialog(org.eclipse.swt.widgets.Shell parentShell)

Method Detail

addDefaultButtons

protected void addDefaultButtons(org.eclipse.swt.widgets.Composite parent)

createButtonsForButtonBar

protected void createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)

Overrides:

createButtonsForButtonBar in class org.eclipse.jface.dialogs.Dialog

createContents

protected org.eclipse.swt.widgets.Control createContents(org.eclipse.swt.widgets.Composite parent)

Overrides:

createContents in class org.eclipse.jface.dialogs.Dialog

createDialogArea

protected org.eclipse.swt.widgets.Control createDialogArea(org.eclipse.swt.widgets.Composite parent)

Overrides:

createDialogArea in class org.eclipse.jface.dialogs.Dialog

getInitialSize

protected org.eclipse.swt.graphics.Point getInitialSize()

Overrides:

getInitialSize in class org.eclipse.jface.dialogs.Dialog

setErrorMessage

protected void setErrorMessage(String newErrorMessage)

Set an error message that will display in the message area on top of the header of the dialog, with an error small icon.
Removes the message if null is passed .

Parameters:

newErrorMessage - The error message or null to remove the error message.

setLogoImage

protected void setLogoImage(org.eclipse.swt.graphics.Image newLogoImage)

Set the logo image that displays on the right side of the header.

Parameters:

newLogoImage - The new logo image.

setMessage

protected void setMessage(String newMessage)

Set a message that will display in the header of the dialog.

Parameters:

newMessage - The message .

setTitle

protected void setTitle(String newTitle)

Set the title that displays in bold in the dialog header. The title is different from the dialog tray title.

Parameters:

newTitle - The header title.

setTitleLeftImage

protected void setTitleLeftImage(org.eclipse.swt.graphics.Image newTitleImage)

Set the header image that will display in the header. The image is aligned on the left of the header.

Parameters:

newTitleImage - the title image.

setWarningMessage

protected void setWarningMessage(String newMessage)

Set a warning message that will display in the message area on top of the dialog, with a warning small icon.
Removes the message if null is passed .

Parameters:

newMessage - The warning message or null to remove the warning message.

setMessage

protected void setMessage(String newMessage,
              int newType)

getHelpId

protected String getHelpId()

setBlockOnOpen

public void setBlockOnOpen(boolean shouldBlock)

Overrides:

setBlockOnOpen in class org.eclipse.jface.window.Window