Class InspectorFormLayoutSection

The InspectorFormLayoutSection represents the registration of a InspectorFieldBase with an InspectorFieldContainer.

The class enables the field to create child registrations, that can be enabled/disabled by toggling the parent field. One example use-case is the InlineObjectInspectorField. The InlineObjectInspectorField creates a nested inspector that uses the parent layout to register new fields.

Constructors

Accessors

  • get rowCount(): number
  • Number of child rows in the inspectable layout. Each row contains a single element that was added with a call to addRow.

    Returns number

    The total number of elements in the formLayout is likely different.

  • get rowIndices(): number[]
  • The row indices registered for the field inside the UIFormLayout.

    Returns number[]

Methods

  • Creates a new UIHorizontalLayout and adds it to the field layout.

    Parameters

    • Optionaltooltip: string

      A tooltip to be shown along the main control.

    Returns UIHorizontalLayout

    Newly created layout.

  • Adds a row to the field layout.

    Parameters

    • __namedParameters: {
          element: UIElementBase;
          index?: number;
          label?: UIContent;
          leftAccessory?: UIElementBase;
          rightAccessory?: UIElementBase;
          tooltip?: string;
      }
      • element: UIElementBase

        UI element to insert into the layout.

      • Optionalindex?: number

        The optional row index to insert the layout. If not specified, will append the row.

      • Optionallabel?: UIContent

        Content to be displayed on the label.

      • OptionalleftAccessory?: UIElementBase

        The accessory element to offer additional control for the row.

      • OptionalrightAccessory?: UIElementBase

        The accessory element to offer additional control for the row.

      • Optionaltooltip?: string

        A tooltip to be shown along the main control.

    Returns number

  • Creates a new UIVerticalLayout and adds it to the field layout.

    Parameters

    • Optionaltooltip: string

      A tooltip to be shown along the main control.

    Returns UIVerticalLayout

    Newly created layout.

  • Destroys all UI elements contained in the field layout. Leaves other elements present in UI layout intact.

    Returns void

  • Activates or deactivates the underlying UI elements.

    Parameters

    • isActive: boolean

    Returns void

  • Disables or enables the underlying UI elements. Disabled elements cannot be interacted with and have a faded out appearance.

    Parameters

    • isDisabled: boolean

    Returns void

  • Set read only the underlying UI elements.

    Parameters

    • isReadOnly: boolean

    Returns void