org.springframework.richclient.dialog
Class TitledPageApplicationDialog

java.lang.Object
  org.springframework.richclient.application.support.ApplicationServicesAccessor
      org.springframework.richclient.dialog.ApplicationDialog
          org.springframework.richclient.dialog.TitledApplicationDialog
              org.springframework.richclient.dialog.TitledPageApplicationDialog

All Implemented Interfaces:

PropertyChangePublisher, DescriptionConfigurable, Guarded, TitleConfigurable, Messagable, ImageConfigurable

Direct Known Subclasses:

ContactPropertiesDialog, PreferenceDialog

public abstract class TitledPageApplicationDialog
extends TitledApplicationDialog

A TitledApplicationDialog that delegates to a single DialogPage for its title, content and messages.

Author:

oliverh

Field Summary

Fields inherited from class org.springframework.richclient.dialog.ApplicationDialog

DEFAULT_CANCEL_COMMAND_ID, DEFAULT_FINISH_COMMAND_ID, DEFAULT_FINISH_SUCCESS_MESSAGE_KEY, DEFAULT_FINISH_SUCCESS_TITLE_KEY, logger, SUCCESS_FINISH_MESSAGE_KEY, SUCCESS_FINISH_TITLE_KEY

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

MESSAGE_PROPERTY

Constructor Summary

TitledPageApplicationDialog()
Default constructor.

TitledPageApplicationDialog(DialogPage dialogPage)

TitledPageApplicationDialog(DialogPage dialogPage, Window parent)

TitledPageApplicationDialog(DialogPage dialogPage, Window parent, CloseAction closeAction)

TitledPageApplicationDialog(Form form, Window parent)

Method Summary

protected JComponent	createTitledDialogContentPane()
protected Message	getDescription()
protected DialogPage	getDialogPage()
protected void	setDialogPage(DialogPage dialogPage)
void	setTitlePaneImage(Image image) Sets the image to use in the title pane.
void	setTitlePaneTitle(String title) Sets the title to use in the title pane.
protected void	update()
protected void	updateMessagePane()
protected void	updateTitlePane()

Methods inherited from class org.springframework.richclient.dialog.TitledApplicationDialog

addDialogComponents, addPropertyChangeListener, addPropertyChangeListener, createDialogContentPane, disposeDialogContentPane, getMessage, getTitlePaneImage, getTitlePaneTitle, isMessageShowing, removePropertyChangeListener, removePropertyChangeListener, setCaption, setContentPane, setDescription, setImage, setMessage

Methods inherited from class org.springframework.richclient.dialog.ApplicationDialog

addActionKeyBinding, addActionKeyBinding, attachListeners, componentsChanged, createButtonBar, createDialog, dispose, getActionMap, getCallingCommand, getCancelCommand, getCancelCommandId, getCommandGroupMembers, getDialog, getDialogContentPane, getDisplayFinishSuccessMessage, getFinishCommand, getFinishCommandId, getFinishSecurityControllerId, getFinishSuccessMessage, getFinishSuccessMessageArguments, getFinishSuccessTitle, getFinishSuccessTitleArguments, getInputMap, getLocation, getLocationRelativeTo, getParentComponent, getParentWindow, getPreferredSize, getTitle, getWindowForComponent, hide, init, isControlCreated, isEnabled, isShowing, onAboutToShow, onCancel, onFinish, onInitialized, onWindowActivated, onWindowClosing, onWindowGainedFocus, onWindowLostFocus, registerCancelCommandAsDefault, registerDefaultCommand, registerDefaultCommand, setCallingCommand, setCloseAction, setDefaultEnabled, setDisplayFinishSuccessMessage, setEnabled, setFinishEnabled, setLocation, setLocationRelativeTo, setModal, setParentComponent, setPreferredSize, setResizable, setTitle, showDialog, showFinishSuccessMessageDialog

Methods inherited from class org.springframework.richclient.application.support.ApplicationServicesAccessor

getActiveWindow, getApplication, getApplicationContext, getApplicationName, getApplicationServices, getCommandConfigurer, getComponentFactory, getConversionService, getIconSource, getImageSource, getMessage, getMessage, getMessage, getMessage, getMessages, getMessageSource, getObjectConfigurer, getService

Methods inherited from class java.lang.Object

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

Constructor Detail

TitledPageApplicationDialog

public TitledPageApplicationDialog()

Default constructor. Make sure to call setDialogPage(DialogPage) prior to using this dialog.

TitledPageApplicationDialog

public TitledPageApplicationDialog(DialogPage dialogPage)

TitledPageApplicationDialog

public TitledPageApplicationDialog(Form form,
                                   Window parent)

TitledPageApplicationDialog

public TitledPageApplicationDialog(DialogPage dialogPage,
                                   Window parent)

TitledPageApplicationDialog

public TitledPageApplicationDialog(DialogPage dialogPage,
                                   Window parent,
                                   CloseAction closeAction)

Method Detail

setDialogPage

protected void setDialogPage(DialogPage dialogPage)

getDialogPage

protected DialogPage getDialogPage()

createTitledDialogContentPane

protected JComponent createTitledDialogContentPane()

Specified by:

createTitledDialogContentPane in class TitledApplicationDialog

Returns:

a component that will be added as the content of the Titled Dialog.

getDescription

protected Message getDescription()

Overrides:

getDescription in class TitledApplicationDialog

update

protected void update()

updateTitlePane

protected void updateTitlePane()

updateMessagePane

protected void updateMessagePane()

setTitlePaneImage

public void setTitlePaneImage(Image image)

Sets the image to use in the title pane. Normally the image is provided by the current dialog page, but this method allows for overriding this.

If the image passed is null, the image of the dialog page will be used.

Overrides:

setTitlePaneImage in class TitledApplicationDialog

Parameters:

image - the image

See Also:

TitledApplicationDialog.setTitlePaneImage(Image)

setTitlePaneTitle

public void setTitlePaneTitle(String title)

Sets the title to use in the title pane. Normally the title is provided by the current dialog page, but this method allows for overriding this.

If the title passed is null, the title of the dialog page will be used.

Overrides:

setTitlePaneTitle in class TitledApplicationDialog

Parameters:

title - the title

See Also:

TitledApplicationDialog.setTitlePaneTitle(String)