org.springframework.richclient.widget
Class AbstractTitledWidgetForm

Show UML class diagram

java.lang.Object
  org.springframework.richclient.application.support.ApplicationServicesAccessor
      org.springframework.richclient.factory.AbstractControlFactory
          org.springframework.richclient.form.AbstractForm
              org.springframework.richclient.widget.AbstractWidgetForm
                  org.springframework.richclient.widget.AbstractTitledWidgetForm

All Implemented Interfaces:

BeanNameAware, CommitListener, PropertyChangePublisher, DescriptionConfigurable, Guarded, TitleConfigurable, Messagable, ControlFactory, Form, ImageConfigurable, TitledWidget, Widget

public abstract class AbstractTitledWidgetForm
extends AbstractWidgetForm
implements TitledWidget

Field Summary

Fields inherited from class org.springframework.richclient.widget.AbstractWidgetForm

SAVE_CMD_ID, showing, UNDO_CMD_ID

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

logger

Fields inherited from interface org.springframework.richclient.widget.Widget

EMPTY_WIDGET

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

MESSAGE_PROPERTY

Constructor Summary

AbstractTitledWidgetForm(FormModel model)

AbstractTitledWidgetForm(FormModel model, String formId)

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener) Register a listener to all properties of this publisher.
void	addPropertyChangeListener(String txt, PropertyChangeListener listener) Register a listener to a specific property.
boolean	canClose() Checks whether this component can be closed visually, for example when there are no unsaved changes.
List<? extends AbstractCommand>	getCommands() Returns a list of commands for this widget.
JComponent	getComponent()
protected Message	getDescription()
void	onAboutToHide() Hook method called before moving the component to the background (=hiding)
void	onAboutToShow() Hook method called before showing the component on screen.
void	removePropertyChangeListener(PropertyChangeListener listener) Remove the listener from all properties of this publisher.
void	removePropertyChangeListener(String txt, PropertyChangeListener listener) Remove the listener from a specific property.
void	setBeanName(String name)
void	setCaption(String shortDescription)
void	setDescription(String longDescription)
void	setImage(Image image)
void	setMessage(Message message) Set the message.
void	setTitle(String title) Sets the title.

Methods inherited from class org.springframework.richclient.widget.AbstractWidgetForm

getCommitCommandFaceDescriptorId, getRevertCommandFaceDescriptorId, isShowing

Methods inherited from class org.springframework.richclient.form.AbstractForm

addChildForm, addFormObjectChangeListener, addFormValueChangeListener, addGuarded, addGuarded, addValidationListener, addValidationResultsReporter, attachFormErrorGuard, attachFormGuard, commit, constructSecurityControllerId, createCommitButton, createControl, createFormControl, createNewFormObjectButton, createNewObject, detachFormGuard, getBindingFactory, getChildForm, getCommitCommand, getCommitSecurityControllerId, getDefaultButton, getEditableFormObject, getEditingFormObjectIndex, getFormModel, getFormObject, getId, getNewFormObjectCommand, getNewFormObjectCommandId, getNewFormObjectSecurityControllerId, getParent, getRevertCommand, getValidationResultsReporters, getValue, getValueModel, handleEnabledChange, hasErrors, init, isDirty, isEditingNewFormObject, isEnabled, newSingleLineResultsReporter, postCommit, preCommit, removeChildForm, removeFormObjectChangeListener, removeFormValueChangeListener, removeGuarded, removeValidationListener, removeValidationResultsReporter, reset, revert, setClearFormOnCommit, setDefaultButton, setEditableFormObjects, setEditingFormObjectIndexHolder, setEditingFormObjectIndexSilently, setEditingNewFormObject, setEnabled, setFormModel, setFormModelDefaultEnabledState, setFormObject, setId

Methods inherited from class org.springframework.richclient.factory.AbstractControlFactory

createControlIfNecessary, getControl, isControlCreated, isSingleton, setSingleton

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

Methods inherited from interface org.springframework.richclient.widget.TitledWidget

getId, newSingleLineResultsReporter

Methods inherited from interface org.springframework.richclient.widget.Widget

isShowing

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

isEnabled, setEnabled

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

getControl

Constructor Detail

AbstractTitledWidgetForm

public AbstractTitledWidgetForm(FormModel model)

AbstractTitledWidgetForm

public AbstractTitledWidgetForm(FormModel model,
                                String formId)

Method Detail

setTitle

public void setTitle(String title)

Description copied from interface: TitleConfigurable

Sets the title.

Specified by:

setTitle in interface TitleConfigurable

Parameters:

title - the title

setImage

public void setImage(Image image)

Specified by:

setImage in interface ImageConfigurable

setMessage

public void setMessage(Message message)

Description copied from interface: Messagable

Set the message.

Specified by:

setMessage in interface Messagable

getDescription

protected Message getDescription()

setDescription

public void setDescription(String longDescription)

Specified by:

setDescription in interface DescriptionConfigurable

getComponent

public JComponent getComponent()

Specified by:

getComponent in interface Widget

Overrides:

getComponent in class AbstractWidgetForm

Returns:

A not null graphical component built using the parameters held in the widget instance.

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 txt,
                                      PropertyChangeListener listener)

Description copied from interface: PropertyChangePublisher

Register a listener to a specific property.

Specified by:

addPropertyChangeListener in interface PropertyChangePublisher

Parameters:

txt - 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 txt,
                                         PropertyChangeListener listener)

Description copied from interface: PropertyChangePublisher

Remove the listener from a specific property.

Specified by:

removePropertyChangeListener in interface PropertyChangePublisher

Parameters:

txt - the property that was being monitored.

listener - the PropertyChangeListener to remove.

canClose

public boolean canClose()

Description copied from interface: Widget

Checks whether this component can be closed visually, for example when there are no unsaved changes.

Specified by:

canClose in interface Widget

Overrides:

canClose in class AbstractWidgetForm

Returns:

true if the widget can be closed without problems.

getCommands

public List<? extends AbstractCommand> getCommands()

Description copied from interface: Widget

Returns a list of commands for this widget.

Specified by:

getCommands in interface Widget

Overrides:

getCommands in class AbstractWidgetForm

onAboutToHide

public void onAboutToHide()

Description copied from interface: Widget

Hook method called before moving the component to the background (=hiding)

Specified by:

onAboutToHide in interface Widget

Overrides:

onAboutToHide in class AbstractWidgetForm

onAboutToShow

public void onAboutToShow()

Description copied from interface: Widget

Hook method called before showing the component on screen.

Specified by:

onAboutToShow in interface Widget

Overrides:

onAboutToShow in class AbstractWidgetForm

setCaption

public void setCaption(String shortDescription)

Specified by:

setCaption in interface DescriptionConfigurable

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface BeanNameAware