@mobilize/wms-components documentation
  1. Components
  2. XamTreeBaseComponent

File

projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts

Description

XamTree base component class.

Extends

BaseComponent

Implements

OnInit OnDestroy AfterContentInit AfterViewInit

Index

Properties
Methods
Inputs
Outputs
HostBindings
Accessors

Constructor

Public constructor(injectedModelBase: XamTreeModel, cdRefBase: ChangeDetectorRef, injectorBase: Injector)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:410

Creates an instance of XamTreeComponent.

Parameters :
Name Type Optional
injectedModelBase XamTreeModel No
cdRefBase ChangeDetectorRef No
injectorBase Injector No

Inputs

checkBoxMode
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:242

Sets the CheckBoxMode property of the XamTree
checkBoxVisibility
Type : any
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:379

Sets the checkbox visibility input
hierachicalItemTemplate
Type : any
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:187

Sets the HierachicalItemTemplate
hierachicalItemTemplateInput
Type : HierarchicalDataTemplate
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:180

If the Xamtree is inherit, this input allow the HierarchicalDataTemplate to work as expected.
isDraggable
Type : boolean
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:214

Sets IsDraggable property in the model.
itemsSource
Type : any
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:154

Sets the itemssource
model
Type : XamTreeModel
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:87

Object with properties and events for the XamTree.
controlTemplate
Type : any
Inherited from BaseComponent
Defined in BaseComponent:1197

Sets the controlTemplate Input property for changing the model's TemplateProperty
cursor
Inherited from BaseComponent
Defined in BaseComponent:1451

Property used to save the cursor value
dataContext
Type : any
Inherited from BaseComponent
Defined in BaseComponent:952

Gets/sets the dataContext Input property for changing the model's DataContextProperty
dataGridRowHeight
Type : number
Default value : 22
Inherited from BaseComponent
Defined in BaseComponent:507

Represents the row height of both the DataGrid and XamGrid components it affects the css and also an internal function that virtualized data, so do not change directly on css, use this variable instead.
foreground
Type : any
Inherited from BaseComponent
Defined in BaseComponent:1223

Sets the value of the Foreground property
height
Inherited from BaseComponent
Defined in BaseComponent:1394

Sets the height
horizontalAlignment
Inherited from BaseComponent
Defined in BaseComponent:1096

Sets the horizontal alignment.
horizontalContentAlignment
Inherited from BaseComponent
Defined in BaseComponent:1125

Sets the horizontal content alignment.
hostHozSelfAlign
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:380

Applies horizontal selfalign class. Flags indicates when the control should handle its own horizontal alignment and ignore container alignment.
isEnabled
Inherited from BaseComponent
Defined in BaseComponent:1008

Gets/sets the isEnabled property for the BaseComponent
isTabStop
Type : boolean
Inherited from BaseComponent
Defined in BaseComponent:760

Sets/gets IsTabStop property of the BaseComponent
margin
Type : string
Inherited from BaseComponent
Defined in BaseComponent:782

Sets Margin property of the BaseComponent.
maxHeight
Type : any
Inherited from BaseComponent
Defined in BaseComponent:1325

Sets maxHeight
maxWidth
Type : any
Inherited from BaseComponent
Defined in BaseComponent:1283

Sets maxWidth
minHeight
Type : any
Inherited from BaseComponent
Defined in BaseComponent:1304

Sets minHeight
minWidth
Type : any
Inherited from BaseComponent
Defined in BaseComponent:1262

Sets min Width
name
Type : string
Inherited from BaseComponent
Defined in BaseComponent:1153

Sets the name model property for the control when the name is an input
opacity
Inherited from BaseComponent
Defined in BaseComponent:1336

Sets Opacity value property of the component
spellCheck
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:186

Flag to determinate if the component should do the spell check or not. Default value is false.
style
Inherited from BaseComponent
Defined in BaseComponent:1434

Sets the style
tabIndex
Type : number
Inherited from BaseComponent
Defined in BaseComponent:733

Sets the property TabIndex of the control model.
tag
Type : any
Inherited from BaseComponent
Defined in BaseComponent:1171

Object used in the Tag property of the Button
useCss
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:177

Determines if the component uses CSS height/width values, instead of inputs
verticalAlignment
Inherited from BaseComponent
Defined in BaseComponent:1038

Sets the vertical alignment.
verticalContentAlignment
Inherited from BaseComponent
Defined in BaseComponent:1067

Sets the vertical content alignment.
visibility
Type : any
Inherited from BaseComponent
Defined in BaseComponent:980

Gets/sets the visibility property for the BaseComponent
width
Inherited from BaseComponent
Defined in BaseComponent:1365

Sets the width
zindex
Type : number
Inherited from BaseComponent
Defined in BaseComponent:1498

Property used to set the canvas zindex value.

Note: Consider moving this @Input to canvas.direcive.ts, refactoring the directive so all inputs are declared in the directive, and all @HostBindings are declared here in baseComponent, the directive would be responsible for updating the models, while baseComponent will be responsible for binding the values: zIndex, Top, Left...

Outputs

activeItemChanged
Type : EventEmitter<literal type>
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:104

Event that get triggered when the active item changes
itemCheckChanged
Type : EventEmitter<literal type>
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:124

Event that get triggered when an item is check state is changed
itemDragStart
Type : EventEmitter<literal type>
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:144

Events that get triggered when an item is dragged.
itemDropped
Type : EventEmitter<literal type>
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:133

Events that get triggered when an item is dropped.
itemExpansionChanged
Type : EventEmitter<literal type>
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:113

Event that get triggered when an element expansion occurs
selectionChanged
Type : EventEmitter<literal type>
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:95

Event that get triggered when the selection changes
bindingValidationError
Type : EventEmitter<any>
Inherited from BaseComponent
Defined in BaseComponent:114

output to emit the new value of the bindingValidationError event
layoutUpdated
Type : EventEmitter<any>
Inherited from BaseComponent
Defined in BaseComponent:140

Output to emit when then component's layout is updated.
loaded
Type : EventEmitter<any>
Inherited from BaseComponent
Defined in BaseComponent:123

Output to emit when then component is loaded.
mouseEnter
Type : EventEmitter<literal type>
Inherited from BaseComponent
Defined in BaseComponent:157

Event Emitter. EventEmitter normally called in the mouseEnterHandler.
mouseLeave
Type : EventEmitter<literal type>
Inherited from BaseComponent
Defined in BaseComponent:167

Event Emitter Called in the mouseLeave handler
mouseLeftButtonUp
Type : EventEmitter<literal type>
Inherited from BaseComponent
Defined in BaseComponent:147

MouseLeftButtonUp event Emitter.
sizeChanged
Type : EventEmitter<any>
Inherited from BaseComponent
Defined in BaseComponent:132

Output to emit when then component size is changed.

HostBindings

class
Type : string
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:407

Applies custom CSS classes
class.defaultFontStyles
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:398

Applies default font styles class, used to allow specificity for each control css
class.focusable
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:388

Display if the component is focusable or not
class.hasDefinedCursor
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:415

Applies Defined Cursor class
class.horizontal-center
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:308

Applies horizontal alignment left class
class.horizontal-left
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:298

Applies horizontal alignment left class
class.horizontal-right
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:368

Applies horizontal alignment right class
class.horizontal-stretch
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:358

Applies horizontal alignment stretch class
class.vertical-bottom
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:328

Applies vertical alignment bottom class
class.vertical-center
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:338

Applies vertical alignment center class
class.vertical-stretch
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:318

Applies horizontal alignment stretch class
class.vertical-top
Type : boolean
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:348

Applies vertical alignment top class
style.display
Type : any
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:243

Property use it to apply the host binding for the visibility
style.font-family
Type : any
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:261

Property use it to apply the host binding for the font-family
style.font-size
Type : any
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:270

Property use it to apply the host binding for the font-size
style.font-style
Type : any
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:279

Property use it to apply the host binding for the font-style
style.font-weight
Type : any
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:288

Property use it to apply the host binding for the font-weight
style.height
Type : string
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:218

Property use it to apply the host binding for the height
style.max-height.px
Type : number
Inherited from BaseComponent
Defined in BaseComponent:234

Property used to apply the host binding for max-height
style.max-width.px
Type : number
Inherited from BaseComponent
Defined in BaseComponent:210

