File

src/components/kendoUI/apex/tdbnumber/tdbnumber.component.ts

Description

Class for the TDBNumberComponent of Apex

Extends

ControlComponent

Implements

AfterContentInit AfterViewChecked

Metadata

Index

Properties
Methods
Inputs
Outputs
Accessors

Constructor

constructor(chDetector: ChangeDetectorRef, rnderer2: Renderer2, elemen: ElementRef, webComponents: WebComponentsService, maskservice: MaskService, intl: IntlService, baseValidatorService: BaseValidatorService, bringTopServe: BringTopService, containerInteraction?: ContainerInteractionService)
Parameters :
Name Type Optional
chDetector ChangeDetectorRef No
rnderer2 Renderer2 No
elemen ElementRef No
webComponents WebComponentsService No
maskservice MaskService No
intl IntlService No
baseValidatorService BaseValidatorService No
bringTopServe BringTopService No
containerInteraction ContainerInteractionService Yes

Inputs

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.

Outputs

Change
Type : EventEmitter<EventData>

Event emitter for change event

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>

Methods

adjustCaret
adjustCaret()

Adjust caret position after value modified

Returns : void
adjustSelStartWHenFocus
adjustSelStartWHenFocus()

When component got focus adjust SelStart.

Returns : void
afterValueChange
afterValueChange(event)

afterValueChange Cycle

Parameters :
Name Optional
event No
Returns : void
areDecimalsOptional
areDecimalsOptional(mask: string)

Validates if the decimal places of the mask are optional

Parameters :
Name Type Optional Description
mask string No

to validate

Returns : boolean
assignDisplayFormat
assignDisplayFormat()

Assign displayFormat

Returns : void
assignSuffixPrefixDisplayFormat
assignSuffixPrefixDisplayFormat()

Checks for current display format suffix and prefix

Returns : void
assignSuffixPrefixFormat
assignSuffixPrefixFormat()

Checks for current format suffix and prefix

Returns : void
blur
blur(event: any)

Method to handle the blur of the component

Parameters :
Name Type Optional
event any No
Returns : void
changeServerEvent
changeServerEvent(event: EventData)
Decorators :
@serverEvent('Change', TDNumberExtractor.changeEventArgsExtractor)

Method to send the change event to the server

Parameters :
Name Type Optional
event EventData No
Returns : void
checkCaretForDecimalPlaces
checkCaretForDecimalPlaces(pos: number)

Checks for cursor on decimal places and moves to convenient position

Parameters :
Name Type Optional
pos number No
Returns : number
decimalOverflow
decimalOverflow(trueNumber: string)

Verifies if decimals are overflow

Parameters :
Name Type Optional
trueNumber string No
Returns : boolean
deleteDecimalWhendot
deleteDecimalWhendot(newValue: string, previousValue: string)

Validates deleting before dot

Parameters :
Name Type Optional
newValue string No
previousValue string No
Returns : string

{string}

focus
focus(event: any)

Focus event handler Here the selStart and selEnd are setted to the input

Parameters :
Name Type Optional
event any No
Returns : void
getDisplayElement
getDisplayElement()

Get the display element

Returns : any
keyDown
keyDown(event: KeyboardEvent)

Method to handle the keydown event

Parameters :
Name Type Optional
event KeyboardEvent No
Returns : void
keyDownServerEvent
keyDownServerEvent(event: EventData)
Decorators :
@serverEvent('KeyDownEvent', TDNumberExtractor.KeyDownArgsExtractor)

Method to send the keyDown to the server

Parameters :
Name Type Optional
event EventData No
Returns : void
keyPress
keyPress(event: KeyboardEvent)

Method to handle the keyPress event

Parameters :
Name Type Optional
event KeyboardEvent No
Returns : void
keyPressServerEvent
keyPressServerEvent(event: EventData)
Decorators :
@serverEvent('KeyPressEvent', TDNumberExtractor.KeyPressArgsExtractor)

Method to send the keypress to the server

Parameters :
Name Type Optional
event EventData No
Returns : void
manualRoundValidation
manualRoundValidation(trueNumber: string)

Validates last character of string when decimals to avoid automatinc kendo rounding.

Parameters :
Name Type Optional
trueNumber string No
Returns : any
ngAfterContentInit
ngAfterContentInit()

ngAfterContentInit cycle

Returns : void
ngAfterViewChecked
ngAfterViewChecked()

After view checked event

Returns : void
selectionInDecimal
selectionInDecimal(pos: number)

Verifies user is in decimal spaces.

Parameters :
Name Type Optional
pos number No
Returns : boolean

