Class Model

StaticMAIN_LAYOUT_ID

addChangeListener

• addChangeListener(
      listener: ModelChangeListener | ((action: Action) => void),
  ): void

  Register a change listener (ModelChangeListener or legacy function). Fires for every action, including direct model.doAction calls.

  Parameters

  • listener: ModelChangeListener | ((action: Action) => void)

  Returns void

doAction

• doAction(action: Action): any

  Update the node tree by performing the given action, Actions should be generated via static methods on the Actions class

  Parameters

  • action: Action

    the action to perform

  Returns any

  added Node for Actions.addTab, layoutId for createPopout

getActiveTabset

• getActiveTabset(layoutId?: string): TabSetNode | undefined

  Get the currently active tabset node

  Parameters

  • layoutId: string = Model.MAIN_LAYOUT_ID

  Returns TabSetNode | undefined

getBorderLeftTabDirection

• getBorderLeftTabDirection(): IBorderTabDirection

  Returns IBorderTabDirection

getBorderSet

• getBorderSet(): BorderSet

  Gets the

  Returns BorderSet

getFirstTabSet

• getFirstTabSet(node?: Node | undefined): TabSetNode | undefined

  Finds the first/top left tab set of the given node.

  Parameters

  • node: Node | undefined = ...

    The top node you want to begin searching from, deafults to the root node

  Returns TabSetNode | undefined

  The first Tab Set

getMaximizedTabset

• getMaximizedTabset(layoutId?: string): TabSetNode | undefined

  Get the currently maximized tabset node

  Parameters

  • layoutId: string = Model.MAIN_LAYOUT_ID

  Returns TabSetNode | undefined

getNodeById

• getNodeById(id: string): Node | undefined

  Gets a node by its id

  Parameters

  • id: string

    the id to find

  Returns Node | undefined

getRootRow

• getRootRow(layoutId?: string): RowNode | undefined

  Gets the root RowNode of the model

  Parameters

  • layoutId: string = Model.MAIN_LAYOUT_ID

  Returns RowNode | undefined

getSplitterSize

• getSplitterSize(): number | undefined

  Returns number | undefined

getTabGroupType

• getTabGroupType(): ITabGroupType

  Returns ITabGroupType

isEnableEdgeDock

• isEnableEdgeDock(): boolean

  Returns boolean

isEnableEdgeDockIndicators

• isEnableEdgeDockIndicators(): boolean

  Returns boolean

isEnableRotateBorderIcons

• isEnableRotateBorderIcons(): boolean

  Returns boolean

isRootOrientationVertical

• isRootOrientationVertical(): boolean

  Returns boolean

removeChangeListener

• removeChangeListener(
      listener: ModelChangeListener | ((action: Action) => void),
  ): void

  Removes a listener previously registered with addChangeListener (either a function or a ModelChangeListener object)

  Parameters

  • listener: ModelChangeListener | ((action: Action) => void)

    the listener to remove

  Returns void

setOnAllowDrop

• setOnAllowDrop(
      onAllowDrop: (dragNode: Node, dropInfo: DropInfo) => boolean,
  ): void

  Sets a function to allow/deny dropping a node

  Parameters

  • onAllowDrop: (dragNode: Node, dropInfo: DropInfo) => boolean

    function that takes the drag node and DropInfo and returns true if the drop is allowed

  Returns void

setOnCreateTabSet

• setOnCreateTabSet(
      onCreateTabSet: (tabNode?: TabNode) => ITabSetAttributes,
  ): void

  set callback called when a new TabSet is created. The tabNode can be undefined if it's the auto created first tabset in the root row (when the last tab is deleted, the root tabset can be recreated)

  Parameters

  • onCreateTabSet: (tabNode?: TabNode) => ITabSetAttributes

  Returns void

setSplitterSize

• setSplitterSize(size?: number): void

  Parameters

  • Optionalsize: number

  Returns void

toJson

• toJson(): IJsonModel

  Converts the model to a json object

  Returns IJsonModel

  json object that represents this model

toString

• toString(): string

  Returns string

visitLayoutNodes

• visitLayoutNodes(
      layoutId: string,
      fn: (node: Node, level: number) => void,
  ): void

  Parameters

  • layoutId: string
  • fn: (node: Node, level: number) => void

  Returns void

visitNodes

• visitNodes(fn: (node: Node, level: number) => void): void

  Visits all the nodes in the model and calls the given function for each

  Parameters

  • fn: (node: Node, level: number) => void

    a function that takes visited node and a integer level as parameters

  Returns void

StaticensureAttributePairing

• ensureAttributePairing(): void

  Pairs the global attribute definitions with the node attribute definitions so that an inherited node attribute can resolve its type/description/default from the global attribute it maps to (and vice versa), e.g. tabEnableClose <-> enableClose. Idempotent; called automatically when the definitions are accessed.

  Returns void

StaticfromJson

• fromJson(json: IJsonModel, previousModel?: Model): Model

  Load a model from JSON.

  Parameters

  • json: IJsonModel
  • OptionalpreviousModel: Model

    optional; when given, matching tabs adopt its view state (no remount).

  Returns Model