com.ibm.carma.ui.dialog
Class CarmaReturnDialog

java.lang.Object
  extended by org.eclipse.jface.window.Window
      extended by org.eclipse.jface.dialogs.Dialog
          extended by org.eclipse.jface.dialogs.IconAndMessageDialog
              extended by org.eclipse.jface.dialogs.MessageDialog
                  extended by com.ibm.carma.ui.dialog.CarmaReturnDialog
All Implemented Interfaces:
org.eclipse.jface.window.IShellProvider

public class CarmaReturnDialog
extends org.eclipse.jface.dialogs.MessageDialog

Dialog which displays custom return values to the user in a generic manner. The dialog should function like any MessageDialog.

This Class is not intended to be subclassed, but may be instantiated.

Since:
7.0

Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.jface.window.Window
org.eclipse.jface.window.Window.IExceptionHandler
 
Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from class org.eclipse.jface.dialogs.MessageDialog
ERROR, INFORMATION, NONE, QUESTION, WARNING
 
Fields inherited from class org.eclipse.jface.dialogs.Dialog
blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, 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
CarmaReturnDialog(org.eclipse.swt.widgets.Shell parentShell, java.lang.String dialogTitle, org.eclipse.swt.graphics.Image dialogTitleImage, java.lang.String dialogMessage, java.util.Map<? extends CustomActionAccepter,? extends CARMAReturn> returns)
          Creates the custom return display dialog.
 
Method Summary
 int getTableColumnCount()
          Determines the number of columns to display for the set of return contents
 
Methods inherited from class org.eclipse.jface.dialogs.MessageDialog
getImage, openConfirm, openError, openInformation, openQuestion, openWarning
 
Methods inherited from class org.eclipse.jface.dialogs.IconAndMessageDialog
getErrorImage, getInfoImage, getQuestionImage, getWarningImage
 
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, close, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, create, getBlockedHandler, getImage, setBlockedHandler, shortenText
 
Methods inherited from class org.eclipse.jface.window.Window
getDefaultImage, getDefaultImages, getDefaultOrientation, getReturnCode, getShell, getWindowManager, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setWindowManager
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Constructor Detail

CarmaReturnDialog

public CarmaReturnDialog(org.eclipse.swt.widgets.Shell parentShell,
                         java.lang.String dialogTitle,
                         org.eclipse.swt.graphics.Image dialogTitleImage,
                         java.lang.String dialogMessage,
                         java.util.Map<? extends CustomActionAccepter,? extends CARMAReturn> returns)
Creates the custom return display dialog.

Parameters:
parentShell - shell to open the dialog under
dialogTitle - dialog title
dialogTitleImage - dialog title image
dialogMessage - dialog message
returns - custom return elements to display
Method Detail

getTableColumnCount

public int getTableColumnCount()
Determines the number of columns to display for the set of return contents

Returns:
the number of columns needs for display of custom returns