Property used to apply the host binding for max-width
style.min-height.px
Type : number
Inherited from BaseComponent
Defined in BaseComponent:226

Property used to apply the host binding for min-height
style.min-width.px
Type : number
Inherited from BaseComponent
Defined in BaseComponent:202

Property used to apply the host binding for min-width
style.opacity
Type : any
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:252

Property use it to apply the host binding for the opacity
style.width
Type : string
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:194

Property use it to apply the host binding for the width
style.z-index
Type : string
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:424

Sets the z-index style.

Methods

checkboxChangeHandler
checkboxChangeHandler(args: IChangeCheckboxEventArgs, node: XamTreeItemModel)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:567

Checkbox change handler.

Parameters :
Name Type Optional
args IChangeCheckboxEventArgs No
node XamTreeItemModel No
Returns : void
dragStartHandler
dragStartHandler(event: DragEvent)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:715

Item drag started event handler

Parameters :
Name Type Optional
event DragEvent No
Returns : void
dropHandler
dropHandler(event: DragEvent)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:732

Dropped item event handler

Parameters :
Name Type Optional
event DragEvent No
Returns : void

{void}
Protected expandingNodes
expandingNodes(nodesToCheck: Iterable<any>)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:808

Expand nodes at another level

Parameters :
Name Type Optional
nodesToCheck Iterable<any> No
Returns : void
expandInitialElementsIfRequired
expandInitialElementsIfRequired()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:656

Expands initial nodes if required

Returns : void
getColor
getColor(modelColor: any)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:583

Gets the CSS color for the given model value

Parameters :
Name Type Optional
modelColor any No
Returns : any
getImagePath
getImagePath(type: any)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:701

get image URL

Parameters :
Name Type Optional
type any No
Returns : any
getItemFontWeight
getItemFontWeight(value: number)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:599

Expand nodes at another level

Parameters :
Name Type Optional
value number No
Returns : any
hasChild
hasChild(level, node)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:637

Verifies if the given node has children

Parameters :
Name Optional
level No
node No
Returns : void
hasChildHierarchical
hasChildHierarchical(level: any, node: any)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:648

Verifies if the given node has children

Parameters :
Name Type Optional
level any No
node any No
Returns : any
isNodeActive
isNodeActive(node: any)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:826

Returns true if the node is the activeItem.

Parameters :
Name Type Optional
node any No
Returns : boolean

{boolean}
isSelfOrChildren
isSelfOrChildren(parent: XamTreeItemModel, son: XamTreeItemModel)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:758

Check if son is under parent (in any level).

Parameters :
Name Type Optional
parent XamTreeItemModel No
son XamTreeItemModel No
Returns : boolean

{boolean}
modelChangeHandler
modelChangeHandler(name?: string, extraArg?: unknown)
Inherited from BaseComponent
Defined in BaseComponent:609

Model changed handler adding scenario for refreshing the tree on node change

Parameters :
Name Type Optional
name string Yes
extraArg unknown Yes
Returns : void
ngAfterContentInit
ngAfterContentInit()
Inherited from BaseComponent
Defined in BaseComponent:476

Angular lifecycle hook

Returns : void
ngAfterViewInit
ngAfterViewInit()
Inherited from BaseComponent
Defined in BaseComponent:497

Angular lifecycle hook

Returns : void
ngOnDestroy
ngOnDestroy()
Inherited from BaseComponent
Defined in BaseComponent:518

Angular lifecycle hook

Returns : void
ngOnInit
ngOnInit()
Inherited from BaseComponent
Defined in BaseComponent:432

Angular lifecycle hook

Returns : void
refresh
refresh()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:626

Refresh the tree

Returns : void
restoreScrollPosition
restoreScrollPosition()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:789

Restore the last scrolled position.

Returns : void
scrollHandler
scrollHandler()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:796

Handler executed whenever the main container is scrolled.

Returns : void
scrollIntoNode
scrollIntoNode(nodeToFind: any)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:774

Scrolls into a given node.

Parameters :
Name Type Optional
nodeToFind any No
Returns : void
select
select(node: any)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:536

Selects a node

Parameters :
Name Type Optional
node any No
Returns : void
setupData
setupData()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:692

Function that setup the data in the tree datasource

Returns : void
syncHierachicalItemTemplate
syncHierachicalItemTemplate()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:667

Syncs static hierachicalItemTemplate with the model property

Returns : void
toggleExpandedState
toggleExpandedState(event: MouseEvent, node: any, shouldPropagate: boolean)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:548

Toggles the expanded state of the given node.

Parameters :
Name Type Optional
event MouseEvent No
node any No
shouldPropagate boolean No
Returns : void
Protected alignmentHandler
alignmentHandler()
Inherited from BaseComponent
Defined in BaseComponent:2346

Calculate the values for the grid size behavior from the alignments

Returns : void
Protected assignPendingPropertyValues
assignPendingPropertyValues()
Inherited from BaseComponent
Defined in BaseComponent:2057

Apply pending assignments to properties with property values

Returns : void
calculateActualSize
calculateActualSize(name?: string)
Inherited from BaseComponent
Defined in BaseComponent:1674

If the name is equal to 'calculateActualSize', then call the handlerCalcActualSize function and pass in false to avoid the timer in the function.

memberof BaseComponent

Parameters :
Name Type Optional Description
name string Yes
  • The name of the event. memberof BaseComponent
Returns : void
Protected checkAndRegisterCompatibilityBinding
checkAndRegisterCompatibilityBinding(property: DependencyProperty, bindingObjectCandidate: any)
Inherited from BaseComponent
Defined in BaseComponent:2023

Verifies if the given object (bindingObjectCandidate) is a binding object. If so the binding will be registered.

Parameters :
Name Type Optional
property DependencyProperty No
bindingObjectCandidate any No
Returns : boolean

{boolean} true if the value is a binding info object and if the binding was registered, false if not
Protected checkForStaticResource
checkForStaticResource(property: string, value: any)
Inherited from BaseComponent
Defined in BaseComponent:2043

Checks if the given value is a static resource reference or not, if a reference then the value is queue for later assignment.

Parameters :
Name Type Optional Description
property string No

the name of the property to check for
value any No

the property value
Returns : boolean

true if the value is a static resource reference, otherwise false
checkStaticItemInModelCollection
checkStaticItemInModelCollection(collection: any, itemToCheck: any)
Inherited from BaseComponent
Defined in BaseComponent:1889

Checks if the element exists previously in the items collection

Parameters :
Name Type Optional Description
collection any No

The control items collection
itemToCheck any No

The static element to be reviewed
Returns : number

number Returns -1 if the item is not present in the items collection otherwise the index value
createElementInRoot
createElementInRoot(injector: Injector, componentToCreate: any)
Inherited from BaseComponent
Defined in BaseComponent:2698

Create a given component on the HTML body.

Parameters :
Name Type Optional
injector Injector No
componentToCreate any No
Returns : ComponentRef<any>
cursorStyle
cursorStyle()
Inherited from BaseComponent
Defined in BaseComponent:1549

Returns the correct CSS cursor style and sets the definedCursor flag if necessary

Returns : string

{string}
detectChanges
detectChanges()
Inherited from BaseComponent
Defined in BaseComponent:813

Performs a single detect Changes over the component

Returns : void
detectChangesAction
detectChangesAction()
Inherited from BaseComponent
Defined in BaseComponent:1686

Handle subscription to the notifyDetectChanges action Refresh the component whenever a model modification was performed

Returns : void
getForeground
getForeground()
Inherited from BaseComponent
Defined in BaseComponent:1966

Calculates the Foreground color to be applied

Returns : string

string
getImageString
getImageString(value: any)
Inherited from BaseComponent
Defined in BaseComponent:2221

Returns string path to the image.

Parameters :
Name Type Optional
value any No
Returns : any
getTargetValue
getTargetValue(e: Event)
Inherited from BaseComponent
Defined in BaseComponent:2239

Returns the value from a $event

Parameters :
Name Type Optional
e Event No
Returns : string
Protected handlerCalcActualSize
handlerCalcActualSize(async: boolean)
Inherited from BaseComponent
Defined in BaseComponent:2391

Handler that calculates ActualHeight & ActualWidth based on its inner content.