{boolean}

setCaretWhenvalueChange
setCaretWhenvalueChange()

When value change sets caret using right to left, using negative number.

Returns : void
updateDeleteValidations
updateDeleteValidations()

Sets delete validations to default state.

Returns : void
validateFormat
validateFormat(event: string)

Validates format in runtime.

Parameters :
Name Type Optional
event string No
Returns : void
validateMinMax
validateMinMax(value: number)

Method to validate the value is between the MinValue and MaxValue

Parameters :
Name Type Optional
value number No
Returns : boolean

{boolean}

validateSelstart
validateSelstart()

Validates selection start. if default value is set, cursor must be moved to a friendly position when user start to write.

Returns : void
validateTexFormatMaxMin
validateTexFormatMaxMin(value: number, texFormated: string)

Validates if max min is correct

Parameters :
Name Type Optional
value number No
texFormated string No
Returns : any
validateValueTextChanged
validateValueTextChanged()

Verifies all values sync

Returns : void
valueChange
valueChange(event: string)

Value change is triggered when textbox value has changed

Parameters :
Name Type Optional
event string No
Returns : void
valueChangeValidateFormat
valueChangeValidateFormat(event: string)

Applies validate format and adjust caret when valueChange

Parameters :
Name Type Optional
event string No
Returns : void
valueStyle
valueStyle()

ClassValue style

Returns : string

{string}

Private addModifierKey
addModifierKey(keyCode: number)

Add a modifier key if it applies.

Parameters :
Name Type Optional
keyCode number No
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
applyFocus
applyFocus()

Applies focus to input or selectable element in component. It triggers dom element focus()

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
change
change(event: any)
Decorators :
@serverEvent('TextChanged')
Parameters :
Name Type Optional
event any No
Returns : void
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

Parameters :
Name Type Optional
parent any No
value boolean No
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 :
Name Type Optional
event any No
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
Protected detectChangesExecution
detectChangesExecution()

This function should be overridden on the components that need the detectChanges() function to be called on the subscription of the detect changes

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 :
Name Type Optional Description
event any No

the drop data

Returns : boolean
Static dragDropEventArgsExtractor
dragDropEventArgsExtractor(event: any, component: ControlComponent)
Parameters :
Name Type Optional
event any No
component ControlComponent No
Returns : any
enter
enter(event: any)
Decorators :
@serverEvent('Enter', ControlComponent.EnterEventArgsExtractor, undefined)
Parameters :
Name Type Optional
event any No
Returns : void
Static EnterEventArgsExtractor
EnterEventArgsExtractor(event: any, component: ControlComponent)
Parameters :
Name Type Optional
event any No
component ControlComponent No
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
getElementErrorProvider
getElementErrorProvider(element)

Get the corresponding element depending of the TagName

Parameters :
Name Optional Description
element No

The current element

Returns : HTMLElement
getElementErrorProviderStyle
getElementErrorProviderStyle(element)

Get the corresponding Style depending of the TagName

Parameters :
Name Optional Description
element No

The current element

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 :
Name Type Optional Description
event string No

The name of the event in the server.

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
Static keyEditEventArgsExtractor
keyEditEventArgsExtractor(event: any, component: ControlComponent)
Parameters :
Name Type Optional
event any No
component ControlComponent No
Returns : any
Static keyEventArgsExtractor
keyEventArgsExtractor(event: any, component: ControlComponent)
Parameters :
Name Type Optional
event any No
component ControlComponent No
Returns : any
Static keyPressEventArgsExtractor
keyPressEventArgsExtractor(event: any, component: ControlComponent)
Parameters :
Name Type Optional Description
event any No

event to call

component ControlComponent No

component used to get the id.

Returns : any
keyUp
keyUp(event: any)
Decorators :
@serverEvent('KeyUp', ControlComponent.keyEventArgsExtractor)
Parameters :
Name Type Optional
event any No
Returns : void
leave
leave(event: any)
Decorators :
@serverEvent('Leave')
Parameters :
Name Type Optional
event any No
Returns : void
leaveEventsHandler
leaveEventsHandler(event: any)

Triggers the leave-validating-validated events in the correct order.

Parameters :
Name Type Optional
event any No
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 :
Name Type Optional Description
event any No

the current js event object

Returns : void
mouseLeave
mouseLeave(event: any)

Mouses leave Hides tooltip if need it

Parameters :
Name Type Optional Description
event any No

the current js event object

Returns : void
mouseMove
mouseMove(event: any)

MouseMove event emit the data for every mouseMove event

