org.springframework.richclient.core
Interface DescribedElement

All Known Subinterfaces:

ApplicationDescriptor, Editor, FieldFace, PageComponent, PageComponentDescriptor, PageDescriptor, TreeObject, View, ViewDescriptor

All Known Implementing Classes:

AbstractDialogPage, AbstractPageDescriptor, AbstractView, AbstractWizardPage, CommandFaceDescriptor, CompositeDialogPage, ContactView, DefaultApplicationDescriptor, DefaultFieldFace, DefaultViewDescriptor, DesktopPageDescriptor, DesktopViewDescriptor, ExceptionHandlingView, FlexDockViewDescriptor, FormBackedDialogPage, FormBackedPreferencePage, FormBackedWizardPage, InitialView, InitialView, LabeledObjectSupport, LookupViewDescriptor, MultiViewPageDescriptor, OwnerManagerView, PreferencePage, ScriptedView, SetupIntroWizardPage, SetupLicenseWizardPage, SingleViewPageDescriptor, TabbedDialogPage, TreeCompositeDialogPage, VetManagerView, VLDockingPageDescriptor, VLDockingViewDescriptor

public interface DescribedElement

An application component, usually a visible GUI component, that can provide information describing itself.

Author:

Keith Donald

Field Summary

static String	CAPTION_PROPERTY The property name used when firing events for the caption property.
static String	DESCRIPTION_PROPERTY The property name used when firing events for the description property.
static String	DISPLAY_NAME_PROPERTY The property name used when firing events for the displayName property.

Method Summary

String	getCaption() Returns the caption for this object.
String	getDescription() Returns a description of this object.
String	getDisplayName() Returns the display name of this object.

Field Detail

DISPLAY_NAME_PROPERTY

static final String DISPLAY_NAME_PROPERTY

The property name used when firing events for the displayName property.

See Also:

Constant Field Values

CAPTION_PROPERTY

static final String CAPTION_PROPERTY

The property name used when firing events for the caption property.

See Also:

Constant Field Values

DESCRIPTION_PROPERTY

static final String DESCRIPTION_PROPERTY

The property name used when firing events for the description property.

See Also:

Constant Field Values

Method Detail

getDisplayName

String getDisplayName()

Returns the display name of this object.

Returns:

The display name, or null.

getCaption

String getCaption()

Returns the caption for this object.

Returns:

The caption, or null.

getDescription

String getDescription()

Returns a description of this object.

Returns:

The description, or null.