Package com.smartgwt.client.widgets.grid

# Interface HeaderHoverFormatter

public interface HeaderHoverFormatter
Formatter object for providing a custom implementation of `ListGrid.headerHoverHTML(int,java.lang.String)`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getHoverHTML(int fieldNum, String defaultHTML)`
  Returns the HTML that is displayed by default if a registered `HeaderHoverHandler` does not cancel a `HeaderHoverEvent`.

- ## Method Details

  - ### getHoverHTML

    String getHoverHTML(int fieldNum, String defaultHTML)
    Returns the HTML that is displayed by default if a registered `HeaderHoverHandler` does not cancel a `HeaderHoverEvent`. Return null or an empty string to cancel the hover.
    Parameters:
      `fieldNum` - field number for the header that was hovered
      `defaultHTML` - the HTML that would have been displayed by default.
    Returns:
      HTML to be displayed in the hover. If null or an empty string, then the hover is canceled.