Package org.eclipse.jface.databinding.dialog

Class DialogPageSupport

java.lang.Object

org.eclipse.jface.databinding.dialog.DialogPageSupport

Direct Known Subclasses:

PreferencePageSupport, WizardPageSupport

public class DialogPageSupport
extends Object

Connects the validation result from the given data binding context to the given dialog page, updating the page's error message accordingly.

Since:

1.3

Field Summary

Fields

Modifier and Type	Field	Description
protected IStatus	currentStatus
protected boolean	currentStatusStale

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DialogPageSupport(DialogPage dialogPage, DataBindingContext dbc)

Method Summary

Modifier and Type	Method	Description
static DialogPageSupport	create(DialogPage dialogPage, DataBindingContext dbc)	Connect the validation result from the given data binding context to the given dialog page.
void	dispose()	Disposes of this wizard page support object, removing any listeners it may have attached.
protected DialogPage	getDialogPage()
protected void	handleStatusChanged()
protected void	handleStatusException()
protected void	handleUIChanged()
protected void	init()
void	setValidationMessageProvider(IValidationMessageProvider messageProvider)	Sets the IValidationMessageProvider to use for providing the message text and message type to display on the dialog page.

Methods inherited from class java.lang.Object

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

Field Detail

currentStatus

protected IStatus currentStatus

currentStatusStale

protected boolean currentStatusStale

Constructor Detail

DialogPageSupport

protected DialogPageSupport(DialogPage dialogPage,
                            DataBindingContext dbc)

Parameters:

dialogPage - the dialog page to show validation errors on

dbc - the binding context to connect

Restriction:

This constructor is not intended to be referenced by clients.

Method Detail

create

public static DialogPageSupport create(DialogPage dialogPage,
                                       DataBindingContext dbc)

Connect the validation result from the given data binding context to the given dialog page. The page's error message will not be set at time of creation, ensuring that the dialog page does not show an error right away. Upon any validation result change, the dialog page's error message will be updated according to the current validation result.

Parameters:

dialogPage - the dialog page to show validation errors on

dbc - the binding context to connect

Returns:

an instance of WizardPageSupport

setValidationMessageProvider

public void setValidationMessageProvider(IValidationMessageProvider messageProvider)

Sets the IValidationMessageProvider to use for providing the message text and message type to display on the dialog page.

Parameters:

messageProvider - The IValidationMessageProvider to use for providing the message text and message type to display on the dialog page.

Since:

1.4

getDialogPage

protected DialogPage getDialogPage()

Returns:

the dialog page

Restriction:

This method is not intended to be referenced by clients.

init

protected void init()

Restriction:

This method is not intended to be referenced by clients.

handleUIChanged

protected void handleUIChanged()

Restriction:

This method is not intended to be referenced by clients.

handleStatusChanged

protected void handleStatusChanged()

Restriction:

This method is not intended to be referenced by clients.

handleStatusException

protected void handleStatusException()

Restriction:

This method is not intended to be referenced by clients.

dispose

public void dispose()

Disposes of this wizard page support object, removing any listeners it may have attached.