org.springframework.richclient.dialog
Class TitlePane

java.lang.Object
  org.springframework.richclient.application.support.ApplicationServicesAccessor
      org.springframework.richclient.factory.AbstractControlFactory
          org.springframework.richclient.dialog.TitlePane

All Implemented Interfaces:

PropertyChangePublisher, TitleConfigurable, Messagable, MessagePane, ControlFactory, ImageConfigurable

public class TitlePane
extends AbstractControlFactory
implements MessagePane, TitleConfigurable, ImageConfigurable

A container class that that has a title area for displaying a title and an image as well as a common area for displaying a description, a message, or an error message.

Field Summary

static String

DEFAULT_TITLE_IMAGE Image source key for banner image (value dialog_title_banner).

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

logger

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

MESSAGE_PROPERTY

Constructor Summary

TitlePane()

TitlePane(int linesToDisplay)

Method Summary

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	createControl() Subclasses must override this method to create a new instance of the control that this factory produces.
Image	getImage()
Message	getMessage()
String	getTitle()
boolean	isMessageShowing() Is this pane currently showing a message?
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	setImage(Image image)
void	setMessage(Message newMessage) Set the message.
void	setTitle(String newTitle) Sets the title.

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.factory.ControlFactory

getControl

Field Detail

DEFAULT_TITLE_IMAGE

public static final String DEFAULT_TITLE_IMAGE

Image source key for banner image (value dialog_title_banner).

See Also:

Constant Field Values

Constructor Detail

TitlePane

public TitlePane()

TitlePane

public TitlePane(int linesToDisplay)

Method Detail

setTitle

public void setTitle(String newTitle)

Description copied from interface: TitleConfigurable

Sets the title.

Specified by:

setTitle in interface TitleConfigurable

Parameters:

newTitle - the title

setImage

public void setImage(Image image)

Specified by:

setImage in interface ImageConfigurable

createControl

protected JComponent createControl()

Description copied from class: AbstractControlFactory

Subclasses must override this method to create a new instance of the control that this factory produces.

Specified by:

createControl in class AbstractControlFactory

Returns:

The newly created control, never null.

isMessageShowing

public boolean isMessageShowing()

Description copied from interface: MessagePane

Is this pane currently showing a message?

Specified by:

isMessageShowing in interface MessagePane

Returns:

true or false

getMessage

public Message getMessage()

Specified by:

getMessage in interface MessagePane

setMessage

public void setMessage(Message newMessage)

Description copied from interface: Messagable

Set the message.

Specified by:

setMessage in interface Messagable

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.

getTitle

public String getTitle()

getImage

public Image getImage()