Parameters :
Name Type Optional
async boolean No
Returns : void
heightCalc
heightCalc()
Inherited from BaseComponent
Defined in BaseComponent:1939

Applies the height CSS value

Returns : any
heightDefaultStyle
heightDefaultStyle()
Inherited from BaseComponent
Defined in BaseComponent:1914

Calculates the auto height value

Returns : string

{string}
Protected hostHorizontalAlignmentCall
hostHorizontalAlignmentCall()
Inherited from BaseComponent
Defined in BaseComponent:2374

Assign all the horizontal bindings for the control

Returns : void
Protected hostVerticalAlignmentCall
hostVerticalAlignmentCall()
Inherited from BaseComponent
Defined in BaseComponent:2357

Assign all the vertical bindings for the control

Returns : void
imageToPath
imageToPath(value: any)
Inherited from BaseComponent
Defined in BaseComponent:2202

Returns the path of the given image.

Parameters :
Name Type Optional
value any No
Returns : any
loadStaticItems
loadStaticItems(staticItems: any, itemsCollection: any)
Inherited from BaseComponent
Defined in BaseComponent:1634
Parameters :
Name Type Optional Description
staticItems any No

The static elements to be added
itemsCollection any No

The control items collection
Returns : void

void
Private markForCheckComp
markForCheckComp()
Inherited from BaseComponent
Defined in BaseComponent:2451

Marks current component

Returns : void
mouseEnterHandler
mouseEnterHandler(event: any)
Inherited from BaseComponent
Defined in BaseComponent:1982

Event Handler for when the mouse enter the Image component.

Parameters :
Name Type Optional Description
event any No
  • event from the DOM event
Returns : void
mouseLeaveHandler
mouseLeaveHandler(event: any)
Inherited from BaseComponent
Defined in BaseComponent:2001

Event Handler for when the mouse enter the Image component.

Parameters :
Name Type Optional Description
event any No
  • event from the DOM event
Returns : void
Public ngAfterContentChecked
ngAfterContentChecked()
Inherited from BaseComponent
Defined in BaseComponent:867

Angular Lifecycle Hooks

Returns : void
Public ngAfterViewChecked
ngAfterViewChecked()
Inherited from BaseComponent
Defined in BaseComponent:893

Angular Lifecycle Hooks

Returns : void
Public ngDoCheck
ngDoCheck()
Inherited from BaseComponent
Defined in BaseComponent:847

Angular Lifecycle Hooks

Returns : void
Public ngOnChanges
ngOnChanges()
Inherited from BaseComponent
Defined in BaseComponent:824

Angular Lifecycle Hooks

Returns : void
preventItemsDuplication
preventItemsDuplication(itemsToRender: any, items: any, contentChildTemplate: any, afterContentInitCalled: boolean, injector: Injector)
Inherited from BaseComponent
Defined in BaseComponent:2170

Validates if coming models are the same, and prevents to be recreated on Ribbon DOM. (Needs to be checked, in some statics scenarios RibbonTab, RibbonGroup duplicates items)

Parameters :
Name Type Optional
itemsToRender any No
items any No
contentChildTemplate any No
afterContentInitCalled boolean No
injector Injector No
Returns : any[]
processAlignments
processAlignments(name: string)
Inherited from BaseComponent
Defined in BaseComponent:1704

Method to check if the component should assign a alignment property

Parameters :
Name Type Optional
name string No
Returns : void

{void}
processCursor
processCursor(name: string)
Inherited from BaseComponent
Defined in BaseComponent:1850

Method to set the cursor style of the component

Parameters :
Name Type Optional
name string No
Returns : void
processCustomCssClasses
processCustomCssClasses(name: string)
Inherited from BaseComponent
Defined in BaseComponent:1723

Method to set custom CSS Clases

Parameters :
Name Type Optional
name string No
Returns : void

{void}
processFocusable
processFocusable(name: string)
Inherited from BaseComponent
Defined in BaseComponent:1816

Method to check and set the height of the grid

Parameters :
Name Type Optional
name string No
Returns : void
Private processFontFamily
processFontFamily(name: string)
Inherited from BaseComponent
Defined in BaseComponent:2784

Process the FontFamily property

Parameters :
Name Type Optional
name string No
Returns : any
processFonts
processFonts(name: string)
Inherited from BaseComponent
Defined in BaseComponent:1778

Method to apply the font styles for the component.

Parameters :
Name Type Optional
name string No
Returns : void
Private processFontSize
processFontSize(name: string)
Inherited from BaseComponent
Defined in BaseComponent:2798

Process the FontSize property

Parameters :
Name Type Optional
name string No
Returns : any
Private processFontStyle
processFontStyle(name: string)
Inherited from BaseComponent
Defined in BaseComponent:2815

Process the FontStyle property

Parameters :
Name Type Optional
name string No
Returns : any
Private processFontWeight
processFontWeight(name: string)
Inherited from BaseComponent
Defined in BaseComponent:2832

Process the FontWeight property

Parameters :
Name Type Optional
name string No
Returns : any
processHeights
processHeights(name: string)
Inherited from BaseComponent
Defined in BaseComponent:1797

Method to check and set the height of the grid

Parameters :
Name Type Optional
name string No
Returns : void
processIsEnabled
processIsEnabled(name: string)
Inherited from BaseComponent
Defined in BaseComponent:1764

Process changes to IsEnabled property.

Parameters :
Name Type Optional
name string No
Returns : void
processOpacity
processOpacity(name: string)
Inherited from BaseComponent
Defined in BaseComponent:1751

Method to apply the opacity for the component.

Parameters :
Name Type Optional
name string No
Returns : void
processVisibility
processVisibility(name: string)
Inherited from BaseComponent
Defined in BaseComponent:1737

Method to check if the component should be show or hide.

Parameters :
Name Type Optional
name string No
Returns : void
processWidths
processWidths(name: string)
Inherited from BaseComponent
Defined in BaseComponent:1829

Method to check and set the width of the grid

Parameters :
Name Type Optional
name string No
Returns : void
Private processZIndex
processZIndex(name: string)
Inherited from BaseComponent
Defined in BaseComponent:1872

Method to process the ZIndex when set through the model

Parameters :
Name Type Optional
name string No
Returns : void
Private recreateInvalidBindings
recreateInvalidBindings()
Inherited from BaseComponent
Defined in BaseComponent:2756

Execution of removeModelProxyHandlers in a previous instance of the component (that used the same model) could have set some bindings in an invalid state, this will check if some of them has to be recreated

Returns : void
Private registerContextMenuActions
registerContextMenuActions(ctxMenu: ContextMenuManager)
Inherited from BaseComponent
Defined in BaseComponent:2533

Enable the contextMenu actions to be displayed when the user perform an action Creates dinamically a new instance of XamContextMenu to be displayed in the screen

Parameters :
Name Type Optional
ctxMenu ContextMenuManager No
Returns : void
Protected registerDomEventListenerOnElement
registerDomEventListenerOnElement(eventName: string, handler: any)
Inherited from BaseComponent
Defined in BaseComponent:2316

Registers a DOM handler on the current element

Parameters :
Name Type Optional
eventName string No
handler any No
Returns : void
Protected registerHandler
registerHandler(event: SubscriptionEvent<void>, arrowHandler: (s: any,a: any) => void)
Inherited from BaseComponent
Defined in BaseComponent:2298

Register arrow handler into the given SubscriptionEvent with unregister handling when component destroy.

Parameters :
Name Type Optional
event SubscriptionEvent<void> No
arrowHandler function No
Returns : void
Protected registerMouseEvents
registerMouseEvents()
Inherited from BaseComponent
Defined in BaseComponent:2272

Registers mouse events if required

Returns : void
Protected registerObservers
registerObservers(emitter: EventEmitter, model: FrameworkElement, event: SubscriptionEvent<void>)
Inherited from BaseComponent
Defined in BaseComponent:2252

Register observers from the given EventEmitter into the given SubscriptionEvent.

Parameters :
Name Type Optional
emitter EventEmitter<any> No
model FrameworkElement No
event SubscriptionEvent<void> No
Returns : void
Private registerToolTip
registerToolTip(element: ElementRef, tooltip: ToolTipModel)
Inherited from BaseComponent
Defined in BaseComponent:2607

