Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IControlCollection

A dynamic toolbar control to group and organize related controls

Hierarchy

Index

Properties

Methods

Properties

class

class: string
property

{string} class class to bind to for the css style

controls

controls: IToolbarControl[]
property

{IToolbarControl[]} controls Gets the array of controls in the collection

disabled

disabled: boolean
property

{boolean} disabled disabled status for the toolbar control

id

id: string
property

{string} class class to bind to for the css style

isControlCollection

isControlCollection: boolean
property

{boolean} isControlCollection whether control is for control collection

isFlexible

isFlexible: boolean
property

{boolean} isFlexible whether the control should be allowed to grow and shrink in the toolbar

isHidden

isHidden: boolean
property

{boolean} isHidden hide/show the toolbar control

leftDivider

leftDivider: boolean
property

{boolean} Whether or not to show the left divider on the collection

order

order: number
property

{number} order Order in which to place the component within a toolbar slot

Optional permissionCheck

permissionCheck: IPermissionCheckRequest
property

{IPermissionCheckRequest} permissionCheck used by the toolbar control

rightDivider

rightDivider: boolean
property

{boolean} Whether or not to show the right divider on the collection

scrollDimensions

scrollDimensions: object
property

{{x: number, y: number}} scrollDimensions Dimensions of the element as rendered on the toolbar.

Type declaration

  • x: number
  • y: number

title

title: string
property

{string} title title/name for the toolbar control

viewModelPath

viewModelPath: string
readonly

@property {string} viewModelPath path to viewer model for the toolbar control

Methods

addControl

  • Adds the provided control to the collection

    Parameters

    • control: IToolbarControl

      The toolbar control to add to the collection

    • Optional position: number

    Returns void

disable

  • disable(): void

  • Disables the toolbar control. This will also gets called when toolbar containing the control gets disabled. Note: If the control needs to do additional sync/async taks (e.x checking on user permission), create override method for disable.

    Returns void

enable

  • enable(): void

  • Enables the toolbar control. This will also gets called when toolbar containing the control gets enabled. Note: If the control needs to do additional sync/async taks (e.x checking on user permission), create override method for enable.

    Returns void

getControlById

  • Retrieves the toolbar control with the specified identifier

    Parameters

    • id: string

      The element identifier

    Returns IToolbarControl

    First toolbar control element matching ${id} or null if none present

hide

  • hide(): void

removeControl

  • Removes the provided toolbar control from the collection

    Parameters

    • control: IToolbarControl

      The toolbar control to remove from the collection

    Returns boolean

    Whether or not item was removed

show

  • show(): void