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

Interface AttributeReadHelpText

All Known Subinterfaces:

AttributeWriteHelpText

public interface AttributeReadHelpText

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

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
String	getHelpText() This method gets the help text of this object.

Method Detail

getHelpText

String getHelpText()

This method gets the help text of this object. This text is used to provide dynamic online-help information about this object. This is an optional attribute. If no help text is provided, it falls back to the tooltip.

Returns:

the help text or null if NOT set.