org.springframework.richclient.widget
Class AbstractTitledWidget

Show UML class diagram

java.lang.Object
  org.springframework.richclient.application.support.ApplicationServicesAccessor
      org.springframework.richclient.widget.AbstractWidget
          org.springframework.richclient.widget.AbstractTitledWidget

All Implemented Interfaces:

BeanNameAware, PropertyChangePublisher, DescriptionConfigurable, Guarded, TitleConfigurable, Messagable, ImageConfigurable, TitledWidget, Widget

Direct Known Subclasses:

AbstractDataEditorWidget, TitledWidgetForm

public abstract class AbstractTitledWidget
extends AbstractWidget
implements TitledWidget

Field Summary

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

showing

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

AbstractTitledWidget()

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.
abstract JComponent	createWidgetContent()
JComponent	getComponent() Lazy creation of component
protected Message	getDescription()
String	getId()
boolean	isEnabled() Indicates if the object is in an enabled state.
ValidationResultsReporter	newSingleLineResultsReporter(Messagable messagable)
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 beanName)
void	setCaption(String shortDescription)
void	setDescription(String longDescription)
void	setEnabled(boolean enabled) Sets the enabled state of the object.
void	setId(String id)
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.AbstractWidget

canClose, getCommands, isShowing, onAboutToHide, onAboutToShow

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

canClose, getCommands, isShowing, onAboutToHide, onAboutToShow

Constructor Detail

AbstractTitledWidget

public AbstractTitledWidget()

Method Detail

setId

public void setId(String id)

getId

public String getId()

Specified by:

getId in interface TitledWidget

setBeanName

public void setBeanName(String beanName)

Specified by:

setBeanName in interface BeanNameAware

isEnabled

public boolean isEnabled()

Description copied from interface: Guarded

Indicates if the object is in an enabled state.

Specified by:

isEnabled in interface Guarded

Returns:

if the object is in an enabled state, otherwise.

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: Guarded

Sets the enabled state of the object.

Specified by:

setEnabled in interface Guarded

Parameters:

enabled - true to enable the object, false to disable it.

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

newSingleLineResultsReporter

public ValidationResultsReporter newSingleLineResultsReporter(Messagable messagable)

Specified by:

newSingleLineResultsReporter in interface TitledWidget

getDescription

protected Message getDescription()

setDescription

public void setDescription(String longDescription)

Specified by:

setDescription in interface DescriptionConfigurable

setCaption

public void setCaption(String shortDescription)

Specified by:

setCaption in interface DescriptionConfigurable

getComponent

public final JComponent getComponent()

Lazy creation of component

Specified by:

getComponent in interface Widget

Returns:

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

createWidgetContent

public abstract JComponent createWidgetContent()

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.