org.springframework.binding.form.support
Class DefaultFieldFace

java.lang.Object
  org.springframework.binding.value.support.AbstractPropertyChangePublisher
      org.springframework.binding.form.support.DefaultFieldFace

All Implemented Interfaces:

FieldFace, PropertyChangePublisher, DescribedElement, VisualizedElement

public class DefaultFieldFace
extends AbstractPropertyChangePublisher
implements FieldFace

A default implementation of FieldFace

Author:

Oliver Hutchison

Field Summary

Fields inherited from class org.springframework.binding.value.support.AbstractPropertyChangePublisher

logger

Fields inherited from interface org.springframework.richclient.core.DescribedElement

CAPTION_PROPERTY, DESCRIPTION_PROPERTY, DISPLAY_NAME_PROPERTY

Constructor Summary

DefaultFieldFace(String displayName, String caption, String description, LabelInfo labelInfo, Icon icon)

DefaultFieldFace(String displayName, String caption, String description, String encodedLabel, Icon icon)
Constructs a new DefaultFieldFace with the provided values.

Method Summary

void	configure(AbstractButton button) Configures the supplied button using LabelInfo and Icon.
void	configure(JLabel label) Configures the supplied JLabel using LabelInfo and Icon.
String	getCaption() A short caption describing the property, typically used for tool tips.
String	getDescription() A longer caption describing the property.
String	getDisplayName() The name of the property in human readable form, typically used for validation messages.
Icon	getIcon() The icon that is used for any labels created for this property.
Image	getImage() Returns the image associated with the application component, or null.
LabelInfo	getLabelInfo() The text, mnemonic and mnemonicIndex for any labels created for the property.

Methods inherited from class org.springframework.binding.value.support.AbstractPropertyChangePublisher

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, firePropertiesChanged, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getPropertyChangeListeners, getPropertyChangeListeners, getVetoableChangeListeners, getVetoableChangeListeners, hasChanged, hasChanged, hasChanged, hasChanged, hasChanged, hasChanged, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultFieldFace

public DefaultFieldFace(String displayName,
                        String caption,
                        String description,
                        String encodedLabel,
                        Icon icon)

Constructs a new DefaultFieldFace with the provided values.

DefaultFieldFace

public DefaultFieldFace(String displayName,
                        String caption,
                        String description,
                        LabelInfo labelInfo,
                        Icon icon)

Method Detail

getDisplayName

public String getDisplayName()

Description copied from interface: FieldFace

The name of the property in human readable form, typically used for validation messages.

Specified by:

getDisplayName in interface FieldFace

Specified by:

getDisplayName in interface DescribedElement

Returns:

The display name, or null.

getCaption

public String getCaption()

Description copied from interface: FieldFace

A short caption describing the property, typically used for tool tips.

Specified by:

getCaption in interface FieldFace

Specified by:

getCaption in interface DescribedElement

Returns:

The caption, or null.

getDescription

public String getDescription()

Description copied from interface: FieldFace

A longer caption describing the property.

Specified by:

getDescription in interface FieldFace

Specified by:

getDescription in interface DescribedElement

Returns:

The description, or null.

getLabelInfo

public LabelInfo getLabelInfo()

Description copied from interface: FieldFace

The text, mnemonic and mnemonicIndex for any labels created for the property.

Specified by:

getLabelInfo in interface FieldFace

getImage

public Image getImage()

Description copied from interface: VisualizedElement

Returns the image associated with the application component, or null.

Specified by:

getImage in interface VisualizedElement

getIcon

public Icon getIcon()

Description copied from interface: FieldFace

The icon that is used for any labels created for this property.

Specified by:

getIcon in interface FieldFace

Specified by:

getIcon in interface VisualizedElement

configure

public void configure(JLabel label)

Description copied from interface: FieldFace

Configures the supplied JLabel using LabelInfo and Icon.

Specified by:

configure in interface FieldFace

configure

public void configure(AbstractButton button)

Description copied from interface: FieldFace

Configures the supplied button using LabelInfo and Icon.

Specified by:

configure in interface FieldFace