org.springframework.richclient.dialog
Interface DialogPage

All Superinterfaces:

ControlFactory, Guarded, Messagable, PropertyChangePublisher

All Known Subinterfaces:

WizardPage

All Known Implementing Classes:

AbstractDialogPage, AbstractWizardPage, CompositeDialogPage, FormBackedDialogPage, FormBackedPreferencePage, FormBackedWizardPage, PreferencePage, SetupIntroWizardPage, SetupLicenseWizardPage, TabbedDialogPage, TreeCompositeDialogPage

public interface DialogPage
extends ControlFactory, Messagable, Guarded, PropertyChangePublisher

DialogPages are used to combine several controls in one Dialog which acts as a container. Different implementations are available to create tabs/trees or wizard-like sequences.

Author:

Keith Donald

Field Summary

static String	DESCRIPTION_PROPERTY
static String	PAGE_COMPLETE_PROPERTY

Fields inherited from interface org.springframework.richclient.dialog.Messagable

MESSAGE_PROPERTY

Method Summary

String	getDescription() Returns this dialog page's description text.
Icon	getIcon() Returns this dialog page's icon.
String	getId() Returns this page's name.
Image	getImage() Returns this dialog page's image.
Message	getMessage() Returns the current message for this dialog page.
String	getTitle() Returns this dialog page's title.
boolean	isPageComplete() Returns whether this page is complete or not.
boolean	isVisible() Returns the visibility of this dialog page.
void	performHelp() Notifies that help has been requested for this dialog page.
void	setVisible(boolean visible) Sets the visibility of this dialog page.

Methods inherited from interface org.springframework.richclient.factory.ControlFactory

getControl

Methods inherited from interface org.springframework.richclient.dialog.Messagable

setMessage

Methods inherited from interface org.springframework.binding.value.PropertyChangePublisher

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface org.springframework.richclient.core.Guarded

isEnabled, setEnabled

Field Detail

DESCRIPTION_PROPERTY

static final String DESCRIPTION_PROPERTY

See Also:

Constant Field Values

PAGE_COMPLETE_PROPERTY

static final String PAGE_COMPLETE_PROPERTY

See Also:

Constant Field Values

Method Detail

getId

String getId()

Returns this page's name.

Returns:

the name of this page

getTitle

String getTitle()

Returns this dialog page's title.

Returns:

the title of this dialog page, or null if none

getDescription

String getDescription()

Returns this dialog page's description text.

Returns:

the description text for this dialog page, or null if none

getMessage

Message getMessage()

Returns the current message for this dialog page.

Returns:

the message, or null if none

getImage

Image getImage()

Returns this dialog page's image.

Returns:

the image for this dialog page, or null if none

getIcon

Icon getIcon()

Returns this dialog page's icon.

Returns:

the icon for this dialog page, or null if none

performHelp

void performHelp()

Notifies that help has been requested for this dialog page.

setVisible

void setVisible(boolean visible)

Sets the visibility of this dialog page.

Parameters:

visible - true to make this page visible, and false to hide it

isVisible

boolean isVisible()

Returns the visibility of this dialog page.

Returns:

true this page is visible, or false if this page is hidden

isPageComplete

boolean isPageComplete()

Returns whether this page is complete or not.

This information is typically to decide when it is okay to submit a form.

Returns:

true if this page is complete, and false otherwise