Class Model

Class containing the Tree of Nodes used by the FlexLayout component

Hierarchy

Model

Index

Methods

Methods

doAction

doAction(action: Action): undefined | Node

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 undefined | Node
added Node for Actions.addNode; undefined otherwise

getActiveTabset

getActiveTabset(): undefined | TabSetNode

Get the currently active tabset node

Returns undefined | TabSetNode

getBorderSet

getBorderSet(): BorderSet

Gets the

Returns BorderSet

getMaximizedTabset

getMaximizedTabset(): undefined | TabSetNode

Get the currently maximized tabset node

Returns undefined | TabSetNode

getNodeById

getNodeById(id: string): Node

Gets a node by its id

Parameters
- id: string
  
  the id to find
Returns Node

getRoot

getRoot(): RowNode

Gets the root RowNode of the model

Returns RowNode

getSplitterExtra

getSplitterExtra(): number

Returns number

getSplitterSize

getSplitterSize(): number

Returns number

isEnableEdgeDock

isEnableEdgeDock(): boolean

Returns boolean

isLegacyOverflowMenu

isLegacyOverflowMenu(): boolean

Returns boolean

isRootOrientationVertical

isRootOrientationVertical(): boolean

Returns boolean

isUseVisibility

isUseVisibility(): boolean

Returns boolean

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
  - - (dragNode: Node, dropInfo: DropInfo): boolean
    - Parameters
      - dragNode: Node
      - dropInfo: DropInfo
      Returns boolean
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
  - - (tabNode?: TabNode): ITabSetAttributes
    - Parameters
      - Optional tabNode: TabNode
      Returns ITabSetAttributes
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

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
  - - (node: Node, level: number): void
    - Parameters
      - node: Node
      - level: number
      Returns void
Returns void

Static fromJson

fromJson(json: IJsonModel): Model

Loads the model from the given json object

Parameters
- json: IJsonModel
  
  the json model to load
Returns Model
a new Model object

Static toTypescriptInterfaces

toTypescriptInterfaces(): void

Returns void

Generated using TypeDoc