src/components/kendoUI/combobox/combobox.component.ts
AfterViewInit
OnInit
ComboBox
DoCheck
OnDestroy
| selector | wm-combobox |
| styleUrls | ./combobox.component.scss |
| templateUrl | ./combobox.component.html |
constructor(serviceRef: WebMapService, changeDetectorRef: ChangeDetectorRef, render2: Renderer2, elem: ElementRef, webComponents: WebComponentsService, bringTopServ1: BringTopService, searchSuggestionService?: SearchSuggestionService, containerInteraction?: ContainerInteractionService)
|
|||||||||||||||||||||||||||
|
Parameters :
|
| dataUrl |
Type : string
|
|
Optional input parameter to specify a custom data source URL. |
| filterable |
Type : boolean
|
Default value : true
|
|
Allows to disable filtering behaviour. |
| class |
Type : string
|
| model |
Type : any
|
| tabindex |
Type : string
|
| tooltip |
Type : string
|
| useCss |
Type : boolean
|
Default value : false
|
|
Property to know if the inline styles should not be applied. |
| ChangedEventsSequenceAction |
Type : EventEmitter<EventData>
|
| SelectedIndexChanged |
Type : EventEmitter<EventData>
|
| SelectionChangeCommitted |
Type : EventEmitter<EventData>
|
| DropDown |
Type : EventEmitter<EventData>
|
| DropDownClosed |
Type : EventEmitter<EventData>
|
| SelectedValueChanged |
Type : EventEmitter<EventData>
|
| ContextMenu |
Type : EventEmitter<EventData>
|
| DragDrop |
Type : EventEmitter<EventData>
|
| Enter |
Type : EventEmitter<EventData>
|
| GotFocus |
Type : EventEmitter<EventData>
|
| KeyDown |
Type : EventEmitter<KeyEventArgs>
|
| KeyPress |
Type : EventEmitter<EventData>
|
| KeyUp |
Type : EventEmitter<KeyEventArgs>
|
| Leave |
Type : EventEmitter<EventData>
|
| LostFocus |
Type : EventEmitter<EventData>
|
| MouseMove |
Type : EventEmitter<MouseEventArgs>
|
| Resize |
Type : EventEmitter<EventData>
|
| TextChanged |
Type : EventEmitter<EventData>
|
| Validated |
Type : EventEmitter<EventData>
|
| Validating |
Type : EventEmitter<EventData>
|
| applyFocus |
applyFocus()
|
|
Applies focus to input or selectable element in component. It triggers dom element focus()
Returns :
void
|
| change | ||||||
change(event: any)
|
||||||
|
Parameters :
Returns :
void
|
| executeChangeEvents | ||||||
executeChangeEvents(event: any)
|
||||||
Decorators :
@serverEvent('ChangedEventsSequenceAction')
|
||||||
|
Parameters :
Returns :
void
|
| executeTextChange | ||||||
executeTextChange(event: any)
|
||||||
Decorators :
@serverEvent('TextChanged')
|
||||||
|
Parameters :
Returns :
void
|
| fetchItems |
fetchItems()
|
|
Fetchs items
Returns :
void
|
| getComboboxClass |
getComboboxClass()
|
|
Gets the kendo-dropdownlist class to customize the dropDown seleted item.
Returns :
any
the kendo-dropdownlist class |
| getPopupClass |
getPopupClass()
|
|
Gets the kendo-popup class to customize the dropDown item's display.
Returns :
any
the kendo-popup settings. |
| getPopupSettings |
getPopupSettings()
|
|
Gets the kendo-pop up settings to customize the dropDown item's display.
Returns :
any
the kendo-popup settings. |
| getSuggestionSubscription |
getSuggestionSubscription()
|
|
Sets the suggestion subscription. When it's trigered sets the suggestion value, selected text and focused combo item
Returns :
Subscription
|
| handleFilter | ||||||||
handleFilter(value: string)
|
||||||||
|
Handles filter
Parameters :
Returns :
void
|
| keyDownHandler | ||||||
keyDownHandler(event: any)
|
||||||
|
KeyDown handler for the DropDownList style combo. The kendo component opens the popUp when the enter key is pressed This is not the behavior in the winforms control, so we need to close it.
Parameters :
Returns :
void
|
| ngAfterViewInit |
ngAfterViewInit()
|
|
Returns :
void
|
| ngDoCheck |
ngDoCheck()
|
|
Returns :
void
|
| ngOnDestroy |
ngOnDestroy()
|
|
Returns :
void
|
| ngOnInit |
ngOnInit()
|
|
Returns :
void
|
| openHandler | ||||||
openHandler(event: any)
|
||||||
|
Opens handler
Parameters :
Returns :
void
|
| removesStylesAppliedToCustomCombo | ||||||
removesStylesAppliedToCustomCombo(style: any)
|
||||||
|
removes the styles that don't need to be applied to the combo element and that were previosuly applied to the span element.
Parameters :
Returns :
any
|
| selectText |
selectText()
|
|
Selects the text of the combobox on focus
Returns :
void
|
| setDynamicStylesComboBox | ||||||
setDynamicStylesComboBox(style: any)
|
||||||
|
Sets dynamic styles to ComboBox. Some styles defined in dynamicStylesProps needs to be applied only to span to have the same behavior as original app.
Parameters :
Returns :
void
|
| setMyStyle |
setMyStyle()
|
|
Returns :
literal type
|
| setTextToCombo | ||||
setTextToCombo(value)
|
||||
|
Sets the text to combobox if the property text is different from the customValue text. Solution for bug ComboBox not refreshing the SelectedValue after loading information. Bug id 422453
Parameters :
Returns :
void
|
| Private setTextWithDisplayText | ||||||||
setTextWithDisplayText(currentValue: any)
|
||||||||
|
Apply text to input when has display text
Parameters :
Returns :
void
|
| shouldSuggest | ||||
shouldSuggest(value)
|
||||
|
Method to verify if the component should suggest a result
Parameters :
Returns :
boolean
boolean |
| valueChange | ||||||
valueChange(event: any)
|
||||||
|
This handle debouncing functionality for valueChange event
Parameters :
Returns :
void
|
| valueChangeEvent | ||||||
valueChangeEvent(event: any)
|
||||||
|
Event for handle value changes
Parameters :
Returns :
void
|
| close | ||||||||
close(event: any)
|
||||||||
Decorators :
@serverEvent('DropDownClosed')
|
||||||||
|
Trigger when the dropdownlist is closing
Parameters :
Returns :
void
|
| detectChangesExecution |
detectChangesExecution()
|
|
Execute the detectChanges() function on the subscription of the detectChanges, this subscription is in the control.component.ts WinForms
Returns :
void
|
| open | ||||||||
open(event: any)
|
||||||||
Decorators :
@serverEvent('DropDown')
|
||||||||
|
Trigger when the dropdownlist is openning
Parameters :
Returns :
void
|
| Private addModifierKey | ||||||
addModifierKey(keyCode: number)
|
||||||
|
Add a modifier key if it applies.
Parameters :
Returns :
void
|
| applyAnchorProperty |
applyAnchorProperty()
|
|
Applies anchor property
Returns :
void
|
| applyAutoSizeProperty |
applyAutoSizeProperty()
|
|
Applies auto size property Fix the current control dimensions to fit its content according to the autosize and autosizemode properties
Returns :
void
|
| blur | ||||||
blur(event: any)
|
||||||
Decorators :
@serverEvent('LostFocus')
|
||||||
|
Parameters :
Returns :
void
|
| bringToFront |
bringToFront()
|
|
Bring to the front the current control.
Returns :
void
|
| Private bringToFrontService |
bringToFrontService()
|
|
Bring to front service
Returns :
void
|
| Protected calculateTabOrder |
calculateTabOrder()
|
|
Calculates tab order according to model value and TabStop
Returns :
any
tab order |
| canSubscribeToErrorProvider |
canSubscribeToErrorProvider()
|
|
Returns true if the control is ready to subscribe to the ErroProvider.
Returns :
boolean
|
| changeChildEnableStatus |
changeChildEnableStatus(parent: any, value: boolean)
|
|
Property EnabledInternal: is used to check the original enabled state of any control. IMPORTANT: This property is modify only when the component is modified by himself its parent can't modify it
Returns :
void
|
| checkDetectChangesAfterLeave |
checkDetectChangesAfterLeave()
|
|
Over ride if the component need to check for changes after losses focus
Returns :
void
|
| checkErrorProvider |
checkErrorProvider()
|
|
This function handles the ErrorProvider for each component
Returns :
void
|
| contextMenu | ||||||
contextMenu(event: any)
|
||||||
|
Parameters :
Returns :
void
|
| createErrorProvider |
createErrorProvider()
|
|
Auxiliary function that creates the image of the errorProvider, this to reduce the cognitive complexity of the function checkErrorProvider
Returns :
void
|
| currentWebMapService |
currentWebMapService()
|
|
Current instance of the static WebMapService
Returns :
WebMapService
{*} |
| detectChanges |
detectChanges()
|
|
Triggers a detect change action
Returns :
void
|
| detectChangesSubscribe |
detectChangesSubscribe()
|
|
Each component that have the isForm as true should implement this method
Returns :
void
|
| dragDrop | ||||||||
dragDrop(event: any)
|
||||||||
Decorators :
@serverEvent('DragDrop', ControlComponent.dragDropEventArgsExtractor)
|
||||||||
|
Handles the dragdrop event. Should stop server propagation if allowdrop is false;
Parameters :
Returns :
boolean
|
| Static dragDropEventArgsExtractor | |||||||||
dragDropEventArgsExtractor(event: any, component: ControlComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| enter | ||||||
enter(event: any)
|
||||||
Decorators :
@serverEvent('Enter', ControlComponent.EnterEventArgsExtractor, undefined)
|
||||||
|
Parameters :
Returns :
void
|
| Static EnterEventArgsExtractor | |||||||||
EnterEventArgsExtractor(event: any, component: ControlComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| errorValueAux |
errorValueAux()
|
|
Auxiliary function that returns values in some especial cases, this to reduce the cognitive complexity of the function checkErrorProvider
Returns :
number
|
| focus | ||||||
focus(event: any)
|
||||||
Decorators :
@serverEvent('GotFocus')
|
||||||
|
Parameters :
Returns :
void
|
| getElementErrorProviderStyle | ||||||
getElementErrorProviderStyle(element)
|
||||||
|
Get the corresponding Style depending of the TagName
Parameters :
Returns :
string
|
| getElementsWidth |
getElementsWidth()
|
|
Calculate the total width, including all siblings elements.
Returns :
number
|
| getExtraElement |
getExtraElement()
|
|
Gets the extra element affecting the position of the error provider.
Returns :
any
|
| Protected getNewPositions |
getNewPositions()
|
|
Gets new positions Analyze the children components and get the new sizes for this control with the autoSizeMode
Returns :
literal type
new positions |
| getStyle |
getStyle()
|
|
Gets the new Style
Returns :
Style
|
| getStyleDisplay |
getStyleDisplay()
|
|
Method to allow each component to manage its own display property Example : {display: 'block'}
Returns :
string
|
| getType |
getType()
|
|
Gets string indicating the type
Returns :
string
type |
| getWrapperElement |
getWrapperElement()
|
|
Gets the wrapper element of the control in the DOM.
Returns :
any
|
| Private hideToolTipDirective |
hideToolTipDirective()
|
|
Hides tool tip directive
Returns :
void
|
| isBindedEvent | ||||||||
isBindedEvent(event: string)
|
||||||||
|
Indicates if an event is binded in the server or not.
Parameters :
Returns :
boolean
|
| isComponentReady |
isComponentReady()
|
|
Determines whether component is ready in the DOM
Returns :
boolean
true if component ready |
| Protected isCustomControl |
isCustomControl()
|
|
Check if this control is a custom editor for the c1flexgrid component. otherwise it returns False.
Returns :
boolean
Returns True if the control is within a custom editor column, otherwise it returns False. |
| isUserControl |
isUserControl()
|
|
Gets if is usercontrol or not
Returns :
boolean
|
| keyDown | ||||||
keyDown(event: any)
|
||||||
Decorators :
@serverEvent('KeyDown', ControlComponent.keyEventArgsExtractor)
|
||||||
|
Parameters :
Returns :
void
|
| Static keyEditEventArgsExtractor | |||||||||
keyEditEventArgsExtractor(event: any, component: ControlComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| Static keyEventArgsExtractor | |||||||||
keyEventArgsExtractor(event: any, component: ControlComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| keyPress | ||||||
keyPress(event: any)
|
||||||
Decorators :
@serverEvent('KeyPress', ControlComponent.keyPressEventArgsExtractor)
|
||||||
|
Parameters :
Returns :
void
|
| Static keyPressEventArgsExtractor | ||||||||||||
keyPressEventArgsExtractor(event: any, component: ControlComponent)
|
||||||||||||
|
Parameters :
Returns :
any
|
| keyUp | ||||||
keyUp(event: any)
|
||||||
Decorators :
@serverEvent('KeyUp', ControlComponent.keyEventArgsExtractor)
|
||||||
|
Parameters :
Returns :
void
|
| leave | ||||||
leave(event: any)
|
||||||
Decorators :
@serverEvent('Leave')
|
||||||
|
Parameters :
Returns :
void
|
| leaveEventsHandler | ||||||
leaveEventsHandler(event: any)
|
||||||
|
Triggers the leave-validating-validated events in the correct order.
Parameters :
Returns :
void
|
| markForCheck |
markForCheck()
|
|
Marks for check Marks component to be checked by the next detect changes action
Returns :
void
|
| mouseEnter | ||||||||
mouseEnter(event: any)
|
||||||||
|
Mouses enter Shows tooltip if need it
Parameters :
Returns :
void
|
| mouseLeave | ||||||||
mouseLeave(event: any)
|
||||||||
|
Mouses leave Hides tooltip if need it
Parameters :
Returns :
void
|
| mouseMove | ||||||
mouseMove(event: any)
|
||||||
|
MouseMove event emit the data for every mouseMove event
Parameters :
Returns :
void
|
| ngAfterViewChecked |
ngAfterViewChecked()
|
|
Returns :
void
|
| notifyErrorProvider |
notifyErrorProvider()
|
|
Auxiliary function notifying that the errorProvider has been rendered, this to reduce the cognitive complexity of the function checkErrorProvider
Returns :
void
|
| notifyEvent |
notifyEvent(eventName: string, event: any)
|
|
Notifies leave
Returns :
void
|
| Protected notifyParentAutoSize |
notifyParentAutoSize()
|
|
Notifies parent auto size
Returns :
void
|
| notifyWindowToBringTop | ||||||||
notifyWindowToBringTop(event: any)
|
||||||||
|
Notifies the window to bring top When a control is clicked or focused in the screen
Parameters :
Returns :
void
|
| processSpecialDock | ||||||||||||||||
processSpecialDock(component: ControlComponent, size: ISize, offsets: IOffsets)
|
||||||||||||||||
|
Process special dock for the current Control. you should override the method in the specify control.
Parameters :
Returns :
literal type
special dock. new size and offset for the dock context. |
| Private removeModifierKey | ||||||
removeModifierKey(keyCode: number)
|
||||||
|
Remove a modifier key if it applies.
Parameters :
Returns :
void
|
| Private removeStyleProperty | ||||||||
removeStyleProperty(property: string)
|
||||||||
|
Sets style property Updates model values for Style
Parameters :
Returns :
void
|
| resize | ||||||||
resize(event: any)
|
||||||||
Decorators :
@serverEvent('Resize')
|
||||||||
|
Trigger the event resize defined through the output member.
Parameters :
Returns :
void
|
| resolvePendingTabSubscriptions |
resolvePendingTabSubscriptions()
|
|
Resolves pending tab subscriptions for components that were resolved as pending parent
Returns :
void
|
| Protected setChildIndex |
setChildIndex()
|
|
Sets child index to HTML zindex property
Returns :
void
|
| setDisplayElementOriginalDimensions |
setDisplayElementOriginalDimensions()
|
|
Sets display element original dimensions
Returns :
void
|
| shouldApplyFocus |
shouldApplyFocus()
|
|
Determines whether applyFocus method should be called.
Returns :
boolean
true if apply focus |
| Private shouldValidateErrorProvider |
shouldValidateErrorProvider()
|
|
Determines if error provider should be validated
Returns :
boolean
true if it has to validate error provider |
| Private showTooltipDirective |
showTooltipDirective()
|
|
Shows tooltip directive
Returns :
void
|
| specialStyle |
specialStyle()
|
|
Specials style. Override this method if you want to handle special style for the dock
Returns :
void
style |
| Private startAnchorProcess |
startAnchorProcess()
|
|
Starts anchor process After rendering a new window the anchor process is triggered before the docking process to ensure that the measure to edges are correct and the anchor distances are calculated properly
Returns :
void
|
| subscribeErrorProvider |
subscribeErrorProvider()
|
|
This function handles the subscription to the ErrorProvider.
Returns :
void
|
| Private tooltipHandler |
tooltipHandler()
|
|
Tooltips handler
Returns :
void
|
| Protected updateDockProperty |
updateDockProperty()
|
|
compare if the dock is different and call the dockChange
Returns :
void
|
| validated | ||||||
validated(event: any)
|
||||||
Decorators :
@serverEvent('Validated')
|
||||||
|
Parameters :
Returns :
void
|
| validating | ||||||
validating(event: any)
|
||||||
Decorators :
@serverEvent('Validating')
|
||||||
|
Parameters :
Returns :
void
|
| verifyErrorProvider | ||||||
verifyErrorProvider(event: EventData)
|
||||||
|
Function that verifies that another component does not duplicate the same errorProvider
Parameters :
Returns :
void
|
| combo |
Type : KendoCombo
|
Decorators :
@ViewChild('comboBox', {static: false})
|
|
Reference to Kendo |
| customValue |
Type : any
|
Default value : {}
|
| debounceTime |
Type : number
|
Default value : 500
|
|
Debounce default time. |
| defaultDataUrl |
Type : string
|
Default value : 'api/combobox'
|
| dropDown |
Type : KendoDropDown
|
Decorators :
@ViewChild('dropDown', {static: false})
|
| dynamicStylesProps |
Type : []
|
Default value : ['color', 'background-color']
|
| executeChangesTimerId |
Type : any
|
|
This handle the debouncing functionality in executeChangeEvent |
| integralheight |
Type : number
|
Default value : 200
|
|
default height is 200px. |
| items |
Type : any[]
|
Default value : []
|
| loading |
Type : boolean
|
| previousUserInput |
Type : string
|
Default value : ''
|
| source |
Type : any[]
|
Default value : []
|
| suggestionSubject |
Type : Subject<Suggestion>
|
Default value : new Subject()
|
| suggestionSubscription |
Type : Subscription
|
| synchronizing |
Type : boolean
|
| valueNormalizer |
Default value : () => {...}
|
| virtual |
Type : any
|
Default value : {
itemHeight: 28
}
|
| Private _font |
Type : Font
|
| _model |
Type : any
|
| controlFlag |
Default value : true
|
|
The controlFlag help us to avoid twice calls. |
| detectChangesSubscription |
Type : string
|
|
Detect changes subscription of control component |
| displayElementInner |
Type : HTMLElement | undefined
|
|
the element that is shown in the DOM. Should be override in each component. |
| Private Static DIV_TAG |
Type : string
|
Default value : 'DIV'
|
| errorIsRendered |
Default value : false
|
|
This flag lets the controller know if the error provider has been rendered. |
| errorIsShowed |
Default value : false
|
|
This flag allows the controller to display the errorProvider. |
| hasErrorProviderSubscription |
Default value : false
|
|
Flag indicating whether the control has the error provider subscription. |
| isControlComponent |
Default value : true
|
|
Validate the component inherits from controlComponent or is an instance of controlComponent |
| isInsideGridCell |
Type : boolean
|
|
This should be set from the container where the component is going to be rendered Determines whether the component is render dynamically inside a grid cell(using a container mechanism like wm-container) |
| Static modifierKeys |
Default value : Keys.none
|
| originalHeight |
Type : number
|
|
Original height of control component |
| originalVisibility |
Type : boolean
|
|
Original visibility of control component Keeps a record of the current visible value to detect changes; |
| originalWidth |
Type : number
|
|
Original width of control component |
| registerManually |
Default value : false
|
|
A reference for managing component registration manually |
| shortcut |
Type : string
|
|
Shortcut property of basecontrolcomponent |
| showUnderline |
Default value : false
|
|
Property to trigger the underline of the shortcuts |
| style |
Type : Style
|
|
This object contains the style information for the component. |
| syncCompleteSubscription |
Type : string
|
|
Sync complete subscription of control component |
| tabDirective |
Type : ControlsDirective
|
Decorators :
@ViewChild(ControlsDirective, {static: false})
|
|
View child of tab directive |
| tooltipDir |
Type : TooltipDirective
|
Decorators :
@ViewChild(TooltipDirective)
|
|
View child of control component |
| triggerShortcutUnderlineSubscription |
Type : Subscription
|
|
Shortcut underline subcription of a component |
| afterFirstCall |
Default value : false
|
|
After first call of control component. Flag used to know if the control have been called in the ngAfterViewInit |
| anchorApplied |
Default value : -1
|
|
Anchor applied of control component Holds the currently applied anchor property -1 otherwise. |
| autoSizeApplied |
Default value : false
|
|
Auto size applied of control component |
| children |
Type : []
|
Default value : []
|
|
Controls of control component Array of controls that are children of this component |
| containerTabOrderService |
Type : ContainerTabOrderService
|
|
Container tab order service of control component base component |
| currentAutoSizeMode |
Default value : -1
|
|
Current auto size mode of control component |
| currentDock |
Type : number
|
Default value : 0
|
|
Current dock of control component |
| currentDockingOrder |
Type : []
|
Default value : []
|
|
Current docking order of control component. Array of children ids |
| customControl |
Default value : false
|
|
Custom control property obtains the value when is calculated in ngAfterViewInit, it determines if it is a component rendered inside of a custom control column of WFNETC1 WE SHOULD TRY TO REMOVE THIS PROPERTY, WINFORMS COMPONENTS SHOULD NOT KNOW THAT A COMPONENT FROM WFNETC1 EXISTS. |
| defaultControls |
Type : []
|
Default value : []
|
|
Default controls of control component. Internal array of the child with special docking |
| errorProviderIconWasCreated |
Type : boolean
|
|
Flag to know if the error provider icon is created. |
| internalTabOrder |
Type : any
|
|
Internal tab order of control component base component |
| isApplyingFocus |
Type : boolean
|
|
Optional flag to determine when the component is calling the applyFocus method. |
| lastErrorProviderMessage |
Default value : undefined
|
|
Last error provider message of control component base component to cached value and avoid multiple unnecessary function calls |
| lastZIndex |
Type : number
|
Default value : 0
|
|
Last zIndex of control component |
| originalTooltipText |
Type : string
|
|
Original tooltip text of control component base component |
| specialDock |
Default value : false
|
|
Special dock of control component. Mark to process the dock with special values |
| tabNodeReference |
Type : TabNode
|
|
Tab node reference of base control component |
| tooltipDisplayed |
Type : boolean
|
|
Tooltip displayed of control component base component |
| displayElementPanel | ||||||
setdisplayElementPanel(value: ElementRef)
|
||||||
|
Parameters :
Returns :
void
|
| autoCompleteSource |
getautoCompleteSource()
|
|
Return the AutoCompleteSource from the model
Returns :
AutoCompleteSource
|
| url |
geturl()
|
|
Returns the data source URL of this component.
Returns :
string
|
| selectedItem | ||||
getselectedItem()
|
||||
|
Returns the Selected Item
Returns :
any
|
||||
setselectedItem(value)
|
||||
|
Parameters :
Returns :
void
|
| selectedIndex | ||||||
getselectedIndex()
|
||||||
|
Returns the Selected Index
Returns :
number
|
||||||
setselectedIndex(index: number)
|
||||||
|
Set the Selected Index
Parameters :
Returns :
void
|
| text | ||||||
gettext()
|
||||||
|
Gets text of current combo box, return null as default value to validate against empty values.
Returns :
string
|
||||||
settext(value: string)
|
||||||
|
Sets text for current combo box
Parameters :
Returns :
void
|
| dropDownStyle |
getdropDownStyle()
|
| autoCompleteMode |
getautoCompleteMode()
|
|
Gets the AutoComplete value flag
Returns :
number
|
| showSuggestionList |
getshowSuggestionList()
|
|
Gets the showSuggestionList value flag
Returns :
boolean
|
| isAppendAutoComplete |
getisAppendAutoComplete()
|
|
Determines whether append auto complete is |