Class MxtStack<T>

A simple stack structure with notifications to the stack elements as to when they are added, removed, etc. The top-most element is considered "selected", and this stack also fires events as elements are selected and deselected.

Type Parameters

T extends IStackable

Hierarchy

MxtStack

Index

Constructors

constructor

new MxtStack<T>(): MxtStack<T>
Brief
Creates and returns a new MxtStack.
Type Parameters
- T extends IStackable
Returns MxtStack<T>
- Defined in js/modularconfig/utilities/MxtStack.ts:26

Properties

`Private` _data

_data: T[]

`Private` _onAddedCallback

_onAddedCallback: ((element: IStackable) => void)

Type declaration

- (element: IStackable): void
- Parameters
  - element: IStackable
  Returns void

`Private` _onDeselectedCallback

_onDeselectedCallback: ((element: IStackable) => void)

Type declaration

- (element: IStackable): void
- Parameters
  - element: IStackable
  Returns void

`Private` _onRemovedCallback

_onRemovedCallback: ((element: IStackable) => void)

Type declaration

- (element: IStackable): void
- Parameters
  - element: IStackable
  Returns void

`Private` _onSelectedCallback

_onSelectedCallback: ((element: IStackable) => void)

Type declaration

- (element: IStackable): void
- Parameters
  - element: IStackable
  Returns void

Accessors

height

get height(): number
Brief
The number of elements in the stack.

Returns number
- Defined in js/modularconfig/utilities/MxtStack.ts:31

Methods

clear

clear(): void
Brief
Clears the stack, notifying each element first of its removal. The selection/deselection process is skipped.

Returns void
- Defined in js/modularconfig/utilities/MxtStack.ts:138

peek

peek(): T
Brief
Returns the top-most element of the stack, if it exists; otherwise null. The stack is not modified.

Returns T
- Defined in js/modularconfig/utilities/MxtStack.ts:127

pop

pop(): T
Brief
Pops the top-most element from the stack, if one exists. Before being popped, the element is notified that it is deselected, then removed. The next element in line (if there is one) is then notified that it is selected.

Returns
The popped element, if one was available. Otherwise null.

Returns T
- Defined in js/modularconfig/utilities/MxtStack.ts:94

push

push(element: T): void
Brief
Pushes a new element onto the stack. If there is a current top element, it is deselected. The new element is then added (with callback) and selected.
Parameters
- element: T
  
  The element to be pushed.
Returns void
- Defined in js/modularconfig/utilities/MxtStack.ts:60

setOnAddedCallback

setOnAddedCallback(callback: ((element: IStackable) => void)): void
Brief
Sets the callback to be made when an element is added/pushed onto this stack.
Parameters
- callback: ((element: IStackable) => void)
  - - (element: IStackable): void
    - Parameters
      
      element: IStackable
      
      Returns void
Returns void
- Defined in js/modularconfig/utilities/MxtStack.ts:36

setOnDeselectedCallback

setOnDeselectedCallback(callback: ((element: IStackable) => void)): void
Brief
Sets te callback to be made when an element is deselected in this stack.
Parameters
- callback: ((element: IStackable) => void)
  - - (element: IStackable): void
    - Parameters
      
      element: IStackable
      
      Returns void
Returns void
- Defined in js/modularconfig/utilities/MxtStack.ts:51

setOnRemovedCallback

setOnRemovedCallback(callback: ((element: IStackable) => void)): void
Brief
Sets the callback to be made when an element is removed/popped from this stack.
Parameters
- callback: ((element: IStackable) => void)
  - - (element: IStackable): void
    - Parameters
      
      element: IStackable
      
      Returns void
Returns void
- Defined in js/modularconfig/utilities/MxtStack.ts:41

setOnSelectedCallback

setOnSelectedCallback(callback: ((element: IStackable) => void)): void
Brief
Sets the callback to be made when an element is selected in this stack.
Parameters
- callback: ((element: IStackable) => void)
  - - (element: IStackable): void
    - Parameters
      
      element: IStackable
      
      Returns void
Returns void
- Defined in js/modularconfig/utilities/MxtStack.ts:46

Class MxtStack<T>

Type Parameters

T extends IStackable

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Brief

Type Parameters

T extends IStackable

Returns MxtStack<T>

Properties

Private _data

Private _onAddedCallback

Type declaration

Parameters

element: IStackable

Returns void

Private _onDeselectedCallback

Type declaration

Parameters

element: IStackable

Returns void

Private _onRemovedCallback

Type declaration

Parameters

element: IStackable

Returns void

Private _onSelectedCallback

Type declaration

Parameters

element: IStackable

Returns void

Accessors

height

Brief

Returns number

Methods

clear

Brief

Returns void

peek

Brief

Returns T

pop

Brief

Returns

Returns T

push

Brief

Parameters

element: T

Returns void

setOnAddedCallback

Brief

Parameters

callback: ((element: IStackable) => void)

Parameters

element: IStackable

Returns void

Returns void

setOnDeselectedCallback

Brief

Parameters

callback: ((element: IStackable) => void)

Parameters

element: IStackable

Returns void

Returns void

setOnRemovedCallback

Brief

Parameters

callback: ((element: IStackable) => void)

Parameters

element: IStackable

Returns void

`Private` _data

`Private` _onAddedCallback

`Private` _onDeselectedCallback

`Private` _onRemovedCallback

`Private` _onSelectedCallback