Class ShowGridOptionsBuilder<T,​B extends ShowGridOptionsBuilder<T,​B>>

java.lang.Object
com.tick42.glue.internal.excel.TableBuilderBase<T,​B>
com.tick42.glue.internal.excel.ShowGridOptionsBuilder<T,​B>
All Implemented Interfaces:
ColumnsBuilder<B>, RowsBuilder<T,​B>, SheetOptions.Builder<T,​B>, TableBuilder<T,​B>

public class ShowGridOptionsBuilder<T,​B extends ShowGridOptionsBuilder<T,​B>>
extends TableBuilderBase<T,​B>
implements SheetOptions.Builder<T,​B>, TableBuilder<T,​B>
  • Field Details

  • Method Details

    • worksheet

      public B worksheet​(String worksheet)
      Specified by:
      worksheet in interface SheetOptions.Builder<T,​B extends ShowGridOptionsBuilder<T,​B>>
      Parameters:
      worksheet - Name of the sheet to receive the data; else uses the first sheet in the workbook.
      Returns:
      this builder, never null
    • workbook

      public B workbook​(String name)
      Specified by:
      workbook in interface SheetOptions.Builder<T,​B extends ShowGridOptionsBuilder<T,​B>>
      Parameters:
      name - Name of the workbook to reuse; otherwise a new temporary workbook will be created.
      Returns:
      this builder, never null
    • templateWorksheet

      public B templateWorksheet​(String name)
      Specified by:
      templateWorksheet in interface SheetOptions.Builder<T,​B extends ShowGridOptionsBuilder<T,​B>>
      Parameters:
      name - Name of the worksheet to display; ignored if there is no template.
      Returns:
      this builder, never null
    • templateWorkbook

      public B templateWorkbook​(String name)
      Specified by:
      templateWorkbook in interface SheetOptions.Builder<T,​B extends ShowGridOptionsBuilder<T,​B>>
      Parameters:
      name - Name of a template workbook to use when creating new workbooks.
      Returns:
      this builder, never null
    • inhibitLocalSave

      public B inhibitLocalSave​(boolean flag)
      Parameters:
      flag - Set to true to prevent the user from saving the temporary workbook.
      Returns:
      this builder, never null
    • clearGrid

      public B clearGrid​(boolean flag)
      Parameters:
      flag - Remove all existing rows before applying the new data; default true.
      Returns:
      this builder, never null
    • buttonRange

      public B buttonRange​(String buttonRange)
      Parameters:
      buttonRange - The trigger button is placed over a range of cells; default is A1.
      Returns:
      this builder, never null
    • topLeft

      public B topLeft​(String position)
      Parameters:
      position - The top-left address of the data in the dataWorksheet; default is A1.
      Returns:
      this builder, never null
    • buttonText

      public B buttonText​(String buttonText)
      Parameters:
      buttonText - The caption to use for a trigger button.
      Returns:
      this builder, never null
    • namedRange

      public B namedRange​(String namedRange)
      Parameters:
      namedRange - The top-left address of the data in the dataWorksheet; default is A1.
      Returns:
      this builder, never null
    • dataRangeName

      public B dataRangeName​(String dataRangeName)
      ExcelPad will create an Excel Named Range that defines the extent of the data written to the worksheet.
      Parameters:
      dataRangeName - the range name
      Returns:
      this builder, never null
    • window

      public B window​(WindowState window)
      Excel window activation/state options
      Parameters:
      window - the desired options
      Returns:
      this builder, never null
    • g4oVersion

      public B g4oVersion​(String version)
      Input custom g4oVersion
      Parameters:
      version - the desired version
      Returns:
      this builder, never null