projects/i-components/src/lib/components/rad-auto-complete-box/rad-auto-complete-box.component.ts
Angular Component for the RadAutoCompleteBox Control.
changeDetection | ChangeDetectionStrategy.OnPush |
selector | wm-rad-auto-complete-box |
styleUrls | ./rad-auto-complete-box.component.scss |
templateUrl | ./rad-auto-complete-box.component.html |
constructor(injectedModel: RadAutoCompleteBoxModel, cdRef: ChangeDetectorRef, injector: Injector, element: ElementRef)
|
|||||||||||||||
Creates an instance of RadAutoCompleteBoxComponent.
Parameters :
|
autoCompleteMode | |
Sets autoCompleteMode property of the RadAutoCompleteBox |
dropDownItemTemplate | |
Sets DropDownItemTemplate property of the RadAutoCompleteBox. |
itemsSource | |
Sets ItemsSource property of the RadAutoCompleteBox. |
maxDropDownHeight | |
Sets MaxDropDownHeight property of the RadAutoCompleteBox. |
minDropDownWidth | |
Type : any
|
|
Sets MinDropDownWidth property of the RadAutoCompleteBox. |
model | |
Type : RadAutoCompleteBoxModel
|
|
Current model |
searchText | |
Type : string
|
|
Sets SearchText property of the RadAutoCompleteBox. |
selectedItem | |
Type : any
|
|
Sets selectedItem property of the RadAutoCompleteBox. |
selectionMode | |
Sets SelectionMode property of the RadAutoCompleteBox |
textSearchMode | |
Sets TextSearchMode property of the RadAutoCompleteBox |
textSearchPath | |
Type : string
|
|
Sets TextSearchPath property of the RadAutoCompleteBox. |
watermarkContent | |
Type : string
|
|
Sets WatermarkContent property of the RadAutoCompleteBox. |
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... |
selectionChanged | |
Type : EventEmitter<literal type>
|
|
Event Emitter. SelectionChanged event. |
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. |
clearSelection |
clearSelection()
|
Clear focus on the dropdown items
Returns :
void
|
handleOpening | ||||||
handleOpening(event: any)
|
||||||
Event before the dropdown is opened
Parameters :
Returns :
void
|
handleSelection | ||||||
handleSelection(event: any)
|
||||||
Emitted when item selection is changing, before the selection completes
Parameters :
Returns :
void
|
keyDownHandler | ||||||
keyDownHandler(event: any)
|
||||||
Handler to avoid issues with the IgxDropDownItemNavigation directive.
Parameters :
Returns :
void
|
keyUpHandler | ||||||
keyUpHandler(event: any)
|
||||||
KeyUp handler used to open teh dropdown an also navigate to the first item.
Parameters :
Returns :
void
|
ngAfterContentInit |
ngAfterContentInit()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:229
|
Angular lifecycle.
Returns :
void
|
ngOnInit |
ngOnInit()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:210
|
Angular lifecycle
Returns :
void
|
syncModel |
syncModel()
|
Assign the item template
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
|
modelChangeHandler | ||||||||
modelChangeHandler(name?: string)
|
||||||||
Inherited from
BaseComponent
|
||||||||
Defined in
BaseComponent:1650
|
||||||||
Method to handle the model's change
Parameters :
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 ngAfterViewChecked |
ngAfterViewChecked()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:893
|
Angular Lifecycle Hooks
Returns :
void
|
Public ngAfterViewInit |
ngAfterViewInit()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:877
|
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
|
Public ngOnDestroy |
ngOnDestroy()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:906
|
Cleanup operations for base component
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} |
autoCompleteInputRef |
Type : ElementRef
|
Decorators :
@ViewChild('autoCompleteInput')
|
Gets the input reference |
autoCompletePipe |
Type : AutocompletePipeFilter
|
Default value : new AutocompletePipeFilter()
|
Instace of AutocompletePipeFilter |
dropDown |
Type : IgxDropDownComponent
|
Decorators :
@ViewChild('dropDown')
|
Gets the reference of the dropdown |
internalSelection |
Type : boolean
|
Flag to know if there is a internal selection in progress |
isInitialized |
Default value : true
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:151
|
Flag to know if the component is ready to render |
itemHeight |
Type : number
|
Default value : 28
|
Static item height so the virtualizing works as expected |
model |
Type : RadAutoCompleteBoxModel
|
Decorators :
@Input()
|
Current model |
Protected modelProxy |
Type : RadAutoCompleteBoxModel
|
Default value : ModelProxy.create<RadAutoCompleteBoxModel>()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:160
|
ModelProxy is copy of model, used on the component initial building to prevent crashes with external bindings. |
Private overlayService |
Type : IgxOverlayService
|
Reference to the overlay service, used to display the dropDown |
overlaySettingsAuto |
Type : OverlaySettings
|
Overlay setting when opening a new dropdown |
Public radAutoCompleteBoxItemTemplate |
Type : TemplateRef<any>
|
Decorators :
@ContentChild('itemTemplate')
|
Template elements reference |
selectionChanged |
Type : EventEmitter<literal type>
|
Default value : new EventEmitter()
|
Decorators :
@Output()
|
Event Emitter. SelectionChanged event. |
Public valueSelected |
Type : string
|
Default value : ''
|
Value selected by the input |
virtualizationDropDownHeight |
Type : number
|
Default value : 0
|
Height to use for virtualization |
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 |
autoCompleteMode | ||||||
getautoCompleteMode()
|
||||||
Gets AutoCompleteMode property of the RadAutoCompleteBox
Returns :
string | AutoCompleteMode | BindingInfo
|
||||||
setautoCompleteMode(value: string | AutoCompleteMode | BindingInfo)
|
||||||
Sets autoCompleteMode property of the RadAutoCompleteBox
Parameters :
Returns :
void
|
dropDownItemTemplate | ||||||
getdropDownItemTemplate()
|
||||||
Gets DropDownItemTemplate property of the RadAutoCompleteBox.
Returns :
any | BindingInfo
|
||||||
setdropDownItemTemplate(value: any | BindingInfo)
|
||||||
Sets DropDownItemTemplate property of the RadAutoCompleteBox.
Parameters :
Returns :
void
|
itemsSource | ||||||
getitemsSource()
|
||||||
Gets ItemsSource property of the RadAutoCompleteBox.
Returns :
any | BindingInfo
|
||||||
setitemsSource(value: any | BindingInfo)
|
||||||
Sets ItemsSource property of the RadAutoCompleteBox.
Parameters :
Returns :
void
|
maxDropDownHeight | ||||||
getmaxDropDownHeight()
|
||||||
Gets MaxDropDownHeight property of the RadAutoCompleteBox.
Returns :
any | BindingInfo
|
||||||
setmaxDropDownHeight(value: any | BindingInfo)
|
||||||
Sets MaxDropDownHeight property of the RadAutoCompleteBox.
Parameters :
Returns :
void
|
searchText | ||||||
getsearchText()
|
||||||
Gets SearchText property of the RadAutoCompleteBox.
Returns :
string
|
||||||
setsearchText(value: string)
|
||||||
Sets SearchText property of the RadAutoCompleteBox.
Parameters :
Returns :
void
|
selectedItem | ||||||
getselectedItem()
|
||||||
Gets selectedItem property of the RadAutoCompleteBox.
Returns :
any
|
||||||
setselectedItem(value: any)
|
||||||
Sets selectedItem property of the RadAutoCompleteBox.
Parameters :
Returns :
void
|
selectionMode | ||||||
getselectionMode()
|
||||||
Gets SelectionMode property of the RadAutoCompleteBox |
||||||
setselectionMode(value: string | AutoCompleteSelectionMode | BindingInfo)
|
||||||
Sets SelectionMode property of the RadAutoCompleteBox
Parameters :
Returns :
void
|
textSearchMode | ||||||
gettextSearchMode()
|
||||||
Gets TextSearchMode property of the RadAutoCompleteBox
Returns :
string | TextSearchMode | BindingInfo
|
||||||
settextSearchMode(value: string | TextSearchMode | BindingInfo)
|
||||||
Sets TextSearchMode property of the RadAutoCompleteBox
Parameters :
Returns :
void
|
textSearchPath | ||||||
gettextSearchPath()
|
||||||
Gets TextSearchPath property of the RadAutoCompleteBox.
Returns :
string
|
||||||
settextSearchPath(value: string)
|
||||||
Sets TextSearchPath property of the RadAutoCompleteBox.
Parameters :
Returns :
void
|
watermarkContent | ||||||
getwatermarkContent()
|
||||||
Gets WatermarkContent property of the RadAutoCompleteBox.
Returns :
string
|
||||||
setwatermarkContent(value: string)
|
||||||
Sets WatermarkContent property of the RadAutoCompleteBox.
Parameters :
Returns :
void
|
minDropDownWidth | ||||||
getminDropDownWidth()
|
||||||
Gets MinDropDownWidth property of the RadAutoCompleteBox.
Returns :
any
|
||||||
setminDropDownWidth(value: any)
|
||||||
Sets MinDropDownWidth property of the RadAutoCompleteBox.
Parameters :
Returns :
void
|
dropdownItems |
getdropdownItems()
|
Gets the items to be rendered by the dropdown
Returns :
any[]
|
textSearchModeToString |
gettextSearchModeToString()
|
Convert textSearchMode from model to a string
Returns :
string
|
import {
AfterContentInit,
ChangeDetectorRef,
Component,
ContentChild,
Injector,
Input,
OnInit,
Optional,
TemplateRef,
Output,
EventEmitter,
ChangeDetectionStrategy,
ElementRef,
ViewChild,
} from '@angular/core';
import {
RadAutoCompleteBoxModel,
BindingInfo,
ModelProxy,
AngularComponentId,
ComponentId,
AutoCompleteSelectionMode,
AutoCompleteMode,
TextSearchMode,
SelectionChangedEventArgs,
SimpleList,
} from '@mobilize/wms-framework';
import { BaseComponent } from '../base/base.component';
import {
AbsoluteScrollStrategy,
AutoPositionStrategy,
IgxDropDownComponent,
IgxOverlayService,
OverlaySettings,
} from 'igniteui-angular';
import { Utils } from '../../utils/utilities';
import { AutocompletePipeFilter } from '../../pipes/autocomplete.pipe';
/**
* Angular Component for the RadAutoCompleteBox Control.
*
* @export
* @class RadAutoCompleteBoxComponent
* @extends {BaseComponent}
* @implements {OnInit}
* @implements {AfterContentInit}
*/
@Component({
selector: 'wm-rad-auto-complete-box',
templateUrl: './rad-auto-complete-box.component.html',
styleUrls: ['./rad-auto-complete-box.component.scss'],
changeDetection: ChangeDetectionStrategy.OnPush,
})
@ComponentId([AngularComponentId.radAutoCompleteBox])
export class RadAutoCompleteBoxComponent
extends BaseComponent
implements OnInit, AfterContentInit
{
/**
* Event Emitter.
* SelectionChanged event.
*
* @type {EventEmitter<RadAutoCompleteBoxModel>}
* @memberof RadRadAutoCompleteBoxComponent
*/
@Output() selectionChanged: EventEmitter<{
sender: RadAutoCompleteBoxModel;
e: any;
}> = new EventEmitter();
/**
* Current model
*
* @type {RadAutoCompleteBoxModel}
* @memberof RadAutoCompleteBoxComponent
*/
@Input() model: RadAutoCompleteBoxModel;
/**
* Template elements reference
*
* @type {TemplateRef<any>;}
* @memberof RadAutoCompleteBoxComponent
*/
@ContentChild('itemTemplate')
public radAutoCompleteBoxItemTemplate: TemplateRef<any>;
/**
* Gets the reference of the dropdown
*
* @type {IgxDropDownComponent}
* @memberof RadAutoCompleteBoxComponent
*/
@ViewChild('dropDown')
dropDown: IgxDropDownComponent;
/**
* Gets the input reference
*
* @type {IgxDropDownComponent}
* @memberof RadAutoCompleteBoxComponent
*/
@ViewChild('autoCompleteInput')
autoCompleteInputRef: ElementRef;
/**
* Instace of AutocompletePipeFilter
*
* @type {AutocompletePipeFilter}
* @memberof RadAutoCompleteBoxComponent
*/
autoCompletePipe: AutocompletePipeFilter = new AutocompletePipeFilter();
/**
* Flag to know if there is a internal selection in progress
*
* @type {boolean}
* @memberof RadAutoCompleteBoxComponent
*/
internalSelection: boolean;
/**
* Value selected by the input
*
* @memberof RadAutoCompleteBoxComponent
*/
public valueSelected = '';
/**
* Flag to know if the component is ready to render
*
* @type {boolean}
* @memberof RadAutoCompleteBoxComponent
*/
isInitialized = true;
/**
* ModelProxy is copy of model, used on the component initial building to prevent crashes with external bindings.
*
* @protected
* @type {RadAutoCompleteBoxModel}
* @memberof RadAutoCompleteBoxComponent
*/
protected modelProxy: RadAutoCompleteBoxModel =
ModelProxy.create<RadAutoCompleteBoxModel>();
/**
* Reference to the overlay service, used to display the dropDown
*
* @private
* @type {IgxOverlayService}
* @memberof RadAutoCompleteBoxComponent
*/
private overlayService: IgxOverlayService;
/**
* Overlay setting when opening a new dropdown
*
* @type {OverlaySettings}
* @memberof RadAutoCompleteBoxComponent
*/
overlaySettingsAuto: OverlaySettings;
/**
* Static item height so the virtualizing works as expected
*
* @memberof RadAutoCompleteBoxComponent
*/
itemHeight = 28;
/**
* Creates an instance of RadAutoCompleteBoxComponent.
*
* @param {RadAutoCompleteBox} [injectedModel=null]
* @memberof RadAutoCompleteBoxComponent
*/
/* istanbul ignore next */
constructor(
@Optional() protected injectedModel: RadAutoCompleteBoxModel = null,
private cdRef: ChangeDetectorRef,
private injector: Injector,
@Optional() protected element: ElementRef = null
) {
super(cdRef, injector);
this.overlayService = injector.get(IgxOverlayService);
this.model = injectedModel;
}
/**
* Angular lifecycle
*
* @memberof RadAutoCompleteBoxComponent
*/
ngOnInit(): void {
this.model =
this.model || this.injectedModel || new RadAutoCompleteBoxModel();
this.setupModel(this.model);
super.ngOnInit();
this.overlaySettingsAuto = {
positionStrategy: new AutoPositionStrategy(),
scrollStrategy: new AbsoluteScrollStrategy(),
modal: false,
closeOnEscape: false,
target: null,
};
}
/**
* Angular lifecycle.
*
* @memberof RadAutoCompleteBoxComponent
*/
ngAfterContentInit(): void {
super.ngAfterContentInit();
this.syncModel();
this.isInitialized = true;
this.detectChangesAction();
}
/**
* Sets autoCompleteMode property of the RadAutoCompleteBox
*
* @memberof RadAutoCompleteBox
*/
@Input()
set autoCompleteMode(value: string | AutoCompleteMode | BindingInfo) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
RadAutoCompleteBoxModel.AutoCompleteModeProperty,
value
)
) {
if (value === 'Append' || value === AutoCompleteMode.Append) {
this.modelProxy.AutoCompleteMode = AutoCompleteMode.Append;
} else if (
value === 'SuggestAppend' ||
value === AutoCompleteMode.SuggestAppend
) {
this.modelProxy.AutoCompleteMode = AutoCompleteMode.SuggestAppend;
} else {
this.modelProxy.AutoCompleteMode = AutoCompleteMode.Suggest;
}
}
}
/**
* Gets AutoCompleteMode property of the RadAutoCompleteBox
*
* @memberof RadAutoCompleteBox
*/
get autoCompleteMode(): string | AutoCompleteMode | BindingInfo {
return this.model.AutoCompleteMode;
}
/**
* Sets DropDownItemTemplate property of the RadAutoCompleteBox.
*
* @memberof RadAutoCompleteBox
*/
@Input()
set dropDownItemTemplate(value: any | BindingInfo) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
RadAutoCompleteBoxModel.DropDownItemTemplateProperty,
value
)
) {
this.modelProxy.DropDownItemTemplate = value;
}
}
/**
* Gets DropDownItemTemplate property of the RadAutoCompleteBox.
*
* @memberof RadAutoCompleteBox
*/
get dropDownItemTemplate(): any | BindingInfo {
return this.model.DropDownItemTemplate;
}
/**
* Sets ItemsSource property of the RadAutoCompleteBox.
*
* @type {any}
* @memberof RadAutoCompleteBoxComponent
*/
@Input()
set itemsSource(value: any | BindingInfo) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
RadAutoCompleteBoxModel.ItemsSourceProperty,
value
)
) {
this.modelProxy.ItemsSource = value;
}
}
/**
* Gets ItemsSource property of the RadAutoCompleteBox.
*
* @type {any}
* @memberof RadAutoCompleteBoxComponent
*/
get itemsSource(): any | BindingInfo {
return Array.isArray(this.model.ItemsSource)
? this.model.ItemsSource
: this.model.ItemsSource?.internalArray;
}
/**
* Sets MaxDropDownHeight property of the RadAutoCompleteBox.
*
* @memberof RadAutoCompleteBoxComponent
*/
@Input()
set maxDropDownHeight(value: any | BindingInfo) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
RadAutoCompleteBoxModel.MaxDropDownHeightProperty,
value
)
) {
this.modelProxy.MaxDropDownHeight = value;
}
}
/**
* Gets MaxDropDownHeight property of the RadAutoCompleteBox.
*
* @readonly
* @type {any | BindingInfo}
* @memberof RadAutoCompleteBoxComponent
*/
get maxDropDownHeight(): any | BindingInfo {
return this.model.MaxDropDownHeight ?? 200;
}
/**
* Height to use for virtualization
*
* @type {number}
* @memberof RadAutoCompleteBoxComponent
*/
virtualizationDropDownHeight = 0;
/**
* Sets SearchText property of the RadAutoCompleteBox.
*
* @type {string}
* @memberof RadAutoCompleteBoxComponent
*/
@Input()
set searchText(value: string) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
RadAutoCompleteBoxModel.SearchTextProperty,
value
)
) {
this.modelProxy.SearchText = value;
this.valueSelected = value;
}
}
/**
* Gets SearchText property of the RadAutoCompleteBox.
*
* @type {string}
* @memberof RadAutoCompleteBoxComponent
*/
get searchText(): string {
return this.model.SearchText;
}
/**
* Sets selectedItem property of the RadAutoCompleteBox.
*
* @type {any}
* @memberof RadAutoCompleteBoxComponent
*/
@Input()
set selectedItem(value: any) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
RadAutoCompleteBoxModel.SelectedItemProperty,
value
)
) {
this.modelProxy.SelectedItem = value;
}
}
/**
* Gets selectedItem property of the RadAutoCompleteBox.
*
* @type {*}
* @memberof RadAutoCompleteBoxComponent
*/
get selectedItem(): any {
return this.model.SelectedItem;
}
/**
* Sets SelectionMode property of the RadAutoCompleteBox
*
* @memberof RadAutoCompleteBox
*/
@Input()
set selectionMode(value: string | AutoCompleteSelectionMode | BindingInfo) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
RadAutoCompleteBoxModel.SelectionModeProperty,
value
)
) {
if (
value === 'Multiple' ||
value === AutoCompleteSelectionMode.Multiple
) {
this.modelProxy.SelectionMode = AutoCompleteSelectionMode.Multiple;
} else {
this.modelProxy.SelectionMode = AutoCompleteSelectionMode.Single;
}
}
}
/**
* Gets SelectionMode property of the RadAutoCompleteBox
*
* @memberof RadAutoCompleteBox
*/
get selectionMode(): string | AutoCompleteSelectionMode | BindingInfo {
return this.model.SelectionMode;
}
/**
* Sets TextSearchMode property of the RadAutoCompleteBox
*
* @memberof RadAutoCompleteBox
*/
@Input()
set textSearchMode(value: string | TextSearchMode | BindingInfo) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
RadAutoCompleteBoxModel.TextSearchModeProperty,
value
)
) {
if (value === 'Contains' || value === TextSearchMode.Contains) {
this.modelProxy.TextSearchMode = TextSearchMode.Contains;
} else if (
value === 'ContainsCaseSensitive' ||
value === TextSearchMode.ContainsCaseSensitive
) {
this.modelProxy.TextSearchMode = TextSearchMode.ContainsCaseSensitive;
} else if (
value === 'StartsWithCaseSensitive' ||
value === TextSearchMode.StartsWithCaseSensitive
) {
this.modelProxy.TextSearchMode = TextSearchMode.StartsWithCaseSensitive;
} else {
this.modelProxy.TextSearchMode = TextSearchMode.StartsWith;
}
}
}
/**
* Gets TextSearchMode property of the RadAutoCompleteBox
*
* @memberof RadAutoCompleteBox
*/
get textSearchMode(): string | TextSearchMode | BindingInfo {
return this.model.TextSearchMode;
}
/**
* Sets TextSearchPath property of the RadAutoCompleteBox.
*
* @type {string}
* @memberof RadAutoCompleteBoxComponent
*/
@Input()
set textSearchPath(value: string) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
RadAutoCompleteBoxModel.TextSearchPathProperty,
value
)
) {
this.modelProxy.TextSearchPath = value;
}
}
/**
* Gets TextSearchPath property of the RadAutoCompleteBox.
*
* @type {string}
* @memberof RadAutoCompleteBoxComponent
*/
get textSearchPath(): string {
return this.model.TextSearchPath;
}
/**
* Sets WatermarkContent property of the RadAutoCompleteBox.
*
* @type {string}
* @memberof RadAutoCompleteBoxComponent
*/
@Input()
set watermarkContent(value: string) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
RadAutoCompleteBoxModel.WatermarkContentProperty,
value
)
) {
this.modelProxy.WatermarkContent = value;
}
}
/**
* Gets WatermarkContent property of the RadAutoCompleteBox.
*
* @type {string}
* @memberof RadAutoCompleteBoxComponent
*/
get watermarkContent(): string {
return this.model.WatermarkContent;
}
/**
* Sets MinDropDownWidth property of the RadAutoCompleteBox.
*
* @type {any}
* @memberof RadAutoCompleteBoxComponent
*/
@Input()
set minDropDownWidth(value: any) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
RadAutoCompleteBoxModel.MinDropDownWidthProperty,
value
)
) {
this.modelProxy.MinDropDownWidth = value;
}
}
/**
* Gets MinDropDownWidth property of the RadAutoCompleteBox.
*
* @readonly
* @type {any}
* @memberof RadAutoCompleteBoxComponent
*/
get minDropDownWidth(): any {
return `${this.model.MinDropDownWidth}px`;
}
/**
* Gets the items to be rendered by the dropdown
*
* @readonly
* @type {any[]}
* @memberof RadAutoCompleteBoxComponent
*/
get dropdownItems(): any[] {
const res = this.autoCompletePipe.transform(
this.itemsSource,
this.valueSelected,
this.textSearchModeToString,
this.textSearchPath,
undefined,
undefined
);
this.virtualizationDropDownHeight = Math.min(
res.length * this.itemHeight,
this.maxDropDownHeight
);
return res;
}
/**
* Emitted when item selection is changing, before the selection completes
*
* @memberof RadAutoCompleteBoxComponent
*/
handleSelection(event: any): void {
if (this.internalSelection) {
this.internalSelection = false;
return;
}
this.selectedItem = event.newSelection.value;
/* istanbul ignore else */
if (this.textSearchPath) {
event.newSelection.value = event.newSelection.value[this.textSearchPath];
}
this.valueSelected = event.newSelection.value;
const selectedChangedArgs = new SelectionChangedEventArgs(
new SimpleList<any>(),
new SimpleList<any>()
);
selectedChangedArgs.AddedItems.add(this.selectedItem);
const params = { sender: this.model, e: selectedChangedArgs };
this.model.SelectionChanged.fire([params.sender, selectedChangedArgs]);
this.selectionChanged.emit(params);
}
/**
* Assign the item template
*
* @memberof RadAutoCompleteBoxComponent
*/
syncModel(): void {
// Syncs DropDownItemTemplate
/* istanbul ignore next */
if (
this.radAutoCompleteBoxItemTemplate &&
!Utils.isEqual(
this.model.DropDownItemTemplate,
this.radAutoCompleteBoxItemTemplate
)
) {
this.model.DropDownItemTemplate = this.radAutoCompleteBoxItemTemplate;
}
// Syncs SearchText
/* istanbul ignore next */
if (this.model.SearchText) {
this.valueSelected = this.model.SearchText;
}
}
/**
* Convert textSearchMode from model to a string
*
* @memberof RadAutoCompleteBoxComponent
*/
get textSearchModeToString(): string {
if (this.textSearchMode === TextSearchMode.Contains) {
return 'Contains';
} else if (this.textSearchMode === TextSearchMode.ContainsCaseSensitive) {
return 'ContainsCaseSensitive';
} else if (this.textSearchMode === TextSearchMode.StartsWithCaseSensitive) {
return 'StartsWithCaseSensitive';
} else {
return 'StartsWith';
}
}
/**
* KeyUp handler used to open teh dropdown an also navigate to the first item.
*
* @memberof RadAutoCompleteBoxComponent
*/
keyUpHandler(event: any): void {
if (!this.valueSelected || this.dropdownItems.length === 0) {
this.clearSelection();
this.dropDown.close();
return;
} else if (this.dropDown.collapsed) {
this.overlaySettingsAuto.target = this.autoCompleteInputRef.nativeElement;
this.overlaySettingsAuto.excludeFromOutsideClick = [
this.autoCompleteInputRef.nativeElement,
];
this.dropDown.open(this.overlaySettingsAuto);
}
this.internalSelection = true;
this.dropDown.setSelectedItem(0);
}
/**
* Handler to avoid issues with the IgxDropDownItemNavigation directive.
*
* @memberof RadAutoCompleteBoxComponent
*/
keyDownHandler(event: any): void {
if (event.code == 'Space') {
event.stopPropagation();
}
}
/**
* Clear focus on the dropdown items
*
* @memberof RadAutoCompleteBoxComponent
*/
clearSelection(): void {
this.dropDown.items.forEach((item) => (item.focused = false));
this.detectChanges();
}
/**
* Event before the dropdown is opened
*
* @param {*} event
* @memberof RadAutoCompleteBoxComponent
*/
handleOpening(event: any): void {
setTimeout(() => {
const minWidth =
this.element?.nativeElement?.getBoundingClientRect?.()?.width;
const overlay = document.querySelector(
'.igx-overlay>.igx-overlay__wrapper>.igx-overlay__content'
);
if (overlay != null) {
(overlay as HTMLElement).style.setProperty('width', 'auto');
if (!Number.isNaN(minWidth) && minWidth > 0) {
(overlay as HTMLElement).style.setProperty(
'min-width',
`${minWidth}px`
);
}
Utils.adjustDropDownToWindow(
overlay,
this.dropDown['toggleDirective'].overlayId,
this.overlayService
);
}
const overlayList = document.querySelector(
'.igx-overlay>.igx-overlay__wrapper>.igx-overlay__content>.igx-drop-down__list'
);
if (overlayList != null) {
(overlayList as HTMLElement).style.setProperty('width', 'auto');
}
}, 16);
}
}
<div class="autoHeightWidth mainContainer" *ngIf="visibility && isInitialized">
<div class="radAutoCompletContainer" [igxDropDownItemNavigation]="dropDown">
<input
#autoCompleteInput
type="text"
[attr.spellcheck]="spellCheck"
[placeholder]="watermarkContent"
[(ngModel)]="valueSelected"
(keydown)="keyDownHandler($event)"
(keyup)="keyUpHandler($event)"
class="widthHeightInherance autoCompleteInput"
/>
</div>
<igx-drop-down
#dropDown
class="dropdown"
(selectionChanging)="handleSelection($event)"
(opening)="handleOpening($event)"
>
<div
class="drop-down-virtual-wrapper"
[style.min-width]="minDropDownWidth"
[style.max-height.px]="maxDropDownHeight"
>
<igx-drop-down-item
*igxFor="
let item of dropdownItems;
index as index;
scrollOrientation: 'vertical';
itemSize: itemHeight;
containerSize: virtualizationDropDownHeight
"
[value]="item"
[index]="index"
>
<!-- This section represents the autocompletebox when it has no template children. Basic Scenario (valueMember handled in AutocompletePipeFilter)-->
<ng-container *ngIf="!dropDownItemTemplate && !textSearchPath">
{{ item }}
</ng-container>
<!-- This section represents the autocompletebox when it has no template children. Basic Scenario (valueMember handled in AutocompletePipeFilter)-->
<ng-container *ngIf="!dropDownItemTemplate && textSearchPath">
{{ item[textSearchPath] }}
</ng-container>
<!-- This section represent the autocompletebox an itemTemplate for each item.-->
<ng-container
*ngIf="
dropDownItemTemplate &&
!dropDownItemTemplate?.TemplateComponentConstructor
"
>
<ng-container
[ngTemplateOutlet]="dropDownItemTemplate"
[ngTemplateOutletContext]="{ context: item }"
>
</ng-container>
</ng-container>
<!-- This section represent the autocompletebox when the items data comes through dataTemplate.-->
<ng-container
*ngIf="
itemsSource && dropDownItemTemplate?.TemplateComponentConstructor
"
>
<ng-container
*ngComponentOutlet="
dropDownItemTemplate.TemplateComponentConstructor;
injector: item | toInjector: dropDownItemTemplate.declaringContext
"
>
</ng-container>
</ng-container>
</igx-drop-down-item>
</div>
</igx-drop-down>
</div>
./rad-auto-complete-box.component.scss
@import '../../scss/variables';
.widthHeightInherance {
width: inherit;
height: inherit;
}
.mainContainer {
//to work as an anchor for the dropdown
position: relative;
.radAutoCompletContainer {
width: 100%;
height: 100%;
.autoCompleteInput {
border: 1.5px solid $text-box-border-color;
box-sizing: border-box;
outline: none;
&:focus {
border: 1.5px solid $default-control-active-color;
}
}
}
.dropdown {
width: 100%;
}
}
%rad-autocomplete-item-normal {
background: $accent-background;
border: 1px solid transparent;
}
%rad-autocomplete-item-hover {
background: $rad-autocomplete-box-item-hover-background;
border: $rad-autocomplete-box-item-selected-border;
}
%rad-autocomplete-item-selected {
background: $rad-autocomplete-box-item-selected-background;
border: $rad-autocomplete-box-item-selected-border;
}
.drop-down-virtual-wrapper {
overflow-y: hidden;
.igx-drop-down__item {
padding: 0px;
height: $rad-autocomplete-drop-down-item-height;
@extend %rad-autocomplete-item-normal;
&--selected {
@extend %rad-autocomplete-item-normal;
}
&--focused {
@extend %rad-autocomplete-item-selected;
}
&:hover:not(.igx-drop-down__item--focused) {
@extend %rad-autocomplete-item-hover;
~ .igx-drop-down__item {
@extend %rad-autocomplete-item-normal;
}
}
}
}