Class UISummarySettings

All Implemented Interfaces:
HasHandlers

public class UISummarySettings extends DataClass
Settings that control how a widget UI Summary is built.
  • Constructor Details

    • UISummarySettings

      public UISummarySettings()
    • UISummarySettings

      public UISummarySettings(JavaScriptObject jsObj)
  • Method Details

    • getOrCreateRef

      public static UISummarySettings getOrCreateRef(JavaScriptObject jsObj)
    • setDataCharLimit

      public UISummarySettings setDataCharLimit(Integer dataCharLimit)
      Maximum characters of row data each grid reports in the summary. See Canvas.summaryDataCharLimit.

      Note : This is an advanced setting

      Parameters:
      dataCharLimit - New dataCharLimit value. Default value is null
      Returns:
      UISummarySettings instance, for chaining setter calls
    • getDataCharLimit

      public Integer getDataCharLimit()
      Maximum characters of row data each grid reports in the summary. See Canvas.summaryDataCharLimit.
      Returns:
      Current dataCharLimit value. Default value is null
    • setFocusComponent

      public UISummarySettings setFocusComponent(Canvas focusComponent)
      Canvas to target for enhanced details in the UI Summary.

      Note : This is an advanced setting

      Parameters:
      focusComponent - New focusComponent value. Default value is null
      Returns:
      UISummarySettings instance, for chaining setter calls
    • getFocusComponent

      public Canvas getFocusComponent()
      Canvas to target for enhanced details in the UI Summary.
      Returns:
      Current focusComponent value. Default value is null
    • setTrimRowData

      public UISummarySettings setTrimRowData(Boolean trimRowData)
      When true, grid row data in the summary reports only the values the user can see, plus the keys needed to identify and edit each row. See Canvas.trimSummaryRowData.

      Note : This is an advanced setting

      Parameters:
      trimRowData - New trimRowData value. Default value is null
      Returns:
      UISummarySettings instance, for chaining setter calls
    • getTrimRowData

      public Boolean getTrimRowData()
      When true, grid row data in the summary reports only the values the user can see, plus the keys needed to identify and edit each row. See Canvas.trimSummaryRowData.
      Returns:
      Current trimRowData value. Default value is null