Class TreeController<T>Abstract

Subclass this to create a broker between your data and a Tree to display and manipulate it. The Tree doesn't know how your data is structured and how to handle it, the controller implements the methods needed

Type Parameters

  • T

Hierarchy (view full)

Constructors

constructor

Properties

dragDropIndicator selection sortable

Methods

addChildren canAddChildren clone copy createContent cut delete dragOver dragStart draggable drop equals getAttributes getChildren hasChildren paste setValue

Constructors

constructor

Properties

dragDropIndicator

dragDropIndicator: HTMLHRElement = ...

Used by the tree to indicate the drop position while dragging

selection

selection: T[] = []

Stores references to selected objects. Override with a reference in outer scope, if selection should also operate outside of table

sortable

sortable: boolean = true

Override to enable tree items to be sortable by the user via drag-and-drop. Default is true.

Methods

Abstract addChildren

  • addChildren(_sources, _target, _index?): T[]

  • Process the list of source objects to be addedAsChildren when dropping or pasting onto the target item/object, return the list of objects that should visibly become the children of the target item/object

    Parameters

    • _sources: T[]
    • _target: T

      The object referenced by the item the drop occurs on

    • Optional _index: number

    Returns T[]

canAddChildren

clone

copy

Abstract createContent

  • createContent(_object): HTMLElement

  • Create an HTMLElement for the tree item representing the object. e.g. an HTMLInputElement

    Parameters

    • _object: T

    Returns HTMLElement

cut

  • cut(_focus, _operation): Promise<T[]>

  • Refer objects to the clipboard for copy & paste and delete them from this controller

    Parameters

    • _focus: T

      The item that has the focus and that will be cut if the selection is empty, otherwise the whole selection gets referred and deleted

    • _operation: ClipOperation

    Returns Promise<T[]>

delete

  • delete(_expendables): Promise<T[]>

  • Remove the objects to be deleted, e.g. the current selection, from the data structure the table refers to and return a list of those objects in order for the according TableItems to be deleted also

    Parameters

    • _expendables: T[]

      The expendable objects

    Returns Promise<T[]>

dragOver

dragStart

  • dragStart(_focus): void

  • Refer objects to the clipboard for drag & drop

    Parameters

    • _focus: T

      The item that has the focus and that will be dragged if the selection is empty, otherwise the current selection is referred

    Returns void

draggable

drop

  • drop(_event): Promise<T[]>

  • Retrieve objects from the clipboard, process and return them to add to the tree. Standard behaviour: if {@link: dragOver} yields "copy", return an array of clones of the objects in, otherwise the content of the dragDrop-clipboard.

    Parameters

    • _event: DragEvent

    Returns Promise<T[]>

equals

  • equals(_a, _b): boolean

  • Checks if two objects of are equal. Default is _a == _b. Override for more complex comparisons. Useful when the underlying data is volatile and changes identity while staying the same.

    Parameters

    • _a: T
    • _b: T

    Returns boolean

Abstract getAttributes

  • getAttributes(_object): string

  • Retrieve a space separated string of attributes to add to the list item representing the object for further styling

    Parameters

    • _object: T

    Returns string

Abstract getChildren

Abstract hasChildren

  • hasChildren(_object): boolean

  • Return true if the object has children that must be shown when unfolding the tree item

    Parameters

    • _object: T

    Returns boolean

paste

  • paste(): Promise<T[]>

  • Retrieve objects from the clipboard, process and return them to add to the table
    Standard behaviour: if the copyPaste clipboard was filled using copy, return an array of clones, otherwise the content of the clipboard

    Returns Promise<T[]>

Abstract setValue

  • setValue(_object, _element): Promise<boolean>

  • Process the proposed new value. The id of the html element on which the change occured is passed

    Parameters

    • _object: T
    • _element: HTMLInputElement | HTMLSelectElement

    Returns Promise<boolean>

Settings

Member Visibility

Theme

On This Page

constructordragDropIndicatorselectionsortableaddChildrencanAddChildrenclonecopycreateContentcutdeletedragOverdragStartdraggabledropequalsgetAttributesgetChildrenhasChildrenpastesetValue