org.springframework.richclient.dialog
Class TitledApplicationDialog

Show UML class diagram

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

All Implemented Interfaces:

PropertyChangePublisher, DescriptionConfigurable, Guarded, TitleConfigurable, Messagable, ImageConfigurable

Direct Known Subclasses:

AbstractReporterTitledApplicationDialog, BasicRegExpConstraintDialog, BasicTitledApplicationDialog, CalendarBindingDialog, DerivedValueModelDialog, DocumentBindingDialog, ListSelectionBindingDialog, NumberConversionDialog, ShuttleListBindingDialog, ShuttleSortableTableDialog, StringLenghtConstraintDialog, TitledPageApplicationDialog, WizardDialog

public abstract class TitledApplicationDialog
extends ApplicationDialog
implements Messagable, ImageConfigurable, DescriptionConfigurable

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

TitledApplicationDialog()

TitledApplicationDialog(String title, Window parent)

TitledApplicationDialog(String title, Window parent, CloseAction closeAction)

Method Summary

protected void	addDialogComponents() Subclasses may override to customize how this dialog is built.
void	addPropertyChangeListener(PropertyChangeListener listener) Register a listener to all properties of this publisher.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Register a listener to a specific property.
protected JComponent	createDialogContentPane() Return the GUI which allows the user to manipulate the business objects related to this dialog.
protected abstract JComponent	createTitledDialogContentPane()
protected void	disposeDialogContentPane() Dispose of the dialog content.
protected Message	getDescription()
Message	getMessage()
protected Image	getTitlePaneImage()
protected String	getTitlePaneTitle()
boolean	isMessageShowing()
void	removePropertyChangeListener(PropertyChangeListener listener) Remove the listener from all properties of this publisher.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener) Remove the listener from a specific property.
void	setCaption(String shortDescription)
protected void	setContentPane(JComponent c)
void	setDescription(String description)
void	setImage(Image image)
void	setMessage(Message message) Set the message.
void	setTitlePaneImage(Image image)
void	setTitlePaneTitle(String titleAreaText)

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

TitledApplicationDialog

public TitledApplicationDialog()

TitledApplicationDialog

public TitledApplicationDialog(String title,
                               Window parent)

TitledApplicationDialog

public TitledApplicationDialog(String title,
                               Window parent,
                               CloseAction closeAction)

Method Detail

setCaption

public void setCaption(String shortDescription)

Specified by:

setCaption in interface DescriptionConfigurable

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface DescriptionConfigurable

setTitlePaneTitle

public void setTitlePaneTitle(String titleAreaText)

getTitlePaneTitle

protected String getTitlePaneTitle()

setTitlePaneImage

public void setTitlePaneImage(Image image)

getTitlePaneImage

protected Image getTitlePaneImage()

setImage

public void setImage(Image image)

Specified by:

setImage in interface ImageConfigurable

getMessage

public Message getMessage()

setMessage

public void setMessage(Message message)

Description copied from interface: Messagable

Set the message.

Specified by:

setMessage in interface Messagable

isMessageShowing

public boolean isMessageShowing()

getDescription

protected Message getDescription()

setContentPane

protected void setContentPane(JComponent c)

addDialogComponents

protected void addDialogComponents()

Description copied from class: ApplicationDialog

Subclasses may override to customize how this dialog is built.

Overrides:

addDialogComponents in class ApplicationDialog

createDialogContentPane

protected JComponent createDialogContentPane()

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().

Creates an additional panel at the top containing a title/message area. This can be used in conjunction with validation reporters to show the most recent error or to simply show a title and a description of the current Dialog. Use createTitledDialogContentPane() to add your custom components.

Specified by:

createDialogContentPane in class ApplicationDialog

See Also:

ApplicationDialog.disposeDialogContentPane()

createTitledDialogContentPane

protected abstract JComponent createTitledDialogContentPane()

Returns:

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

disposeDialogContentPane

protected void disposeDialogContentPane()

Dispose of the dialog content.

Overrides:

disposeDialogContentPane in class ApplicationDialog

See Also:

ApplicationDialog.createDialogContentPane(), ApplicationDialog.dispose()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Description copied from interface: PropertyChangePublisher

Register a listener to all properties of this publisher.

Specified by:

addPropertyChangeListener in interface PropertyChangePublisher

Parameters:

listener - the PropertyChangeListener to register.

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

Description copied from interface: PropertyChangePublisher

Register a listener to a specific property.

Specified by:

addPropertyChangeListener in interface PropertyChangePublisher

Parameters:

propertyName - the property to monitor.

listener - the PropertyChangeListener to register.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Description copied from interface: PropertyChangePublisher

Remove the listener from all properties of this publisher.

Specified by:

removePropertyChangeListener in interface PropertyChangePublisher

Parameters:

listener - the PropertyChangeListener to remove.

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)

Description copied from interface: PropertyChangePublisher

Remove the listener from a specific property.

Specified by:

removePropertyChangeListener in interface PropertyChangePublisher

Parameters:

propertyName - the property that was being monitored.

listener - the PropertyChangeListener to remove.