Package com.smartgwt.client.widgets.com.smartgwt.client.widgets.events

# Interface HasPreviewShownHandlers

All Superinterfaces:
  `HasHandlers`

All Known Implementing Classes:
  `BatchUploader`, `BatchUploader`, `BatchUploader`

public interface HasPreviewShownHandlers extends HasHandlers

- ## Method Summary

  Modifier and Type
  Method
  Description
  `HandlerRegistration`
  `addPreviewShownHandler(PreviewShownHandler handler)`
  Notification method fired when the `grid` is populated with a new set of data for the user to preview before commit.

  ### Methods inherited from interface com.google.gwt.event.shared.HasHandlers

  `fireEvent`

- ## Method Details

  - ### addPreviewShownHandler

    HandlerRegistration addPreviewShownHandler(PreviewShownHandler handler)
    Notification method fired when the `grid` is populated with a new set of data for the user to preview before commit.

    This notification occurs after the user has uploaded a new data file, the data has been processed on the server, and the preview grid populated with the data ready for committing. Developers may use this notification to examine or modify the data set to be uploaded. The `ListGrid.data` object will be populated with the array of uploaded records, and standard grid APIs such as `ListGrid.getRowErrors()`, `ListGrid.setEditValue()`, etc may be used to interact with this data.

    Note that developers wishing to manipulate the uploaded data can also do this on the server side when user hits the commit button to submit the data to the `uploadDataSource`. This can be achieved by setting the `uploadOperation` to call a custom `"add" type operation` on the target dataSource.

    Parameters:
      `handler` - the previewShown handler
    Returns:
      `HandlerRegistration` used to remove this handler