Registers a tooltip to a component

Parameters :
Name Type Optional
element ElementRef<any> No
tooltip ToolTipModel No
Returns : void
Private removeModelProxyHandlers
removeModelProxyHandlers()
Inherited from BaseComponent
Defined in BaseComponent:2738

Clean up the handlers when the component is destroyed

Returns : void
Private setComponentForDirectives
setComponentForDirectives()
Inherited from BaseComponent
Defined in BaseComponent:2512

Sets an internal reference through the element ref to access the component in a directive

Returns : void
Protected setPendingPropertyValue
setPendingPropertyValue(property: string, value: any)
Inherited from BaseComponent
Defined in BaseComponent:2336

Stores the pending property values for instance attach properties. Which will be applied when the model is available

Parameters :
Name Type Optional
property string No
value any No
Returns : void
setupDependencyComponents
setupDependencyComponents(model: FrameworkElement)
Inherited from BaseComponent
Defined in BaseComponent:1612

Adds the references to the dependency components

Parameters :
Name Type Optional
model FrameworkElement No
Returns : void
setupModel
setupModel(model: FrameworkElement)
Inherited from BaseComponent
Defined in BaseComponent:1559

Syncs the modelProxy with model

Parameters :
Name Type Optional
model FrameworkElement No
Returns : void

void
Private syncToolTip
syncToolTip(tooltip: ToolTipModel)
Inherited from BaseComponent
Defined in BaseComponent:2587

Updates the tooltip associated to a component

Parameters :
Name Type Optional
tooltip ToolTipModel No
Returns : void
Private syncValidationError
syncValidationError(name?: string)
Inherited from BaseComponent
Defined in BaseComponent:2766

Syncs validation information with component properties

Parameters :
Name Type Optional
name string Yes
Returns : void
Private tabSelectionSubscription
tabSelectionSubscription()
Inherited from BaseComponent
Defined in BaseComponent:2471

Subscribe to the tabhandler event if Required When the component is inside a tab control it should trigger the load event every time the tab is selected

Returns : void
trackByFn
trackByFn(index: any, item: any)
Inherited from BaseComponent
Defined in BaseComponent:1904

Function used by Angular to track elements in the ngFor directive. We use the GUID property to compare elements.

Parameters :
Name Type Optional Description
index any No
  • index of the array
item any No
  • item of the array
Returns : any

{*} -return the model or object itself
Private unregisterToolTip
unregisterToolTip(element: ElementRef)
Inherited from BaseComponent
Defined in BaseComponent:2719

Unregisters a tooltip to a component

Parameters :
Name Type Optional
element ElementRef<any> No
Returns : void
Private updateSizePropertiesForActualSizeChange
updateSizePropertiesForActualSizeChange(element: Element)
Inherited from BaseComponent
Defined in BaseComponent:2421

Updates the size properties of the component based on the initial size change

Parameters :
Name Type Optional Description
element Element No

HTML element
Returns : void
validatesLoadingFlag
validatesLoadingFlag()
Inherited from BaseComponent
Defined in BaseComponent:1519

Validates loading flag for components outside current tab index TabIndexService should be only tabItem provider, and when currentTabId is different from selectedTab IsFirstTimeLoad is set to false because tabService is going to be one in charge to trigger only one time when tab changes.

Returns : void
widthCalc
widthCalc()
Inherited from BaseComponent
Defined in BaseComponent:1953

Applies the width CSS value

Returns : any
widthDefaultStyle
widthDefaultStyle()
Inherited from BaseComponent
Defined in BaseComponent:1926

Calculates the auto width value

Returns : string

{string}

Properties

activeItemChanged
Type : EventEmitter<literal type>
Default value : new EventEmitter()
Decorators :
@Output()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:104

Event that get triggered when the active item changes
hierachicalItemTemplateInput
Type : HierarchicalDataTemplate
Decorators :
@Input()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:180

If the Xamtree is inherit, this input allow the HierarchicalDataTemplate to work as expected.
hierachicalItemTemplateRef
Type : HierarchicalDataTemplateComponent
Decorators :
@ContentChild(HierarchicalDataTemplateComponent)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:283

Gets HierarchicalDataTemplateComponentif is defined.
isInitialized
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:349

Flag used to know if the component finish the first lifecycle hook.
itemCheckChanged
Type : EventEmitter<literal type>
Default value : new EventEmitter()
Decorators :
@Output()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:124

Event that get triggered when an item is check state is changed
itemDragStart
Type : EventEmitter<literal type>
Default value : new EventEmitter()
Decorators :
@Output()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:144

Events that get triggered when an item is dragged.
itemDropped
Type : EventEmitter<literal type>
Default value : new EventEmitter()
Decorators :
@Output()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:133

Events that get triggered when an item is dropped.
itemExpansionChanged
Type : EventEmitter<literal type>
Default value : new EventEmitter()
Decorators :
@Output()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:113

Event that get triggered when an element expansion occurs
mainContainerRef
Type : ElementRef<HTMLDivElement>
Decorators :
@ViewChild('mainContainerRef')
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:292

Reference to the main div.
model
Type : XamTreeModel
Decorators :
@Input()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:87

Object with properties and events for the XamTree.
Protected modelProxy
Type : XamTreeModel
Default value : ModelProxy.create<XamTreeModel>()
Inherited from BaseComponent
Defined in BaseComponent:410

ModelProxy is a copy of the model, used on the component initial building to prevent crashes with external bindings.
nodeItemsRef
Type : QueryList<XamTreeItemContainerComponent>
Decorators :
@ViewChildren('nodeItem')
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:301

List of node references (Only contents non Hierarchical nodes)
rootCollectionChangedHandler
Type : any
Default value : null
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:331

Change handler for root collection
selectionChanged
Type : EventEmitter<literal type>
Default value : new EventEmitter()
Decorators :
@Output()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:95

Event that get triggered when the selection changes
tdataSource
Type : MatTreeNestedDataSource<any> | MatTreeFlatDataSource<any | any>
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:323

Inner Material tree data source.
templateSource
Type : string
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:316

inner Material tree control
treeControl
Type : FlatTreeControl<any> | NestedTreeControl<any>
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:309

Inner Material flat or nested tree control.
treeItems
Type : any[]
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:342

Array of items to show in the xam-tree component. The data can be obtained from the xamTreeItems input or from the query of the content of type XamItem of the control.
actualSizeCalled
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:481

Flag to know if the Angular event was called
afterContentInitCalled
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:465

Flag to know if the Angular event was called
afterViewCheckedCalled
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:473

Flag to know if the Angular event was called
afterViewInitCalled
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:457

Flag to know if the Angular event was called
Private bindingValidationCallback
Type : function
Inherited from BaseComponent
Defined in BaseComponent:618

Callback for binding validation
bindingValidationError
Type : EventEmitter<any>
Default value : new EventEmitter()
Decorators :
@Output()
Inherited from BaseComponent
Defined in BaseComponent:114

output to emit the new value of the bindingValidationError event
Private cdRefInjection
Type : ChangeDetectorRef
Inherited from BaseComponent
Defined in BaseComponent:659

Change Detector Reference for the component
Private changeDetectionTimer
Type : any
Inherited from BaseComponent
Defined in BaseComponent:668

A timer to debounce changedetection actions
Protected changeDetectorNotifier
Type : ChangeDectionNotifierService
Inherited from BaseComponent
Defined in BaseComponent:576

Change Detection Notifier Service instace.
Private contextMenuUnlistener
Type : function
Inherited from BaseComponent
Defined in BaseComponent:676

Context Menu event unlisten action.
Private ctxMenuInstance
Type : any
Inherited from BaseComponent
Defined in BaseComponent:630

Reference to the ctxMenuInstance
customCssClasses
Type : string
Default value : null
Decorators :
@HostBinding('class')
Inherited from BaseComponent
Defined in BaseComponent:407

Applies custom CSS classes
Private customTooltipInstance
Type : any
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:641

Reference to the custom tooltip instance this is used to render a popup with custom elements used when the content value is not a string
dataGridRowHeight
Type : number
Default value : 22
Decorators :
@Input()
Inherited from BaseComponent
Defined in BaseComponent:507

