Class MultiSheetExportSettings

Method Details

• getOrCreateRef

  public static MultiSheetExportSettings getOrCreateRef(JavaScriptObject jsObj)

• setCallback

  public MultiSheetExportSettings setCallback(String callback)

  Fired once the export request has been submitted. The workbook downloads through the browser's file transport, which reports nothing back to the page, so this callback does not indicate the download has completed — only that it was initiated.

  Parameters:

  callback - New callback value. Default value is null

  Returns:

  MultiSheetExportSettings instance, for chaining setter calls

  See Also:

  • Callback
  • Descendant Data Export

• getCallback

  public String getCallback()

  Fired once the export request has been submitted. The workbook downloads through the browser's file transport, which reports nothing back to the page, so this callback does not indicate the download has completed — only that it was initiated.

  Returns:

  Current callback value. Default value is null

  See Also:

  • Callback
  • Descendant Data Export

• setExportFilename

  public MultiSheetExportSettings setExportFilename(String exportFilename)

  Base name for the downloaded file (the .xlsx extension is appended). When unset, a filesystem-safe name is derived from title.

  Parameters:

  exportFilename - New exportFilename value. Default value is null

  Returns:

  MultiSheetExportSettings instance, for chaining setter calls

  See Also:

  • Descendant Data Export

• getExportFilename

  public String getExportFilename()

  Base name for the downloaded file (the .xlsx extension is appended). When unset, a filesystem-safe name is derived from title.

  Returns:

  Current exportFilename value. Default value is null

  See Also:

  • Descendant Data Export

• setIncludeHidden

  public MultiSheetExportSettings setIncludeHidden(Boolean includeHidden)

  By default only visible components are exported — the export captures the view the user is looking at. Set this to export hidden eligible components as well.

  Parameters:

  includeHidden - New includeHidden value. Default value is null

  Returns:

  MultiSheetExportSettings instance, for chaining setter calls

  See Also:

  • Descendant Data Export

• getIncludeHidden

  public Boolean getIncludeHidden()

  By default only visible components are exported — the export captures the view the user is looking at. Set this to export hidden eligible components as well.

  Returns:

  Current includeHidden value. Default value is null

  See Also:

  • Descendant Data Export

• setLabels

  public MultiSheetExportSettings setLabels(Map labels)

  Per-call overrides for the cover and caption label strings. Property names and defaults come from the corresponding canvas attributes — Canvas.filtersAppliedTitle, Canvas.filterConditionTitle, Canvas.filterAppliesToTitle, Canvas.allSheetsMessage, Canvas.noFiltersAppliedMessage, Canvas.asDisplayedMessage and Canvas.asDisplayedPartialMessage; set those attributes instead to change the wording for every export.

  Parameters:

  labels - New labels value. Default value is null

  Returns:

  MultiSheetExportSettings instance, for chaining setter calls

  See Also:

  • Descendant Data Export

• getLabels

  public Map getLabels()

  Per-call overrides for the cover and caption label strings. Property names and defaults come from the corresponding canvas attributes — Canvas.filtersAppliedTitle, Canvas.filterConditionTitle, Canvas.filterAppliesToTitle, Canvas.allSheetsMessage, Canvas.noFiltersAppliedMessage, Canvas.asDisplayedMessage and Canvas.asDisplayedPartialMessage; set those attributes instead to change the wording for every export.

  Returns:

  Current labels value. Default value is null

  See Also:

  • Descendant Data Export

• setMaxExportRows

  public MultiSheetExportSettings setMaxExportRows(Integer maxExportRows)

  Maximum rows a client-executed fetch may export. When a component's fetch would exceed it, the export is refused with Canvas.exportRowLimitMessage before any download begins. Fetches executed by the Smart GWT Server are bounded by the server's own configured limit instead.

  Parameters:

  maxExportRows - New maxExportRows value. Default value is null

  Returns:

  MultiSheetExportSettings instance, for chaining setter calls

  See Also:

  • Descendant Data Export

• getMaxExportRows

  public Integer getMaxExportRows()

  Maximum rows a client-executed fetch may export. When a component's fetch would exceed it, the export is refused with Canvas.exportRowLimitMessage before any download begins. Fetches executed by the Smart GWT Server are bounded by the server's own configured limit instead.

  Returns:

  Current maxExportRows value. Default value is null

  See Also:

  • Descendant Data Export

• setTitle

  public MultiSheetExportSettings setTitle(String title)

  Title shown on the workbook's cover sheet. When unset, falls back to Canvas.exportDefaultTitle.

  Parameters:

  title - New title value. Default value is null

  Returns:

  MultiSheetExportSettings instance, for chaining setter calls

  See Also:

  • Descendant Data Export

• getTitle

  public String getTitle()

  Title shown on the workbook's cover sheet. When unset, falls back to Canvas.exportDefaultTitle.

  Returns:

  Current title value. Default value is null

  See Also:

  • Descendant Data Export