public abstract class ConfiguredMessageLineDialog extends Dialog implements IWidgetManagerListener
It is the parent to some configured dialogs found in the IBM Sales Center.
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
IBM copyright notice field
|
protected org.eclipse.swt.widgets.Control | messageArea
The Message area; null until dialog is layed out.
|
static int | THROBBER
Constant for a message with a throbber animated icon (value 10).
|
Constructor and Description |
---|
ConfiguredMessageLineDialog()
Create the configured dialog.
|
Modifier and Type | Method and Description |
---|---|
boolean | close()
This method disposes the composites.
|
protected org.eclipse.swt.widgets.Control | createButtonBar(org.eclipse.swt.widgets.Composite parent)
This method creates and returns the contents of this dialog's button bar.
|
protected org.eclipse.swt.widgets.Control | createContents(org.eclipse.swt.widgets.Composite parent)
The ConfiguredMessageLineDialog implementation of this Window method creates and lays out the top level composite for the dialog.
|
protected org.eclipse.swt.widgets.Control | createDialogArea(org.eclipse.swt.widgets.Composite parent)
This method creates and returns the contents of the upper part of the dialog (above the button bar).
|
protected org.eclipse.swt.widgets.Control | createMessageArea(org.eclipse.swt.widgets.Composite parent)
This method creates and returns the contents of the message area.
|
protected IManagedComposite | getButtonBarManagedComposite()
This method returns the button bar managed composite.
|
protected abstract java.lang.String | getButtonBarManagedCompositeId()
This method returns the button bar managed composite ID.
|
protected IManagedComposite | getDialogAreaManagedComposite()
This method returns the dialog area managed composite
|
protected abstract java.lang.String | getDialogAreaManagedCompositeId()
This method returns the dialog area managed composite ID.
|
protected org.eclipse.swt.widgets.Control | getMessageArea()
This method returns the message area control.
|
protected WidgetManagerInputProperties | getWidgetManagerInputProperties()
This method returns the widget manager input properties.
|
boolean | hasRequiredInput()
This method returns whether the dialog's required input has been entered.
|
boolean | isDirty()
This method returns whether anything in the dialog has been modified.
|
void | setData(java.lang.String key, java.lang.Object value)
This method sets the dialog data.
|
void | setMessage(java.lang.String newMessage)
This method sets the message text.
|
void | setMessage(java.lang.String newMessage, int newType)
This method sets the message for this dialog with an indication of what type of message it is.
|
void | widgetManagerChanged(WidgetManagerEvent widgetManagerEvent)
This method handles widget manager events.
|
public static final java.lang.String COPYRIGHT
public static final int THROBBER
protected org.eclipse.swt.widgets.Control messageArea
public ConfiguredMessageLineDialog()
protected org.eclipse.swt.widgets.Control createContents(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.swt.widgets.Control createButtonBar(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.swt.widgets.Control createDialogArea(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.swt.widgets.Control createMessageArea(org.eclipse.swt.widgets.Composite parent)
Subclasses should not override.
protected org.eclipse.swt.widgets.Control getMessageArea()
Clients may call this framework method, but should not override it.
protected abstract java.lang.String getDialogAreaManagedCompositeId()
protected abstract java.lang.String getButtonBarManagedCompositeId()
protected WidgetManagerInputProperties getWidgetManagerInputProperties()
protected IManagedComposite getDialogAreaManagedComposite()
protected IManagedComposite getButtonBarManagedComposite()
public boolean close()
public void widgetManagerChanged(WidgetManagerEvent widgetManagerEvent)
public void setData(java.lang.String key, java.lang.Object value)
public boolean hasRequiredInput()
public boolean isDirty()
public void setMessage(java.lang.String newMessage)
Shortcut for setMessage(newMessage, IMessageProvider.NONE).
This method should be called after the dialog has been opened as it updates the message label immediately.public void setMessage(java.lang.String newMessage, int newType)
The valid message types are one of IMessageProvider.NONE, IMessageProvider.INFORMATION, IMessageProvider.ERROR, or THROBBER.