Represents the row height of both the DataGrid and XamGrid components it affects the css and also an internal function that virtualized data, so do not change directly on css, use this variable instead.
Protected domHandlerUnListeners
Type : Array<void>
Inherited from BaseComponent
Defined in BaseComponent:567

A collection (possible undefined) of DOM unlistener functions . That is, functions to de register handlers
fireLoadedSubscription
Type : Subscription
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:449

Flag to control load event for components inside tab control
focusable
Default value : false
Decorators :
@HostBinding('class.focusable')
Inherited from BaseComponent
Defined in BaseComponent:388

Display if the component is focusable or not
Protected handlersToUnregister
Type : Array<>
Default value : []
Inherited from BaseComponent
Defined in BaseComponent:558

handlers to unregister when the component is destroyed
hasDefinedCursor
Default value : false
Decorators :
@HostBinding('class.hasDefinedCursor')
Inherited from BaseComponent
Defined in BaseComponent:415

Applies Defined Cursor class
hostFontFamily
Type : any
Default value : null
Decorators :
@HostBinding('style.font-family')
Inherited from BaseComponent
Defined in BaseComponent:261

Property use it to apply the host binding for the font-family
hostFontSize
Type : any
Default value : null
Decorators :
@HostBinding('style.font-size')
Inherited from BaseComponent
Defined in BaseComponent:270

Property use it to apply the host binding for the font-size
hostFontStyle
Type : any
Default value : null
Decorators :
@HostBinding('style.font-style')
Inherited from BaseComponent
Defined in BaseComponent:279

Property use it to apply the host binding for the font-style
hostFontStyles
Default value : false
Decorators :
@HostBinding('class.defaultFontStyles')
Inherited from BaseComponent
Defined in BaseComponent:398

Applies default font styles class, used to allow specificity for each control css
hostFontWeight
Type : any
Default value : null
Decorators :
@HostBinding('style.font-weight')
Inherited from BaseComponent
Defined in BaseComponent:288

Property use it to apply the host binding for the font-weight
hostHeight
Type : string
Default value : null
Decorators :
@HostBinding('style.height')
Inherited from BaseComponent
Defined in BaseComponent:218

Property use it to apply the host binding for the height
hostHozCenter
Default value : false
Decorators :
@HostBinding('class.horizontal-center')
Inherited from BaseComponent
Defined in BaseComponent:308

Applies horizontal alignment left class
hostHozLeft
Default value : false
Decorators :
@HostBinding('class.horizontal-left')
Inherited from BaseComponent
Defined in BaseComponent:298

Applies horizontal alignment left class
hostHozRight
Default value : false
Decorators :
@HostBinding('class.horizontal-right')
Inherited from BaseComponent
Defined in BaseComponent:368

Applies horizontal alignment right class
hostHozSelfAlign
Default value : false
Decorators :
@HostBinding('class.horizontal-selfalign')
@Input()
Inherited from BaseComponent
Defined in BaseComponent:380

Applies horizontal selfalign class. Flags indicates when the control should handle its own horizontal alignment and ignore container alignment.
hostHozStretch
Default value : false
Decorators :
@HostBinding('class.horizontal-stretch')
Inherited from BaseComponent
Defined in BaseComponent:358

Applies horizontal alignment stretch class
hostMaxHeight
Type : number
Decorators :
@HostBinding('style.max-height.px')
Inherited from BaseComponent
Defined in BaseComponent:234

Property used to apply the host binding for max-height
hostMaxWidth
Type : number
Decorators :
@HostBinding('style.max-width.px')
Inherited from BaseComponent
Defined in BaseComponent:210

Property used to apply the host binding for max-width
hostMinHeight
Type : number
Decorators :
@HostBinding('style.min-height.px')
Inherited from BaseComponent
Defined in BaseComponent:226

Property used to apply the host binding for min-height
hostMinWidth
Type : number
Decorators :
@HostBinding('style.min-width.px')
Inherited from BaseComponent
Defined in BaseComponent:202

Property used to apply the host binding for min-width
hostOpacity
Type : any
Default value : null
Decorators :
@HostBinding('style.opacity')
Inherited from BaseComponent
Defined in BaseComponent:252

Property use it to apply the host binding for the opacity
hostVerBottom
Default value : false
Decorators :
@HostBinding('class.vertical-bottom')
Inherited from BaseComponent
Defined in BaseComponent:328

Applies vertical alignment bottom class
hostVerCenter
Default value : false
Decorators :
@HostBinding('class.vertical-center')
Inherited from BaseComponent
Defined in BaseComponent:338

Applies vertical alignment center class
hostVerStretch
Default value : false
Decorators :
@HostBinding('class.vertical-stretch')
Inherited from BaseComponent
Defined in BaseComponent:318

Applies horizontal alignment stretch class
hostVerTop
Default value : false
Decorators :
@HostBinding('class.vertical-top')
Inherited from BaseComponent
Defined in BaseComponent:348

Applies vertical alignment top class
hostVisibility
Type : any
Default value : null
Decorators :
@HostBinding('style.display')
Inherited from BaseComponent
Defined in BaseComponent:243

Property use it to apply the host binding for the visibility
hostWidth
Type : string
Default value : null
Decorators :
@HostBinding('style.width')
Inherited from BaseComponent
Defined in BaseComponent:194

Property use it to apply the host binding for the width
hostZIndex
Type : string
Default value : null
Decorators :
@HostBinding('style.z-index')
Inherited from BaseComponent
Defined in BaseComponent:424

Sets the z-index style.
isInternalInherit
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:515

Flag which indicates that the component is an internal use for inheritance
layoutUpdated
Type : EventEmitter<any>
Default value : new EventEmitter()
Decorators :
@Output()
Inherited from BaseComponent
Defined in BaseComponent:140

Output to emit when then component's layout is updated.
loaded
Type : EventEmitter<any>
Default value : new EventEmitter()
Decorators :
@Output()
Inherited from BaseComponent
Defined in BaseComponent:123

Output to emit when then component is loaded.
Protected modelChangeRef
Type : function
Inherited from BaseComponent
Defined in BaseComponent:601

Contains the reference of the function added for handle the model's change
mouseEnter
Type : EventEmitter<literal type>
Default value : new EventEmitter()
Decorators :
@Output()
Inherited from BaseComponent
Defined in BaseComponent:157

Event Emitter. EventEmitter normally called in the mouseEnterHandler.
mouseLeave
Type : EventEmitter<literal type>
Default value : new EventEmitter()
Decorators :
@Output()
Inherited from BaseComponent
Defined in BaseComponent:167

Event Emitter Called in the mouseLeave handler
Private mouseLeaveTooltipUnlistener
Type : function
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:684

Mouse over event for tooltip unlisten action.
mouseLeftButtonUp
Type : EventEmitter<literal type>
Default value : new EventEmitter<any>()
Decorators :
@Output()
Inherited from BaseComponent
Defined in BaseComponent:147

MouseLeftButtonUp event Emitter.
Private mouseMoveTooltipUnlistener
Type : function
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:701

Mouse move event for tooltip unlisten action. This should have a short lifespan, as much as it takes for the tooltip to be shown
Private mouseOverTooltipUnlistener
Type : function
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:692

Mouse over event for tooltip unlisten action.
Protected ngZone
Type : NgZone
Inherited from BaseComponent
Defined in BaseComponent:585

Angular´s NgZone accessor
Protected pendingDependencyPropertyValue
Type : Array<>
Default value : []
Inherited from BaseComponent
Defined in BaseComponent:549

A collection of pending dependency properties values to assign to the model
Protected pendingSetValues
Type : Array<>
Default value : []
Inherited from BaseComponent
Defined in BaseComponent:540

A collection of pending values to assign to the model
Protected renderer2
Type : Renderer2
Inherited from BaseComponent
Defined in BaseComponent:594

Angular´s Renderer2
sizeChanged
Type : EventEmitter<any>
Default value : new EventEmitter()
Decorators :
@Output()
Inherited from BaseComponent
Defined in BaseComponent:132

Output to emit when then component size is changed.
Private sizeChangedPendingTimeout
Type : any
Inherited from BaseComponent
Defined in BaseComponent:610

Timeout id for triggering the sizechanged event
spellCheck
Default value : false
Decorators :
@Input()
Inherited from BaseComponent
Defined in BaseComponent:186

