org.springframework.richclient.selection.dialog
Class AbstractSelectionDialog

Show UML class diagram

java.lang.Object
  org.springframework.richclient.application.support.ApplicationServicesAccessor
      org.springframework.richclient.dialog.ApplicationDialog
          org.springframework.richclient.selection.dialog.AbstractSelectionDialog

All Implemented Interfaces:

Guarded, TitleConfigurable

Direct Known Subclasses:

ListSelectionDialog

public abstract class AbstractSelectionDialog
extends ApplicationDialog

Base class for selection dialogs.

Author:

Peter De Bruycker

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

Constructor Summary

AbstractSelectionDialog(String title, Window parent)

Method Summary

protected JComponent	createDialogContentPane() Return the GUI which allows the user to manipulate the business objects related to this dialog.
protected abstract JComponent	createSelectionComponent()
protected abstract Object	getSelectedObject()
protected void	onAboutToShow() Template lifecycle method invoked right before the dialog is to become visible.
protected boolean	onFinish() Request invocation of the action taken when the user hits the OK (finish) button.
protected void	onSelect(Object selection)
void	setDescription(String desc)
void	setOnAboutToShow(Closure onAboutToShow)
void	setOnSelectAction(Closure onSelectAction)

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

addActionKeyBinding, addActionKeyBinding, addDialogComponents, attachListeners, componentsChanged, createButtonBar, createDialog, dispose, disposeDialogContentPane, 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, 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

AbstractSelectionDialog

public AbstractSelectionDialog(String title,
                               Window parent)

Method Detail

createDialogContentPane

protected JComponent createDialogContentPane()

Description copied from class: ApplicationDialog

Return the GUI which allows the user to manipulate the business objects related to this dialog. This GUI will be placed above the OK and Cancel buttons, in a standard manner.

Any components/objects created at this point need to be disposed in ApplicationDialog.disposeDialogContentPane().

Specified by:

createDialogContentPane in class ApplicationDialog

See Also:

ApplicationDialog.disposeDialogContentPane()

createSelectionComponent

protected abstract JComponent createSelectionComponent()

onFinish

protected 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.

setDescription

public void setDescription(String desc)

getSelectedObject

protected abstract Object getSelectedObject()

onSelect

protected void onSelect(Object selection)

setOnSelectAction

public void setOnSelectAction(Closure onSelectAction)

setOnAboutToShow

public void setOnAboutToShow(Closure onAboutToShow)

onAboutToShow

protected void onAboutToShow()

Description copied from class: ApplicationDialog

Template lifecycle method invoked right before the dialog is to become visible.

Overrides:

onAboutToShow in class ApplicationDialog