com.jivesoftware.community.widget
Interface ValidatableWidget

public interface ValidatableWidget

Represents a widget's ability to validate values set for its design-time properties. Implement this interface to display a message when user-set property values are invalid.

Method Summary

String

validateWidget() Called by Clearspace to retrieve a message for the user when property values are invalid; returns null if values are valid.

Method Detail

validateWidget

String validateWidget()

Called by Clearspace to retrieve a message for the user when property values are invalid; returns null if values are valid. This method's implementation should check widget property values set by the user. If values are valid, return null. If any of the values checked are invalid, return a message that lists which values are invalid and why (or what could be done to correct them).

Returns:

A message with information about each of the invalid property values; null if all checked values are valid.