Parameters :
Name Type Optional
event any No
Returns : void
ngAfterViewInit
ngAfterViewInit()
Returns : void
ngDoCheck
ngDoCheck()

It is necessary to check continuously if the Control has an error, for that reason the function checkErrorProvider must be call on the ngDoCheck

Returns : void
ngOnDestroy
ngOnDestroy()
Returns : void
ngOnInit
ngOnInit()
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

Parameters :
Name Type Optional Description
eventName string No
event any No

the current event

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 :
Name Type Optional Description
event any No

The current javascript event

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 :
Name Type Optional Description
component ControlComponent No

child component

size ISize No

parentSize

offsets IOffsets No
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 :
Name Type Optional
keyCode number No
Returns : void
Private removeStyleProperty
removeStyleProperty(property: string)

Sets style property Updates model values for Style

Parameters :
Name Type Optional Description
property string No

current property to update

Returns : void
resize
resize(event: any)
Decorators :
@serverEvent('Resize')

Trigger the event resize defined through the output member.

Parameters :
Name Type Optional Description
event any No

The event object.

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
setMyStyle
setMyStyle()

Returns a valid style object to be applied according to the styling information set in the control's model

Returns : literal type
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 :
Name Type Optional
event any No
Returns : void
validating
validating(event: any)
Decorators :
@serverEvent('Validating')
Parameters :
Name Type Optional
event any No
Returns : void
verifyErrorProvider
verifyErrorProvider(event: EventData)

Function that verifies that another component does not duplicate the same errorProvider

Parameters :
Name Type Optional
event EventData No
Returns : void

Properties

Private _prefix
Type : string

prefix of mask

Private _suffix
Type : string

Suffix of mask

backspace
Default value : false

Backspace validation Validation created because when input applies mask format, caret is incorrectly positioned.

caret
Type : number
Default value : 0

Caret value of texbox

controlValue
Type : string
Default value : ''

This is switched between the value and text of the control

currentText
Type : string
Default value : ''

Current text value

decimalPointAdded
Default value : false

Flag to check when a decimal point is added

Static defaultNegativeColor
Type : string
Default value : 'red'

TDnumber defaultNegativeColor

deleteValidation
Default value : false

Delete validation. Validation created because when input applies mask format, caret is incorrectly positioned.

Public intl
Type : IntlService
show
Default value : false

Is used to validate if popup should be opened

textBox
Type : TextBoxComponent
Decorators :
@ViewChild(TextBoxComponent)

Textbox component

validateFirstFocusedAndZeroValue
Default value : false

Flag to check when the control is focused for the first time and the value is 0 This is used to put the cursor in the right position when the user starts typing

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

Accessors

formatMaskedValueLength
getformatMaskedValueLength()

Format Masked value length

Returns : number
suffix
getsuffix()

Suffix mask

Returns : string
setsuffix(suffix: string)

suffix mask.

Parameters :
Name Type Optional
suffix string No
Returns : void
prefix
getprefix()

Prefix mask

Returns : string
setprefix(prefix: string)

Prefix mask

Parameters :
Name Type Optional
prefix string No
Returns : void
text
gettext()

Get Text

settext(text: string)

Set Text

Parameters :
Name Type Optional
text string No
Returns : void
ctlText
getctlText()

Gets the CtlText value from the model

Returns : string
setctlText(value: string)

Sets the value of CtlText in the model

Parameters :
Name Type Optional
value string No
Returns : void
negativeColor
getnegativeColor()

Gets the CtlText value from the model

Returns : string
format
getformat()

Get Mask format.

setformat(format: string)

Set mask format.

Parameters :
Name Type Optional
format string No
Returns : void
value
getvalue()

Gets the value of the component

Returns : number
setvalue(value: number)

Sets the value of the component

Parameters :
Name Type Optional
value number No
Returns : void
enabled
getenabled()

Gets the Enabled value from the model

Returns : boolean
selStart
getselStart()

Gets the SelStart from the model

Returns : number
setselStart(value: number)

sets selectionStart.

Parameters :
Name Type Optional
value number No
Returns : void
selLength
getselLength()

Gets the SelLength from the model

Returns : number
minValue
getminValue()

Gets the minValue from the model

Returns : any
maxValue
getmaxValue()

Gets the MaxValue from the model

Returns : any
displayElement
getdisplayElement()

Gets display element calculated using getDisplayElement function

Returns : HTMLElement | undefined
setdisplayElement(value: HTMLElement | undefined)

Sets displayElement innerProperty

Parameters :
Name Type Optional
value HTMLElement | undefined No
Returns : void
Legend
Html element
Component
Html element with directive

results matching ""

    No results matching ""