Class RowBuilderWidgetRenderer.Builder

java.lang.Object
com.kingsrook.qqq.backend.core.model.metadata.dashboard.AbstractWidgetMetaDataBuilder
com.kingsrook.qqq.backend.core.actions.dashboard.widgets.RowBuilderWidgetRenderer.Builder
Enclosing class:
RowBuilderWidgetRenderer
public static class RowBuilderWidgetRenderer.Builder extends AbstractWidgetMetaDataBuilder
Widget Meta Data Builder for this widget type.

  • Constructor Details

  • Method Details

    • withName

      public RowBuilderWidgetRenderer.Builder withName(String name)
      set name for the widget, though generally would

    • withLabel

      public RowBuilderWidgetRenderer.Builder withLabel(String label)
      set the label shown in UI for the widget

    • withFields

      public RowBuilderWidgetRenderer.Builder withFields(List<QFieldMetaData> fields)
      set the fields for the widget

    • withUseModalEditor

      public RowBuilderWidgetRenderer.Builder withUseModalEditor(Boolean useModalEditor)
      set whether edits happen inline, or in modal editor.

    • withIsEditable

      public RowBuilderWidgetRenderer.Builder withIsEditable(Boolean isEditable)
      set if the data is editable or not. note that, if isForRecordViewAndEditScreen, this is ignored, as its whether you're on the view or edit screen that determines isEditable.

    • withMayReorderRows

      public RowBuilderWidgetRenderer.Builder withMayReorderRows(Boolean mayReorderRows)
      set if user can reorder rows. if set, then orderByFieldName must also be set.

    • withOrderByFieldName

      public RowBuilderWidgetRenderer.Builder withOrderByFieldName(String orderByFieldName)
      set the field in which the sequence/order-by value is stored. only applies if mayReorderRows is true.

    • withIsForRecordViewAndEditScreen

      public RowBuilderWidgetRenderer.Builder withIsForRecordViewAndEditScreen(Boolean isForRecordViewAndEditScreen)
      set if the widget it meant for use on record view/edit screens, in which case, that determines if editable or not.

    • withOutputFieldName

      public RowBuilderWidgetRenderer.Builder withOutputFieldName(String outputFieldName)
      set the fieldName that the records are written to when data comes out of the widget, e.g., into process values, or a parent-record.

    • withAssociationName

      public RowBuilderWidgetRenderer.Builder withAssociationName(String associationName)
      for the use-case on a record view/edit screen, set the association name that the records are for.

    • withParentTableName

      public RowBuilderWidgetRenderer.Builder withParentTableName(String parentTableName)
      for the use-case on a record view/edit screen, set the name of the "parent" table - e.g., the one that has the association.

    • withDefaultValuesForNewRowsFromParentRecord

      public RowBuilderWidgetRenderer.Builder withDefaultValuesForNewRowsFromParentRecord(Map<String,Serializable> defaultValuesForNewRowsFromParentRecord)
      for the use-case on a record view/edit screen, set the name of the "parent" table - e.g., the one that has the association.
      Parameters:
      defaultValuesForNewRowsFromParentRecord - map with keys of 'fromFieldName' (e.g., a field name in the parent record) →