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

Interface AttributeReadPlaceholder

All Known Subinterfaces:

AttributeWritePlaceholder

public interface AttributeReadPlaceholder

This interface gives read access to the placeholder 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	getPlaceholder() This method gets the placeholder of this object.

Method Detail

getPlaceholder

String getPlaceholder()

This method gets the placeholder of this object. The placeholder is a text displayed as a hint in the object if its value is blank. The placeholder text is typically displayed in gray to distinguish from actual user-input. Typical examples are "Enter your name", or "Search...". The placeholder is a similar concept as the tooltip.

Returns:

the placeholder or the empty string if NOT defined.