Flag to determinate if the component should do the spell check or not. Default value is false.
staticContent
Type : any
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:432

cache the static content of the control to validate if the current data is not equals.
tabSubscription
Type : Subscription
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:440

TabSelection event subscription
Private tooltipMousePosition
Type : DOMRect
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:710

To track the position of the mouse while the tooltip is being displayed
Private toolTipTimeout
Type : any
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:650

To control the timer to show the tooltip
useCss
Default value : false
Decorators :
@Input()
Inherited from BaseComponent
Defined in BaseComponent:177

Determines if the component uses CSS height/width values, instead of inputs
validationError
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:488

Property to set the validationError class in the component
validationErrorMessage
Type : string
Default value : ''
Inherited from BaseComponent
Defined in BaseComponent:496

Property for specifying validation error message

Accessors

itemsSource
getitemsSource()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:171

Gets the itemsSource collection

Returns : any
setitemsSource(value: any)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:154

Sets the itemssource

Parameters :
Name Type Optional
value any No
Returns : void
hierachicalItemTemplate
gethierachicalItemTemplate()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:204

Gets the HierachicalItemTemplate

Returns : any
sethierachicalItemTemplate(value: any)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:187

Sets the HierachicalItemTemplate

Parameters :
Name Type Optional
value any No
Returns : void
isDraggable
getisDraggable()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:232

Gets IsDraggable property from model.

Returns : boolean
setisDraggable(value: boolean)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:214

Sets IsDraggable property in the model.

Parameters :
Name Type Optional
value boolean No
Returns : void
checkBoxMode
getcheckBoxMode()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:263

Gets the CheckBoxMode property of the XamTree

Returns : string | CheckBoxMode | BindingInfo
setcheckBoxMode(value: string | CheckBoxMode | BindingInfo)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:242

Sets the CheckBoxMode property of the XamTree

Parameters :
Name Type Optional
value string | CheckBoxMode | BindingInfo No
Returns : void
itemTemplate
getitemTemplate()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:272

Gets the ItemTemplate

Returns : any
nodeItemsArray
getnodeItemsArray()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:358

Return an array of XamTreeItemContainerComponent

Returns : XamTreeItemContainerComponent[]
checkBoxVisibility
getcheckBoxVisibility()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:369

Get checkbox visibility input

Returns : any
setcheckBoxVisibility(value: any)
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:379

Sets the checkbox visibility input

Parameters :
Name Type Optional
value any No
Returns : void
renderTree
getrenderTree()
Defined in projects/i-components/src/lib/components/xam-tree-base/xam-tree-base.component.ts:398

Flag to render the tree component

Returns : boolean 
import { FlatTreeControl, NestedTreeControl } from '@angular/cdk/tree';
import {
  AfterContentInit,
  AfterViewInit,
  ChangeDetectorRef,
  Component,
  ContentChild,
  ElementRef,
  EventEmitter,
  Injector,
  Input,
  OnDestroy,
  OnInit,
  Optional,
  Output,
  QueryList,
  ViewChild,
  ViewChildren,
} from '@angular/core';
import {
  MatTreeFlatDataSource,
  MatTreeNestedDataSource,
} from '@angular/material/tree';
import {
  BindingInfo,
  CheckBoxMode,
  DataTemplate,
  DragStartEventArgs,
  DropPosition,
  DroppedEventArgs,
  FontWeights,
  HierarchicalDataTemplate,
  ImageModel,
  ModelProxy,
  SmColor,
  SolidColorBrush,
  XamTreeItemModel,
  XamTreeModel,
  smColorToCssColor,
} from '@mobilize/wms-framework';
import { IChangeCheckboxEventArgs } from 'igniteui-angular';
import { Utils } from '../../utils/utilities';
import { BaseComponent } from '../base/base.component';
import { HierarchicalDataTemplateComponent } from '../hierarchical-data-template/hierarchical-data-template.component';
import { XamTreeItemContainerComponent } from '../xam-tree-item-container/xam-tree-item-container.component';

/**
 * XamTree base component class.
 *
 * @export
 * @class XamTreeBaseComponent
 * @extends {BaseComponent}
 * @implements {OnInit}
 * @implements {OnDestroy}
 * @implements {AfterContentInit}
 * @implements {AfterViewInit}
 */
