org.springframework.binding.form
Interface FieldFace

All Superinterfaces:

DescribedElement, VisualizedElement

All Known Implementing Classes:

DefaultFieldFace

public interface FieldFace
extends DescribedElement, VisualizedElement

Provides metadata related to the visualization of a form property and convenience methods for configuring GUI components using the metadata.

Author:

Oliver Hutchison

Field Summary

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

CAPTION_PROPERTY, DESCRIPTION_PROPERTY, DISPLAY_NAME_PROPERTY

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.
LabelInfo	getLabelInfo() The text, mnemonic and mnemonicIndex for any labels created for the property.

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

getImage

Method Detail

getDisplayName

String getDisplayName()

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

Specified by:

getDisplayName in interface DescribedElement

Returns:

The display name, or null.

getCaption

String getCaption()

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

Specified by:

getCaption in interface DescribedElement

Returns:

The caption, or null.

getDescription

String getDescription()

A longer caption describing the property.

Specified by:

getDescription in interface DescribedElement

Returns:

The description, or null.

getLabelInfo

LabelInfo getLabelInfo()

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

getIcon

Icon getIcon()

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

Specified by:

getIcon in interface VisualizedElement

configure

void configure(JLabel label)

Configures the supplied JLabel using LabelInfo and Icon.

configure

void configure(AbstractButton button)

Configures the supplied button using LabelInfo and Icon.