net.sf.mmm.client.ui.api.attribute

Interface AttributeReadCaption

All Known Subinterfaces:

AttributeWriteCaption

All Known Implementing Classes:

TableWidget

public interface AttributeReadCaption

This interface gives read access to the caption attribute of an object.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static TypedProperty<String>	PROPERTY_CAPTION TypedProperty for getCaption().

Method Summary

Modifier and Type	Method and Description
String	getCaption() This method gets the caption of this object.

Field Detail

PROPERTY_CAPTION

static final TypedProperty<String> PROPERTY_CAPTION

TypedProperty for getCaption().

Method Detail

getCaption

String getCaption()

This method gets the caption of this object. A caption is similar to a title. In our APIs we prefer to use the title but in specific contexts we use caption for technical reasons - e.g. if the term is predefined by technology such as HTML.

Returns:

the caption text. Will be the empty string if no label has been set.