@Component({
  template: '',
})
export class XamTreeBaseComponent
  extends BaseComponent
  implements OnInit, OnDestroy, AfterContentInit, AfterViewInit
{
  /**
   * Object with properties and events for the XamTree.
   *
   * @type {XamTreeModel}
   * @memberof XamTreeBaseComponent
   */
  @Input() model: XamTreeModel;

  /**
   * Event that get triggered when the selection changes
   *
   * @type {EventEmitter<{ sender: TreeViewModel; e: any }>}
   * @memberof XamTreeBaseComponent
   */
  @Output() selectionChanged: EventEmitter<{ sender: XamTreeModel; e: any }> =
    new EventEmitter();

  /**
   * Event that get triggered when the active item changes
   *
   * @type {EventEmitter<{ sender: TreeViewModel; e: any }>}
   * @memberof XamTreeBaseComponent
   */
  @Output() activeItemChanged: EventEmitter<{ sender: XamTreeModel; e: any }> =
    new EventEmitter();

  /**
   * Event that get triggered when an element expansion occurs
   *
   * @type {EventEmitter<{ sender: TreeViewModel; e: any }>}
   * @memberof XamTreeBaseComponent
   */
  @Output() itemExpansionChanged: EventEmitter<{
    sender: XamTreeModel;
    e: any;
  }> = new EventEmitter();

  /**
   * Event that get triggered when an item is check state is changed
   *
   * @type {EventEmitter<{ sender: TreeViewModel; e: any }>}
   * @memberof XamTreeBaseComponent
   */
  @Output() itemCheckChanged: EventEmitter<{ sender: XamTreeModel; e: any }> =
    new EventEmitter();

  /**
   * Events that get triggered when an item is dropped.
   *
   * @type {EventEmitter<{ sender: TreeViewModel; e: DroppedEventArgs }>}
   * @memberof XamTreeBaseComponent
   */
  @Output() itemDropped: EventEmitter<{
    sender: XamTreeModel;
    e: DroppedEventArgs;
  }> = new EventEmitter();

  /**
   * Events that get triggered when an item is dragged.
   *
   * @type {EventEmitter<{ sender: TreeViewModel; e: DragStartEventArgs }>}
   * @memberof XamTreeBaseComponent
   */
  @Output() itemDragStart: EventEmitter<{
    sender: XamTreeModel;
    e: DragStartEventArgs;
  }> = new EventEmitter();

  /**
   * Sets the itemssource
   *
   * @memberof XamTreeBaseComponent
   */
  @Input() set itemsSource(value: any) {
    /* istanbul ignore else */
    if (
      !this.checkAndRegisterCompatibilityBinding(
        XamTreeModel.ItemsSourceProperty,
        value
      )
    ) {
      this.modelProxy.ItemsSource = value;
    }
  }

  /**
   * Gets the itemsSource collection
   *
   * @returns any
   */
  get itemsSource(): any {
    return this.model.ItemsSource;
  }

  /**
   * If the Xamtree is inherit, this input allow the HierarchicalDataTemplate to work as expected.
   *
   * @memberof XamTreeBaseComponent
   */
  @Input() hierachicalItemTemplateInput: HierarchicalDataTemplate;

  /**
   * Sets the HierachicalItemTemplate
   *
   * @memberof XamTreeBaseComponent
   */
  @Input() set hierachicalItemTemplate(value: any) {
    /* istanbul ignore else */
    if (
      !this.checkAndRegisterCompatibilityBinding(
        XamTreeModel.HierarchicalItemTemplateProperty,
        value
      )
    ) {
      this.modelProxy.HierarchicalItemTemplate = value;
    }
  }

  /**
   * Gets the HierachicalItemTemplate
   *
   * @memberof XamTreeBaseComponent
   */
  get hierachicalItemTemplate(): any {
    return this.model.HierarchicalItemTemplate;
  }

  /**
   * Sets IsDraggable property in the model.
   *
   * @memberof XamTreeBaseComponent
   */
  @Input()
  set isDraggable(value: boolean) {
    /* istanbul ignore else */
    if (
      !this.checkAndRegisterCompatibilityBinding(
        XamTreeModel.IsDraggableProperty,
        value
      ) &&
      typeof value === 'boolean'
    ) {
      this.modelProxy.IsDraggable = value;
    }
  }

  /**
   * Gets IsDraggable property from model.
   *
   * @memberof XamTreeBaseComponent
   */
  get isDraggable(): boolean {
    return this.model.IsDraggable;
  }

  /**
   * Sets the CheckBoxMode property of the XamTree
   *
   * @memberof XamTreeBaseComponent
   */
  @Input()
  set checkBoxMode(value: string | CheckBoxMode | BindingInfo) {
    /* istanbul ignore else */
    if (
      !this.checkAndRegisterCompatibilityBinding(
        XamTreeModel.CheckBoxModeProperty,
        value
      )
    ) {
      if (value === 'Auto' || value === CheckBoxMode.Auto) {
        this.modelProxy.CheckBoxMode = CheckBoxMode.Auto;
      } else {
        this.modelProxy.CheckBoxMode = CheckBoxMode.Manual;
      }
    }
  }

  /**
   * Gets the CheckBoxMode property of the XamTree
   *
   * @memberof XamTreeBaseComponent
   */
  get checkBoxMode(): string | CheckBoxMode | BindingInfo {
    return this.model.CheckBoxMode;
  }

  /**
   * Gets the ItemTemplate
   *
   * @memberof XamTreeBaseComponent
   */
  get itemTemplate(): any {
    return this.model.ItemTemplate?.templateRef;
  }

  /**
   * Gets HierarchicalDataTemplateComponentif is defined.
   *
   * @type {TemplateRef<any>}
   * @memberof XamTreeBaseComponent
   */
  @ContentChild(HierarchicalDataTemplateComponent)
  hierachicalItemTemplateRef: HierarchicalDataTemplateComponent;

  /**
   * Reference to the main div.
   *
   * @type {ElementRef<HTMLDivElement>}
   * @memberof XamTreeBaseComponent
   */
  @ViewChild('mainContainerRef')
  mainContainerRef: ElementRef<HTMLDivElement>;

  /**
   * List of node references (Only contents non Hierarchical nodes)
   *
   * @type {QueryList<XamTreeItemContainerComponent>}
   * @memberof XamTreeBaseComponent
   */
  @ViewChildren('nodeItem')
  nodeItemsRef: QueryList<XamTreeItemContainerComponent>;

  /**
   * Inner Material flat or nested tree control.
   *
   * @type {FlatTreeControl<any>}
   * @memberof XamTreeBaseComponent
   */
  treeControl: FlatTreeControl<any> | NestedTreeControl<any>;

  /**
   * inner Material tree control
   *
   * @memberof XamTreeBaseComponent
   */
  templateSource: string;

  /**
   * Inner Material tree data source.
   *
   * @memberof XamTreeBaseComponent
   */
  tdataSource: MatTreeNestedDataSource<any> | MatTreeFlatDataSource<any, any>;

  /**
   *  Change handler for root collection
   *
   * @type {*}
   * @memberof XamTreeBaseComponent
   */
  rootCollectionChangedHandler: any = null;

  /**
   * Array of items to show in the xam-tree component.
   * The data can be obtained from the xamTreeItems input or from the query
   * of the content of type XamItem
   * of the control.
   *
   * @type {*}
   * @memberof XamTreeBaseComponent
   */
  treeItems: any[];

  /**
   * Flag used to know if the component finish the first lifecycle hook.
   *
   * @memberof XamTreeBaseComponent
   */
  isInitialized = false;

  /**
   * Return an array of XamTreeItemContainerComponent
   *
   * @readonly
   * @type {XamTreeItemContainerComponent[]}
   * @memberof XamTreeBaseComponent
   */
  get nodeItemsArray(): XamTreeItemContainerComponent[] {
    return this.nodeItemsRef?.toArray();
  }

  /**
   *  Get checkbox visibility input
   *
   * @readonly
   * @type {*}
   * @memberof XamTreeBaseComponent
   */
  get checkBoxVisibility(): any {
    return this.modelProxy.CheckboxVisibility;
  }

  /**
   *  Sets the checkbox visibility input
   *
   * @memberof XamTreeBaseComponent
   */
  @Input()
  set checkBoxVisibility(value: any) {
    /* istanbul ignore else */
    if (
      !this.checkAndRegisterCompatibilityBinding(
        XamTreeModel.CheckBoxVisibilityProperty,
        value
      )
    ) {
      this.modelProxy.CheckboxVisibility = value;
    }
  }

  /**
   * Flag to render the tree component
   *
   * @readonly
   * @type {boolean}
   * @memberof XamTreeBaseComponent
   */
  get renderTree(): boolean {
    return this.isInitialized && this.treeItems && this.treeItems.length > 0;
  }

  /**
   * ModelProxy is a copy of the model,
   * used on the component initial building to prevent crashes with external bindings.
   *
   * @protected
   * @type {XamTreeModel}
   * @memberof XamTreeBaseComponent
   */
  protected modelProxy: XamTreeModel = ModelProxy.create<XamTreeModel>();

  /**
   * Creates an instance of XamTreeComponent.
   *
   * @param {XamTreeModel} [injectedModel=null]
   * @memberof XamTreeBaseComponent
   */
  public constructor(
    @Optional() protected injectedModelBase: XamTreeModel = null,
    cdRefBase: ChangeDetectorRef,
    injectorBase: Injector
  ) {
    super(cdRefBase, injectorBase);
    this.model = injectedModelBase;
  }

  /**
   * Angular lifecycle hook
   *
   * @memberof XamTreeBaseComponent
   */
  ngOnInit(): void {
    this.model = this.model || this.injectedModelBase || new XamTreeModel();
    this.setupModel(this.model);
    super.ngOnInit();
    this.registerObservers(
      this.selectionChanged,
      this.model,
      this.model.SelectionChanged
    );
    this.registerObservers(
      this.activeItemChanged,
      this.model,
      this.model.ActiveItemChanged
    );
    this.registerObservers(
      this.itemExpansionChanged,
      this.model,
      this.model.ItemExpansionChanged
    );
    this.registerObservers(
      this.itemCheckChanged,
      this.model,
      this.model.ItemCheckChanged
    );
    this.registerObservers(
      this.itemDragStart,
      this.model,
      this.model.ItemDragStart
    );
    this.registerObservers(
      this.itemDropped,
      this.model,
      this.model.ItemDropped
    );
    this.hasChildHierarchical = this.hasChildHierarchical.bind(this);

    this.registerMouseEvents();
  }

  /**
   * Angular lifecycle hook
   *
   * @memberof XamTreeBaseComponent
   */
  ngAfterContentInit(): void {
    super.ngAfterContentInit();
    this.tdataSource.data = [...this.model.items];
    this.syncHierachicalItemTemplate();
    const rootCollection = this.model.items.asINotifyCollectionChanged();
    this.rootCollectionChangedHandler =
      rootCollection.CollectionChanged.addHandler(() => {
        if (this.hierachicalItemTemplate) {
          /* istanbul ignore next */
          this.setupData();
        } else {
          this.tdataSource.data = [...this.model.items];
        }
      });
  }

  /**
   * Angular lifecycle hook
   *
   * @memberof XamTreeBaseComponent
   */
  ngAfterViewInit(): void {
    super.ngAfterViewInit();
    setTimeout(() => {
      if (this.hierachicalItemTemplateInput) {
        this.model.HierarchicalItemTemplate = this.hierachicalItemTemplateInput;
        this.model.ItemTemplate =
          this.hierachicalItemTemplateInput.ItemTemplate;
        this.setupData();
      }
      this.isInitialized = true;
      this.expandInitialElementsIfRequired();
      this.detectChangesAction();
      this.restoreScrollPosition();
    }, 0);
  }

  /**
   * Angular lifecycle hook
   *
   * @memberof XamTreeBaseComponent
   */
  ngOnDestroy() {
    super.ngOnDestroy();
    this.model?.ScrollItemIntoView.removeHandler(this.scrollIntoNode, this);
    const rootCollection = this.model?.items.asINotifyCollectionChanged();
    /* istanbul ignore else */
    if (this.rootCollectionChangedHandler) {
      rootCollection.CollectionChanged.removeHandler(
        this.rootCollectionChangedHandler
      );
    }
  }

  /**
   * Selects a node
   *
   * @param {*} node
   * @memberof XamTreeComponent
   */
  select(node: any) {
    this.model.select(node);
    this.model.ActiveItem = node;
    this.detectChangesAction();
  }

  /**
   * Toggles the expanded state of the given node.
   *
   * @param {*} node
   * @memberof XamTreeBaseComponent
   */
  toggleExpandedState(event: MouseEvent, node: any, shouldPropagate: boolean) {
    if (shouldPropagate) {
      event.stopPropagation();
    }
    node.IsExpanded = !node.IsExpanded;
    if (node.IsExpanded) {
      this.treeControl.expand(node);
    } else {
      this.treeControl.collapse(node);
    }
  }

  /**
   * Checkbox change handler.
   *
   * @param {IChangeCheckboxEventArgs} args
   * @param {XamTreeItemModel} node
   * @memberof XamTreeBaseComponent
   */
  checkboxChangeHandler(
    args: IChangeCheckboxEventArgs,
    node: XamTreeItemModel
  ): void {
    node.IsChecked = args.checked;
    this.model.ActiveItem = node;
    this.detectChangesAction();
  }

  /**
   *  Gets the CSS color for the given model value
   *
   * @param {*} modelColor
   * @return {*}
   * @memberof XamTreeBaseComponent
   */
  getColor(modelColor: any) {
    if (modelColor != null && modelColor instanceof SolidColorBrush) {
      return smColorToCssColor(modelColor.Color);
    } else if (modelColor instanceof SmColor) {
      return smColorToCssColor(modelColor);
    } else {
      return 'inherit';
    }
  }

  /**
   * Expand nodes at another level
   *
   * @private
   * @memberof XamTreeBaseComponent
   */
  getItemFontWeight(value: number) {
    return Utils.getFontWeight(FontWeights[value]);
  }

  /**
   *  Model changed handler adding scenario for refreshing the tree on node change
   *
   * @param {string} [name]
   * @memberof XamTreeBaseComponent
   */
  modelChangeHandler(name?: string, extraArg?: unknown) {
    if (name === 'treeRefresh') {
      this.refresh();
    } else if (name === 'ExpandNode' && extraArg) {
      this.treeControl.expand(extraArg);
    } else if (name === 'CollapseNode' && extraArg) {
      this.treeControl.collapse(extraArg);
    }
    super.modelChangeHandler(name);
  }

  /**
   *  Refresh the tree
   *
   * @memberof XamTreeBaseComponent
   */
  /* istanbul ignore next */
  refresh() {}

  /**
   * Verifies if the given node has children
   *
   * @param {*} level
   * @param {*} node
   * @return {*}
   * @memberof XamTreeBaseComponent
   */
  /* istanbul ignore next */
  hasChild(level, node) {}

  /**
   * Verifies if the given node has children
   *
   * @param {any} level
   * @param {any} node
   * @return {any}
   * @memberof XamTreeBaseComponent
   */
  /* istanbul ignore next */
  hasChildHierarchical(level: any, node: any): any {}

  /**
   *  Expands initial nodes if required
   *
   * @private
   * @memberof XamTreeBaseComponent
   */
  expandInitialElementsIfRequired() {
    const nodesToCheck = this.model.items;
    this.expandingNodes(nodesToCheck);
  }

  /**
   *  Syncs static hierachicalItemTemplate with the model property
   *
   * @private
   * @memberof XamTreeBaseComponent
   */
  syncHierachicalItemTemplate() {
    // Syncs ItemTemplate
    /* istanbul ignore else */
    if (this.hierachicalItemTemplateRef?.itemTemplate?.toArray().length > 0) {
      const hierarchical = new HierarchicalDataTemplate();
      const template = new DataTemplate(
        this.hierachicalItemTemplateRef.itemTemplate.toArray()[0]
      );
      const itemsSource = this.hierachicalItemTemplateRef.itemsSource;
      this.templateSource =
        this.hierachicalItemTemplateRef.itemsSource?.bindingPath;
      hierarchical.ItemTemplate = template;
      hierarchical.ItemSource = itemsSource;
      this.model.HierarchicalItemTemplate = hierarchical;
      this.model.ItemTemplate = template;
      this.setupData();
    }
  }

  /**
   * Function that setup the data in the tree datasource
   *
   * @memberof XamTreeBaseComponent
   */
  /* istanbul ignore next */
  setupData(): void {}

  /**
   *  get image URL
   *
   * @param {*} type
   * @return {*}
   * @memberof XamTreeBaseComponent
   */
  getImagePath(type: any): any {
    if (type instanceof ImageModel) {
      return this.imageToPath(type.Source.UriSource);
    } else {
      return this.imageToPath(type);
    }
  }

  /**
   * Item drag started event handler
   *
   * @param {DragEvent} event
   * @memberof XamTreeBaseComponent
   */
  dragStartHandler(event: DragEvent): void {
    const dragEvent = new DragStartEventArgs();
    dragEvent.Cancel = false;
    dragEvent.DragContent = null;
    /* istanbul ignore next */
    dragEvent.SourceItem = event['dragData']?.source;
    const params = { sender: this.model, e: dragEvent };
    this.model.ItemDragStart.fire([params.sender, params.e]);
  }

  /**
   * Dropped item event handler
   *
   * @param {DragEvent} event
   * @return {*}  {void}
   * @memberof XamTreeBaseComponent
   */
  dropHandler(event: DragEvent): void {
    const dragData = event['dragData'];
    const dropData = event['dropData'];
    if (
      dragData == null ||
      dropData == null ||
      this.isSelfOrChildren(dragData.source, dropData.target)
    ) {
      return;
    }
    const droppedEvent = new DroppedEventArgs();
    droppedEvent.DropPosition = DropPosition[dropData.position as string];
    droppedEvent.SourceItem = dragData.source;
    droppedEvent.TargetItem = dropData.target;
    const params = { sender: this.model, e: droppedEvent };
    this.model.ItemDropped.fire([params.sender, params.e]);
  }

  /**
   * Check if son is under parent (in any level).
   *
   * @param {XamTreeItemModel} parent
   * @param {XamTreeItemModel} son
   * @return {*}  {boolean}
   * @memberof XamTreeBaseComponent
   */
  isSelfOrChildren(parent: XamTreeItemModel, son: XamTreeItemModel): boolean {
    if (son == null) {
      return false;
    }
    if (parent === son || parent === son.ParentItem) {
      return true;
    }
    return this.isSelfOrChildren(parent, son.ParentItem);
  }

  /**
   * Scrolls into a given node.
   *
   * @param {any} nodeToFind
   * @memberof XamTreeBaseComponent
   */
  scrollIntoNode(nodeToFind: any): void {
    setTimeout(() => {
      const node = this.nodeItemsArray.find(
        (item) => item.model === nodeToFind
      );
      node?.elementRef.nativeElement.scrollIntoView({ block: 'end' });
    }, 5);
  }

  /**
   * Restore the last scrolled position.
   *
   * @memberof XamTreeBaseComponent
   */
  /* istanbul ignore next */
  restoreScrollPosition(): void {}

  /**
   * Handler executed whenever the main container is scrolled.
   *
   * @memberof XamTreeBaseComponent
   */
  scrollHandler(): void {
    this.model.LastScrollPosition =
      this.mainContainerRef.nativeElement.scrollTop;
  }

  /**
   * Expand nodes at another level
   *
   * @private
   * @param {Iterable<any>} nodesToCheck
   * @memberof XamTreeBaseComponent
   */
  protected expandingNodes(nodesToCheck: Iterable<any>) {
    for (const node of nodesToCheck) {
      if (node.IsExpanded) {
        this.treeControl.expand(node);
      }
      if (node.items?.count > 0) {
        this.expandingNodes(node.items);
      }
    }
  }

  /**
   * Returns true if the node is the activeItem.
   *
   * @param {*} node
   * @return {*}  {boolean}
   * @memberof XamTreeBaseComponent
   */
  isNodeActive(node: any): boolean {
    return node?.XamTree?.ActiveItem === node;
  }
}
Legend
Html element
Component
Html element with directive

result-matching ""

    No results matching ""