Class GenericListBuilder<TList, ConcreteImpl>Abstract

constructor

• new GenericListBuilder<TList extends BuildableGenericList, ConcreteImpl>(): GenericListBuilder<
      TList,
      ConcreteImpl,
  >

  Type Parameters

  • TList extends BuildableGenericList
  • ConcreteImpl

  Returns GenericListBuilder<TList, ConcreteImpl>

Readonly[serializableMarker]

canHandleIntent

• canHandleIntent(canHandleIntent?: IntentChecker): ConcreteImpl

  Set generic list can handle intent

  Parameters

  • OptionalcanHandleIntent: IntentChecker

    generic list intent checker. See IntentChecker

  Returns ConcreteImpl

  generic list builder based on can handle intent provided.

child

• child(child: Child): ConcreteImpl

  Set generic list child

  Parameters

  • child: Child

    generic list child. See Child

  Returns ConcreteImpl

  generic list builder based on child provided (clone).

Abstractclone

• clone(_withSpec?: object): ConcreteImpl

  Clone generic list builder (allows for options overriding)

  Parameters

  • Optional_withSpec: object

    generic list options.

  Returns ConcreteImpl

  generic list builder.

currentMaxWidth

• currentMaxWidth(currentMaxWidth: number): ConcreteImpl

  Set the maximum width of the list pane before it is manually resized

  Parameters

  • currentMaxWidth: number

    Maximum width in pixels before manual resizing

  Returns ConcreteImpl

  generic list builder with the current maximum width applied

defaultLayout

• defaultLayout(defaultLayout: PreviewLayoutKey): ConcreteImpl

  Set generic list layout

  Parameters

  • defaultLayout: PreviewLayoutKey

    generic list layout key.

  Returns ConcreteImpl

  generic list builder based on layout provided.

getCanHandleIntent

• getCanHandleIntent(): TList["canHandleIntent"]

  Get generic list can handle intent

  Returns TList["canHandleIntent"]

  generic list can handle intent

getChild

• getChild(): TList["child"]

  Get generic list child

  Returns TList["child"]

  generic list child

getCurrentMaxWidth

• getCurrentMaxWidth(): TList["currentMaxWidth"]

  Get the maximum width of the list pane before it is manually resized

  Returns TList["currentMaxWidth"]

  current maximum width in pixels

getDefaultLayout

• getDefaultLayout(): TList["defaultLayout"]

  Get generic list layout

  Returns TList["defaultLayout"]

  generic list layout

getI18n

• getI18n(): TList["i18n"]

  Get i18n key and namespace used to populate the localized title

  Returns TList["i18n"]

  the i18n key and namespace used to populate the localized title

getId

• getId(): TList["id"]

  Get generic list ID

  Returns TList["id"]

  generic list ID

getInitialValueTemplates

• getInitialValueTemplates(): TList["initialValueTemplates"]

  Get generic list initial value templates

  Returns TList["initialValueTemplates"]

  generic list initial value templates

getMaxWidth

• getMaxWidth(): TList["maxWidth"]

  Get the maximum width of the list pane

  Returns TList["maxWidth"]

  maximum width in pixels

getMenuItemGroups

• getMenuItemGroups(): TList["menuItemGroups"]

  Get generic list menu item groups

  Returns TList["menuItemGroups"]

  generic list menu item groups

getMenuItems

• getMenuItems(): TList["menuItems"]

  Get generic list menu items

  Returns TList["menuItems"]

  generic list menu items

getMinWidth

• getMinWidth(): TList["minWidth"]

  Get the minimum width of the list pane

  Returns TList["minWidth"]

  minimum width in pixels

getShowIcons

• getShowIcons(): boolean

  Get generic list display options

  Returns boolean

  generic list display options (specifically showIcons)

getTitle

• getTitle(): TList["title"]

  Get generic list title

  Returns TList["title"]

  generic list title

i18n

• i18n(i18n: I18nTextRecord<"title">): ConcreteImpl

  Set the i18n key and namespace used to populate the localized title.

  Parameters

  • i18n: I18nTextRecord<"title">

    the key and namespaced used to populate the localized title.

  Returns ConcreteImpl

  component builder based on i18n key and ns provided

id

• id(id: string): ConcreteImpl

  Set generic list ID

  Parameters

  • id: string

    generic list ID

  Returns ConcreteImpl

  generic list builder based on ID provided.

initialValueTemplates

• initialValueTemplates(
      templates:
          | InitialValueTemplateItem
          | InitialValueTemplateItemBuilder
          | (InitialValueTemplateItem | InitialValueTemplateItemBuilder)[],
  ): ConcreteImpl

  Set generic list initial value templates

  Parameters

  • templates:
        | InitialValueTemplateItem
        | InitialValueTemplateItemBuilder
        | (InitialValueTemplateItem | InitialValueTemplateItemBuilder)[]

    generic list initial value templates. See InitialValueTemplateItemBuilder

  Returns ConcreteImpl

  generic list builder based on templates provided.

maxWidth

• maxWidth(maxWidth: number): ConcreteImpl

  Set the maximum width of the list pane

  Parameters

  • maxWidth: number

    Maximum width in pixels

  Returns ConcreteImpl

  generic list builder with the maximum width applied

menuItemGroups

• menuItemGroups(
      menuItemGroups: (MenuItemGroup | MenuItemGroupBuilder)[],
  ): ConcreteImpl

  Set generic list menu item groups

  Parameters

  • menuItemGroups: (MenuItemGroup | MenuItemGroupBuilder)[]

    generic list menu item groups. See MenuItemGroup and MenuItemGroupBuilder

  Returns ConcreteImpl

  generic list builder based on menu item groups provided.

menuItems

• menuItems(menuItems: (MenuItem | MenuItemBuilder)[]): ConcreteImpl

  Set generic list menu items

  Parameters

  • menuItems: (MenuItem | MenuItemBuilder)[]

    generic list menu items. See MenuItem and MenuItemBuilder

  Returns ConcreteImpl

  generic list builder based on menu items provided.

minWidth

• minWidth(minWidth: number): ConcreteImpl

  Set the minimum width of the list pane

  Parameters

  • minWidth: number

    Minimum width in pixels

  Returns ConcreteImpl

  generic list builder with the minimum width applied

serialize

• serialize(options?: SerializeOptions): GenericList

  Serialize generic list

  Parameters

  • options: SerializeOptions = ...

    serialization options. See SerializeOptions

  Returns GenericList

  generic list object based on path provided in options. See GenericList

showIcons

• showIcons(enabled?: boolean): ConcreteImpl

  Set generic list display options

  Parameters

  • enabled: boolean = true

    allow / disallow for showing icons

  Returns ConcreteImpl

  generic list builder based on display options (showIcons) provided.

title

• title(title: string): ConcreteImpl

  Set generic list title

  Parameters

  • title: string

    generic list title

  Returns ConcreteImpl

  generic list builder based on title and ID provided.