org.springframework.richclient.preference
Class PreferenceDialog

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

All Implemented Interfaces:

PropertyChangePublisher, DescriptionConfigurable, Guarded, TitleConfigurable, Messagable, ImageConfigurable

public class PreferenceDialog
extends TitledPageApplicationDialog

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

PreferenceDialog()

PreferenceDialog(String dialogId)

Method Summary

void	addPreferencePage(PreferencePage page)
void	addPreferencePage(PreferencePage parent, PreferencePage page)
Settings	getSettings()
boolean	onFinish() Request invocation of the action taken when the user hits the OK (finish) button.
void	setSettings(Settings settings)

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

createTitledDialogContentPane, getDescription, getDialogPage, setDialogPage, setTitlePaneImage, setTitlePaneTitle, update, updateMessagePane, 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, 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

PreferenceDialog

public PreferenceDialog()

PreferenceDialog

public PreferenceDialog(String dialogId)

Method Detail

addPreferencePage

public void addPreferencePage(PreferencePage page)

addPreferencePage

public void addPreferencePage(PreferencePage parent,
                              PreferencePage page)

getSettings

public Settings getSettings()

onFinish

public boolean onFinish()

Description copied from class: ApplicationDialog

Request invocation of the action taken when the user hits the OK (finish) button.

Specified by:

onFinish in class ApplicationDialog

Returns:

true if action completed successfully; false otherwise.

setSettings

public void setSettings(Settings settings)