projects/i-components/src/lib/components/tree-view/tree-view.component.ts
TreeViewComponent definition
OnInit
AfterViewInit
OnDestroy
| changeDetection | ChangeDetectionStrategy.OnPush |
| selector | wm-tree-view |
| styleUrls | ./tree-view.component.scss |
| templateUrl | ./tree-view.component.html |
Public
constructor(injectedModel: TreeViewModel, cd: ChangeDetectorRef, injector: Injector)
|
||||||||||||
|
Creates an instance of TreeViewComponent.
Parameters :
|
| background | |
|
Property used to save the background. |
|
| borderBrush | |
|
Sets the border color for the TreeView. |
|
| borderThickness | |
Type : string
|
|
|
Property used to saved the Border thickness. |
|
| itemsSource | |
Type : any
|
|
|
Sets the itemSource property of the tree |
|
| itemTemplate | |
|
Sets ItemTemplate property in the TreeViewModel |
|
| model | |
Type : TreeViewModel
|
|
|
Object with treeview properties and events |
|
| controlTemplate | |
Type : any
|
|
|
Inherited from
BaseComponent
|
|
|
Defined in
BaseComponent:1197
|
|
|
Sets the controlTemplate Input property for changing the model's |
|
| 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 |
|
| 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... |
|
| selectedItemChanged | |
Type : EventEmitter<literal type>
|
|
|
Event that get triggered when the itemSelected 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. |
|
| 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. |
| Private executeSetupDataForHierarchicalDataTemplate |
executeSetupDataForHierarchicalDataTemplate()
|
|
Executest the data setup for the HierarchicalDataTemplate
Returns :
void
|
| Private expandingNodes | ||||||
expandingNodes(nodesToCheck: Iterable<any>)
|
||||||
|
Expand nodes at another level
Parameters :
Returns :
void
|
| expandInitialElementsIfRequired |
expandInitialElementsIfRequired()
|
|
Expands initial nodes if required
Returns :
void
|
| getFormattedBorderWidth |
getFormattedBorderWidth()
|
|
Returns :
string
|
| isItemSelected | ||||||
isItemSelected(node)
|
||||||
|
returns a string with the class for the isSelected state
Parameters :
Returns :
string
{string} class to apply in css |
| itemsCollectionChangeHandler | ||||||
itemsCollectionChangeHandler(val: any)
|
||||||
|
Used to force update into mat-tree component See issue-thread at https://github.com/angular/components/issues/11984
Parameters :
Returns :
void
|
| modelChangeHandler | ||||||||||||
modelChangeHandler(name?: string, extraArg?: unknown)
|
||||||||||||
|
Inherited from
BaseComponent
|
||||||||||||
|
Defined in
BaseComponent:529
|
||||||||||||
|
Method to handle the model's change
Parameters :
Returns :
void
|
| ngAfterViewInit |
ngAfterViewInit()
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:450
|
|
Angular Lifecycle
Returns :
void
|
| ngOnDestroy |
ngOnDestroy()
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:503
|
|
Angular Lifecycle
Returns :
void
|
| ngOnInit |
ngOnInit()
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:431
|
|
Angular Lifecycle
Returns :
void
|
| nodeClick | ||||||
nodeClick(node: any)
|
||||||
|
Handles the click event in the buttons to get the node that got selected
Parameters :
Returns :
void
|
| refresh |
refresh()
|
|
Refresh the tree
Returns :
void
|
| Private setExpandedProp |
setExpandedProp()
|
|
Validates if the isExpanded property is true and then sets the treeview to be expanded by default
Returns :
void
|
| setupData |
setupData()
|
|
Method that setup the data in the datasource
Returns :
void
|
| setupDataFromItems |
setupDataFromItems()
|
|
Create the tree datasource from the items collection
Returns :
void
|
| setupDataFromItemsForHierarchicalDataTemplate |
setupDataFromItemsForHierarchicalDataTemplate()
|
|
Create the tree datasource from the items collection
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 :
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 :
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 :
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 :
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.
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 :
Returns :
any
|
| getTargetValue | ||||||
getTargetValue(e: Event)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:2239
|
||||||
|
Returns the value from a $event
Parameters :
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 :
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 :
Returns :
any
|
| loadStaticItems | ||||||||||||
loadStaticItems(staticItems: any, itemsCollection: any)
|
||||||||||||
|
Inherited from
BaseComponent
|
||||||||||||
|
Defined in
BaseComponent:1634
|
||||||||||||
|
Parameters :
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 :
Returns :
void
|
| mouseLeaveHandler | ||||||||
mouseLeaveHandler(event: any)
|
||||||||
|
Inherited from
BaseComponent
|
||||||||
|
Defined in
BaseComponent:2001
|
||||||||
|
Event Handler for when the mouse enter the Image component.
Parameters :
Returns :
void
|
| Public ngAfterContentChecked |
ngAfterContentChecked()
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:867
|
|
Angular Lifecycle Hooks
Returns :
void
|
| Public ngAfterContentInit |
ngAfterContentInit()
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:857
|
|
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 :
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 :
Returns :
void
{void} |
| processCursor | ||||||
processCursor(name: string)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:1850
|
||||||
|
Method to set the cursor style of the component
Parameters :
Returns :
void
|
| processCustomCssClasses | ||||||
processCustomCssClasses(name: string)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:1723
|
||||||
|
Method to set custom CSS Clases
Parameters :
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 :
Returns :
void
|
| Private processFontFamily | ||||||
processFontFamily(name: string)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:2784
|
||||||
|
Process the FontFamily property
Parameters :
Returns :
any
|
| processFonts | ||||||
processFonts(name: string)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:1778
|
||||||
|
Method to apply the font styles for the component.
Parameters :
Returns :
void
|
| Private processFontSize | ||||||
processFontSize(name: string)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:2798
|
||||||
|
Process the FontSize property
Parameters :
Returns :
any
|
| Private processFontStyle | ||||||
processFontStyle(name: string)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:2815
|
||||||
|
Process the FontStyle property
Parameters :
Returns :
any
|
| Private processFontWeight | ||||||
processFontWeight(name: string)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:2832
|
||||||
|
Process the FontWeight property
Parameters :
Returns :
any
|
| processHeights | ||||||
processHeights(name: string)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:1797
|
||||||
|
Method to check and set the height of the grid
Parameters :
Returns :
void
|
| processIsEnabled | ||||||
processIsEnabled(name: string)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:1764
|
||||||
|
Process changes to
Parameters :
Returns :
void
|
| processOpacity | ||||||
processOpacity(name: string)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:1751
|
||||||
|
Method to apply the opacity for the component.
Parameters :
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 :
Returns :
void
|
| processWidths | ||||||
processWidths(name: string)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:1829
|
||||||
|
Method to check and set the width of the grid
Parameters :
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 :
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 :
Returns :
void
|
| Protected registerDomEventListenerOnElement |
registerDomEventListenerOnElement(eventName: string, handler: any)
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:2316
|
|
Registers a DOM handler on the current element
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
Parameters :
Returns :
void
|
| Protected registerMouseEvents |
registerMouseEvents()
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:2272
|
|
Registers mouse events if required
Returns :
void
|
| Protected registerObservers | ||||||||||||
registerObservers(emitter: EventEmitter
|
||||||||||||
|
Inherited from
BaseComponent
|
||||||||||||
|
Defined in
BaseComponent:2252
|
||||||||||||
|
Register observers from the given
Parameters :
Returns :
void
|
| Private registerToolTip | |||||||||
registerToolTip(element: ElementRef
|
|||||||||
|
Inherited from
BaseComponent
|
|||||||||
|
Defined in
BaseComponent:2607
|
|||||||||
|
Registers a tooltip to a component
Parameters :
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
Returns :
void
|
| setupDependencyComponents | ||||||
setupDependencyComponents(model: FrameworkElement)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:1612
|
||||||
|
Adds the references to the dependency components
Parameters :
Returns :
void
|
| setupModel | ||||||
setupModel(model: FrameworkElement)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:1559
|
||||||
|
Syncs the modelProxy with model
Parameters :
Returns :
void
void |
| Private syncToolTip | ||||||
syncToolTip(tooltip: ToolTipModel)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:2587
|
||||||
|
Updates the tooltip associated to a component
Parameters :
Returns :
void
|
| Private syncValidationError | ||||||
syncValidationError(name?: string)
|
||||||
|
Inherited from
BaseComponent
|
||||||
|
Defined in
BaseComponent:2766
|
||||||
|
Syncs validation information with component properties
Parameters :
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 :
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 :
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 :
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} |
| Public _transformer | |||
Default value : () => {...}
|
|||
|
Object that allows the transformation to treecontrol |
|||
|
Parameters :
|
| Public _transformerFromItems |
Default value : () => {...}
|
| Public _transformerFromItemsForHierarchicalDataTemplate |
Default value : () => {...}
|
| Public borderWidth |
Type : string
|
|
Property for the borderThickness format. |
| Public dataSource |
Type : MatTreeFlatDataSource<any | any | any>
|
|
Object needed to be passed to the mat tree component |
| Private expandTimeOut |
Type : any
|
Default value : null
|
|
Timeout to check for expanded elements |
| hasChild | |||
Default value : () => {...}
|
|||
|
Allow to check if a node has childs |
|||
|
Parameters :
|
| internalHierarchicalTemplate |
Type : HierarchicalDataTemplateComponent
|
Decorators :
@ContentChild(HierarchicalDataTemplateComponent)
|
|
Template that will be used as every item template |
| Private isHierarchicalDataItems |
Default value : false
|
|
Flag to know if the tree has HierarchicalDataTemplate |
| isInitialized |
Default value : false
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:337
|
|
Flag to know if the component is ready to render |
| Private itemsSubscription |
Type : any
|
|
Keeps the reference to the subscription handler |
| Public model |
Type : TreeViewModel
|
Decorators :
@Input()
|
|
Object with treeview properties and events |
| Protected modelProxy |
Type : TreeViewModel
|
Default value : ModelProxy.create<TreeViewModel>()
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:346
|
|
ModelProxy is copy of model, used on the component initial building to prevent crashes with external bindings. |
| nodeIndentation |
Type : number | string
|
Default value : 15
|
|
Intentation to use for the nodes |
| refreshTimeout |
Type : any
|
Default value : null
|
|
Tree refresh timeout(id) |
| selectedItemChanged |
Type : EventEmitter<literal type>
|
Default value : new EventEmitter()
|
Decorators :
@Output()
|
|
Event that get triggered when the itemSelected changes |
| Public templateSource |
Type : string
|
|
Property that allows the search of children in the itemsource |
| Public treeControl |
Type : FlatTreeControl<any>
|
Default value : new FlatTreeControl<any>(
(node) => node.level,
(node) => node.expandable
)
|
|
Tree control object that allows the tree to be expandable |
| Public treeFlattener |
Type : MatTreeFlattener<any | any | any>
|
|
Tree flattener objet that allows the source to be in one level |
| 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')
|
|
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 |
| template |
gettemplate()
|
|
Template validation
Returns :
any
|
| background | ||||||
getbackground()
|
||||||
|
Gets the Background from the model.
Returns :
string | BindingInfo
|
||||||
setbackground(value: string | BindingInfo)
|
||||||
|
Property used to save the background.
Parameters :
Returns :
void
|
| borderBrush | ||||||
getborderBrush()
|
||||||
|
Gets the border color from the TreeView.
Returns :
string | BindingInfo
|
||||||
setborderBrush(value: BindingInfo | string)
|
||||||
|
Sets the border color for the TreeView.
Parameters :
Returns :
void
|
| borderThickness | ||||||
getborderThickness()
|
||||||
|
Gets the border width from the TreeViewModel.
Returns :
string
|
||||||
setborderThickness(value: string)
|
||||||
|
Property used to saved the Border thickness.
Parameters :
Returns :
void
|
| itemsSource | ||||||
getitemsSource()
|
||||||
|
Gets the ItemsSource property for the TreeView
Returns :
any
|
||||||
setitemsSource(value: any)
|
||||||
|
Sets the itemSource property of the tree
Parameters :
Returns :
void
|
| itemTemplate | ||||||
getitemTemplate()
|
||||||
|
Returns the ItemTemplate
Returns :
TemplateRef<any>
|
||||||
setitemTemplate(value: TemplateRef
|
||||||
|
Sets ItemTemplate property in the TreeViewModel
Parameters :
Returns :
void
|
import { FlatTreeControl } from '@angular/cdk/tree';
import {
AfterViewInit,
ChangeDetectionStrategy,
ChangeDetectorRef,
Component,
ContentChild,
EventEmitter,
Injector,
Input,
OnDestroy,
OnInit,
Optional,
Output,
TemplateRef,
} from '@angular/core';
import {
MatTreeFlatDataSource,
MatTreeFlattener,
} from '@angular/material/tree';
import {
AngularComponentId,
BindingInfo,
CollectionChangeAction,
CollectionChangeInfo,
ComponentId,
DataTemplate,
HierarchicalDataTemplate,
ItemsCollectionModel,
iuAny,
ModelProxy,
RuntimeStyleInfo,
Setter,
smColorToCssColor,
SolidColorBrush,
ThicknessModel,
TreeViewModel,
} from '@mobilize/wms-framework';
import { Utils } from '../../utils';
import { BaseComponent } from '../base/base.component';
import { HierarchicalDataTemplateComponent } from '../hierarchical-data-template/hierarchical-data-template.component';
/**
* TreeViewComponent definition
*
* @export
* @class TreeViewComponent
* @extends {BaseComponent}
* @implements {OnInit}
* @implements {AfterViewInit}
*/
@Component({
selector: 'wm-tree-view',
templateUrl: './tree-view.component.html',
styleUrls: ['./tree-view.component.scss'],
changeDetection: ChangeDetectionStrategy.OnPush,
})
@ComponentId([AngularComponentId.treeView])
export class TreeViewComponent
extends BaseComponent
implements OnInit, AfterViewInit, OnDestroy
{
/**
* Intentation to use for the nodes
*
* @type {(number|string)}
* @memberof TreeViewComponent
*/
nodeIndentation: number | string = 15;
/**
* Template that will be used as every item template
*
* @type {HierarchicalDataTemplateComponent}
* @memberof TreeViewComponent
*/
@ContentChild(HierarchicalDataTemplateComponent)
internalHierarchicalTemplate: HierarchicalDataTemplateComponent;
/**
* Template validation
*
* @memberof TreeViewComponent
*/
get template(): any {
return this.internalHierarchicalTemplate ?? this.modelProxy.ItemTemplate;
}
/**
* Property used to save the background.
*
* @memberof TreeViewComponent
*/
@Input()
set background(value: string | BindingInfo) {
if (
!this.checkAndRegisterCompatibilityBinding(
TreeViewModel.BackgroundProperty,
value
)
) {
this.modelProxy.Background = Utils.createSolidBrush(value);
}
}
/**
* Gets the Background from the model.
*
* @readonly
* @type {(string|BindingInfo)}
* @memberof TreeViewComponent
*/
get background(): string | BindingInfo {
/* istanbul ignore else */
if (this.model.Background) {
return smColorToCssColor(
(this.model.Background as SolidColorBrush).Color
);
}
return 'white';
}
/**
* Sets the border color for the TreeView.
*
* @memberof TreeViewComponent
*/
@Input()
set borderBrush(value: BindingInfo | string) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
TreeViewModel.BorderBrushProperty,
value
)
) {
this.modelProxy.BorderBrush = Utils.createSolidBrush(value);
}
}
/**
* Gets the border color from the TreeView.
*
* @readonly
* @type {(string|BindingInfo)}
* @memberof TreeViewComponent
*/
get borderBrush(): string | BindingInfo {
if (
this.model.BorderBrush != null &&
this.model.BorderBrush instanceof SolidColorBrush
) {
return smColorToCssColor(this.model.BorderBrush.Color);
}
return 'black';
}
/**
* Property used to saved the Border thickness.
*
* @memberof TreeViewComponent
*/
@Input()
set borderThickness(value: string) {
if (
!this.checkAndRegisterCompatibilityBinding(
TreeViewModel.BorderThicknessProperty,
value
)
) {
/* istanbul ignore else */
if (value) {
this.modelProxy.BorderThickness = ThicknessModel.parse(value);
}
}
}
/**
* Gets the border width from the TreeViewModel.
*
* @type {string}
* @memberof TreeViewComponent
*/
get borderThickness(): string {
return this.model.BorderThickness.toString();
}
/**
* Sets the itemSource property of the tree
*
* @type {*}
* @memberof TreeViewComponent
*/
@Input()
set itemsSource(value: any) {
if (
!this.checkAndRegisterCompatibilityBinding(
TreeViewModel.ItemsSourceProperty,
value
)
) {
this.modelProxy.ItemsSource = value;
this.setupData();
}
}
/**
* Gets the ItemsSource property for the TreeView
*
* @readonly
* @type {*}
* @memberof TreeViewComponent
*/
get itemsSource(): any {
return this.model.ItemsSource;
}
/**
* Sets ItemTemplate property in the TreeViewModel
*
* @type {TemplateRef<any>} Angular TemplateRef
* @memberof TreeViewComponent
*/
@Input()
set itemTemplate(value: TemplateRef<any>) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
TreeViewModel.ItemTemplateProperty,
value
)
) {
this.modelProxy.ItemTemplate = value;
}
}
/**
* Returns the ItemTemplate
*
* @returns TemplateRef
* @memberof TreeViewComponent
*/
get itemTemplate(): TemplateRef<any> {
return this.model.ItemTemplate;
}
/**
* Object with treeview properties and events
*
* @type {TreeViewModel}
* @memberof TreeViewComponent
*/
@Input()
public model: TreeViewModel;
/**
* Event that get triggered when the itemSelected changes
*
* @type {EventEmitter<{ sender: TreeViewModel; e: any }>}
* @memberof TreeViewComponent
*/
@Output() selectedItemChanged: EventEmitter<{
sender: TreeViewModel;
e: any;
}> = new EventEmitter();
/**
* Property for the borderThickness format.
*
* @type {string}
* @memberof TreeViewComponent
*/
public borderWidth: string;
/**
* Tree control object that allows the tree to be expandable
*
* @memberof TreeViewComponent
*/
public treeControl: FlatTreeControl<any> = new FlatTreeControl<any>(
(node) => node.level,
(node) => node.expandable
);
/**
* Tree flattener objet that allows the source to be in one level
*
* @memberof TreeViewComponent
*/
public treeFlattener: MatTreeFlattener<any, any, any>;
/**
* Object needed to be passed to the mat tree component
*
* @memberof TreeViewComponent
*/
public dataSource: MatTreeFlatDataSource<any, any, any>;
/**
* Tree refresh timeout(id)
*
* @type {*}
* @memberof XamTreeComponent
*/
refreshTimeout: any = null;
/**
* Property that allows the search of children in the itemsource
*
* @type {string}
* @memberof TreeViewComponent
*/
public templateSource: string;
/**
* Flag to know if the component is ready to render
*
* @type {boolean}
* @memberof TreeViewComponent
*/
isInitialized = false;
/**
* ModelProxy is copy of model, used on the component initial building to prevent crashes with external bindings.
*
* @protected
* @type {TreeViewModel}
* @memberof TreeViewComponent
*/
protected modelProxy: TreeViewModel = ModelProxy.create<TreeViewModel>();
/**
* Keeps the reference to the subscription handler
*
* @private
* @type {*}
* @memberof TreeViewComponent
*/
private itemsSubscription: any;
/**
* Timeout to check for expanded elements
*
* @private
* @type {*}
* @memberof TreeViewComponent
*/
private expandTimeOut: any = null;
/**
* Flag to know if the tree has HierarchicalDataTemplate
*
* @private
* @type {*}
* @memberof TreeViewComponent
*/
private isHierarchicalDataItems = false;
/**
* Creates an instance of TreeViewComponent.
*
* @param {TreeViewModel} injectedModel
* @param {ChangeDetectorRef} cd
* @param {Injector} injector
* @memberof TreeViewComponent
*/
public constructor(
@Optional() private injectedModel: TreeViewModel,
private cd: ChangeDetectorRef,
private injector: Injector
) {
super(cd, injector);
this.model = injectedModel;
}
/**
* Object that allows the transformation to treecontrol
*
* @public
* @param {*} node
* @param {number} level
* @memberof TreeViewComponent
*/
public _transformer = (node: any, level: number) =>
Object.assign(node, {
expandable: () => !!node.Children && node.Children.count > 0,
level,
isSelected: node.IsSelected,
});
public _transformerFromItems = (node: any, level: number) =>
Object.assign(node, {
expandable: () => !!node.items && node.items.internalArray.length > 0,
level,
isSelected: node.IsSelected,
});
public _transformerFromItemsForHierarchicalDataTemplate = (
node: any,
level: number
) =>
Object.assign(node, {
expandable: () =>
!!node[this.templateSource] &&
node[this.templateSource].internalArray.length > 0,
level,
isSelected: node.IsSelected,
});
/**
* Angular Lifecycle
*
* @memberof TreeViewComponent
*/
ngOnInit(): void {
this.model = this.model || this.injectedModel || new TreeViewModel();
this.setupModel(this.model);
super.ngOnInit();
this.borderWidth = this.getFormattedBorderWidth();
this.handlersToUnregister.push([
this.model.SelectedItemChanged,
this.model.SelectedItemChanged.addHandler((e, a) =>
this.selectedItemChanged.emit({ sender: e, e: a })
),
]);
this.expandInitialElementsIfRequired();
}
/**
* Angular Lifecycle
*
* @memberof TreeViewComponent
*/
ngAfterViewInit(): void {
super.ngAfterViewInit();
setTimeout(() => {
this.isInitialized = true;
if (
this.template?.itemTemplate?.toArray().length > 0 &&
!(this.template instanceof HierarchicalDataTemplateComponent)
) {
this.model.ItemTemplate = new DataTemplate(
this.template.itemTemplate.toArray()[0]
);
this.templateSource = this.template.itemsSource.bindingPath;
this.setupData();
} else if (
this.template?.ItemTemplate !== undefined ||
this.template instanceof HierarchicalDataTemplate ||
this.template instanceof HierarchicalDataTemplateComponent
) {
this.executeSetupDataForHierarchicalDataTemplate();
} else {
this.setupDataFromItems();
this.itemsSubscription = this.model.items?.change?.addHandler(
this.itemsCollectionChangeHandler.bind(this)
);
}
this.detectChangesAction();
}, 0);
}
/**
* Executest the data setup for the HierarchicalDataTemplate
*
* @memberof TreeViewComponent
*/
private executeSetupDataForHierarchicalDataTemplate() {
this.isHierarchicalDataItems = true;
if (this.template.ItemSource?.Path) {
this.templateSource = this.template.ItemSource.Path.path;
} else {
this.model.ItemTemplate = new DataTemplate(
this.template.itemTemplate.toArray()[0]
);
this.templateSource = this.template.itemsSource.bindingPath;
}
this.setupDataFromItemsForHierarchicalDataTemplate();
this.setExpandedProp();
}
/**
* Angular Lifecycle
*
* @memberof TreeViewComponent
*/
ngOnDestroy(): void {
super.ngOnDestroy();
this.model?.items?.change?.removeHandler(this.itemsSubscription);
this._transformer = null;
this._transformerFromItems = null;
this._transformerFromItemsForHierarchicalDataTemplate = null;
this.treeFlattener = null;
}
/**
* Used to force update into mat-tree component
* See issue-thread at https://github.com/angular/components/issues/11984
*
* @param {prop} val
* @memberof TreeViewComponent
*/
itemsCollectionChangeHandler(val: any): void {
this.setupDataFromItems();
}
/**
*Method to handle the model's change
*
* @param { string } name - property name that change
* @memberof TreeViewComponent
*/
modelChangeHandler(name?: string, extraArg?: unknown) {
super.modelChangeHandler(name);
if (name === 'treeViewRefresh') {
this.refresh();
} else if (name === 'BorderThickness') {
this.borderWidth = this.getFormattedBorderWidth();
} else if (name === 'ExpandNode' && extraArg) {
if (this.isHierarchicalDataItems) {
this.setupDataFromItemsForHierarchicalDataTemplate();
}
this.treeControl.expand(extraArg);
} else if (name === 'CollapseNode' && extraArg) {
this.treeControl.collapse(extraArg);
}
}
/**
* Refresh the tree
*
* @memberof TreeViewComponent
*/
refresh() {
/* istanbul ignore else */
if (this.refreshTimeout === null) {
this.refreshTimeout = setTimeout(() => {
const oldData = this.dataSource?.data;
this.dataSource = new MatTreeFlatDataSource(
this.treeControl,
this.treeFlattener
);
if (oldData) {
this.dataSource.data = oldData;
}
this.expandInitialElementsIfRequired();
this.detectChangesAction();
this.refreshTimeout = null;
}, 150);
}
}
getFormattedBorderWidth(): string {
if (this.model.BorderThickness) {
const top = this.model.BorderThickness?.Top;
const bottom = this.model.BorderThickness?.Bottom;
const left = this.model.BorderThickness?.Left;
const right = this.model.BorderThickness?.Right;
return `${top}px ${right}px ${bottom}px ${left}px`;
}
return '1px';
}
/**
* Method that setup the data in the datasource
*
* @memberof TreeViewComponent
*/
setupData(): void {
this.treeFlattener = new MatTreeFlattener(
/* eslint no-underscore-dangle: 0 */
this._transformer,
(node) => node.level,
(node) => node.expandable(),
(node) => node[this.templateSource]
);
this.dataSource = new MatTreeFlatDataSource(
this.treeControl,
this.treeFlattener
);
if (this.model?.ItemsSource) {
this.dataSource.data = [...this.model.ItemsSource];
}
this.detectChangesAction();
}
/**
* Create the tree datasource from the items collection
*
* @memberof TreeViewComponent
*/
setupDataFromItems() {
this.treeFlattener = new MatTreeFlattener(
/* eslint no-underscore-dangle: 0 */
this._transformerFromItems,
(node) => node.level,
(node) => node.expandable(),
(node) => node.items.internalArray
);
this.dataSource = new MatTreeFlatDataSource(
this.treeControl,
this.treeFlattener
);
/* istanbul ignore else */
if (this.model.items instanceof ItemsCollectionModel) {
this.dataSource.data = this.model.items.internalArray;
}
this.detectChangesAction();
}
/**
* Create the tree datasource from the items collection
*
* @memberof TreeViewComponent
*/
setupDataFromItemsForHierarchicalDataTemplate() {
if (this.dataSource) {
this.dataSource.data = [];
}
this.treeFlattener = new MatTreeFlattener(
/* eslint no-underscore-dangle: 0 */
this._transformerFromItemsForHierarchicalDataTemplate,
(node) => node.level,
(node) => node.expandable(),
(node) => node[this.templateSource].internalArray
);
this.dataSource = new MatTreeFlatDataSource(
this.treeControl,
this.treeFlattener
);
/* istanbul ignore else */
if (this.model.items instanceof ItemsCollectionModel) {
this.dataSource.data = [...this.model.items.internalArray];
}
this.detectChangesAction();
}
/**
* Handles the click event in the buttons to get the node that got selected
*
* @param {*} node
* @memberof TreeViewComponent
*/
nodeClick(node: any): void {
/* istanbul ignore else */
if (this.model?.selectedItem) {
this.model.SelectedItem.isSelected = false;
}
node.isSelected = true;
this.model.SelectedItem = node;
this.detectChangesAction();
}
/**
* Allow to check if a node has childs
*
* @param {number} _
* @param {*} node
* @memberof TreeViewComponent
*/
hasChild = (_: number, node: any) => node.expandable();
/**
* returns a string with the class for the isSelected state
*
* @param {*} node current node info
* @return {*} {string} class to apply in css
* @memberof TreeViewComponent
*/
isItemSelected(node): string {
return node.isSelected ? 'selected' : '';
}
/**
* Expands initial nodes if required
*
* @private
* @memberof XamTreeComponent
*/
expandInitialElementsIfRequired() {
const nodesToCheck = this.model.items;
this.expandingNodes(nodesToCheck);
}
/**
* Expand nodes at another level
*
* @private
* @param {Iterable<any>} nodesToCheck
* @memberof XamTreeComponent
*/
private 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);
}
}
}
/**
* Validates if the isExpanded property is true and then sets the treeview to be expanded by default
*
* @memberof TreeViewComponent
*/
private setExpandedProp(): void {
if (
this.model.ItemContainerStyle instanceof RuntimeStyleInfo &&
iuAny(
this.model.ItemContainerStyle.Setters,
(setter: Setter) => setter.Property === 'IsExpanded'
)
) {
this.treeControl.expandDescendants(this.dataSource.data[0]);
}
}
}
<div
class="treeContainer autoHeightWidth"
[style.border-color]="borderBrush"
[style.border-width]="borderWidth"
>
<cdk-virtual-scroll-viewport
itemSize="5"
style="height: 100%; min-height: 300px"
[style.background-color]="background"
>
<mat-tree
*ngIf="isInitialized"
[style.background-color]="background"
[dataSource]="dataSource"
[treeControl]="treeControl"
class="autoHeightWidth"
>
<!-- This is the tree node template for leaf nodes -->
<mat-tree-node
[disabled]="!isEnabled"
*matTreeNodeDef="let node"
matTreeNodePadding
[matTreeNodePaddingIndent]="nodeIndentation"
[ngClass]="isItemSelected(node)"
>
<!-- use a disabled button to provide padding for tree leaf -->
<button mat-icon-button disabled></button>
<div
*ngIf="model && dataSource"
[ngClass]="isEnabled ? 'mouseEvents' : 'disabledClass'"
(click)="nodeClick(node)"
>
<ng-container
*ngIf="isInitialized && model?.ItemTemplate?.templateRef"
[ngTemplateOutlet]="model.ItemTemplate.templateRef"
[ngTemplateOutletContext]="{ context: node }"
>
</ng-container>
<ng-container
*ngIf="isInitialized && !model?.ItemTemplate?.templateRef"
>{{ node.Header }}</ng-container
>
<ng-container
*ngIf="
model &&
itemsSource &&
isInitialized &&
model?.ItemTemplate?.TemplateComponentConstructor
"
>
<ng-container
*ngComponentOutlet="
model.ItemTemplate.TemplateComponentConstructor;
injector: node | toInjector: model.ItemTemplate.declaringContext
"
>
</ng-container>
</ng-container>
</div>
</mat-tree-node>
<!-- This is the tree node template for expandable nodes -->
<mat-tree-node
[disabled]="!isEnabled"
*matTreeNodeDef="let node; when: hasChild"
matTreeNodePadding
[matTreeNodePaddingIndent]="nodeIndentation"
[ngClass]="isItemSelected(node)"
>
<button
mat-icon-button
matTreeNodeToggle
[attr.aria-label]="'Toggle ' + node.name"
[disabled]="!isEnabled"
>
<mat-icon class="mat-icon-rtl-mirror">
{{ treeControl.isExpanded(node) ? 'expand_more' : 'chevron_right' }}
</mat-icon>
</button>
<div
*ngIf="model && dataSource"
[ngClass]="isEnabled ? 'mouseEvents' : 'disabledClass'"
(click)="nodeClick(node)"
>
<ng-container
*ngIf="isInitialized && model?.ItemTemplate?.templateRef"
[ngTemplateOutlet]="model.ItemTemplate.templateRef"
[ngTemplateOutletContext]="{ context: node }"
>
</ng-container>
<ng-container
*ngIf="
isInitialized &&
!model?.ItemTemplate?.templateRef &&
!model.ItemTemplate?.TemplateComponentConstructor
"
>
{{ node.Header }}
</ng-container>
<ng-container
*ngIf="
model &&
itemsSource &&
isInitialized &&
model?.ItemTemplate?.TemplateComponentConstructor
"
>
<ng-container
*ngComponentOutlet="
model.ItemTemplate.TemplateComponentConstructor;
injector: node | toInjector: model.ItemTemplate.declaringContext
"
>
</ng-container>
</ng-container>
</div>
</mat-tree-node>
</mat-tree>
</cdk-virtual-scroll-viewport>
</div>
./tree-view.component.scss
@import '../../scss/variables';
.treeContainer {
box-sizing: border-box;
border-radius: 2px;
border-style: solid;
padding: 1px;
}
mat-tree {
border-style: solid;
border-width: 0px;
}
mat-tree-node {
min-height: unset;
white-space: nowrap;
.mat-icon-button {
height: $tree-view-icon-size;
width: $tree-view-icon-size;
line-height: $tree-view-icon-size;
}
}
.mouseEvents {
padding: 0.1%;
border-radius: 5px;
}
.mouseEvents:hover {
background-color: rgba(196, 250, 244, 0.5);
}
.disabledClass {
padding: 0.1%;
border-radius: 5px;
@extend %default-control-disabled-state;
}
.selected {
background-color: $background-highlight;
}