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

File

projects/i-components/src/lib/components/check-box/check-box.component.ts

Description

Angular Component for the CheckBox Control.

Extends

BaseComponent

Implements

OnInit AfterContentInit AfterViewInit

Metadata

changeDetection ChangeDetectionStrategy.OnPush
selector wm-check-box
styleUrls ./check-box.component.scss
templateUrl ./check-box.component.html

Index

Properties
Methods
Inputs
Outputs
HostBindings
Accessors

Constructor

Public constructor(injector: Injector, element: ElementRef, renderer: Renderer2, cdRef: ChangeDetectorRef, injectedModel: CheckBoxModel)
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:271

Creates an instance of CheckBoxComponent.

Parameters :
Name Type Optional
injector Injector No
element ElementRef No
renderer Renderer2 No
cdRef ChangeDetectorRef No
injectedModel CheckBoxModel No

Inputs

checkBackground
Type : string
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:187

Gets the background color for the check.
command
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:93

Sets the command.
content
Type : any
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:127

Sets the Content model property for the control
fontWeight
Type : string
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:391

Value used to set the font weight for model
foreground
Type : any
Inherited from BaseComponent
Defined in BaseComponent:153

Sets the value of the Foreground property
isChecked
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:314

Property used to save the state of the checkbox.
model
Type : CheckBoxModel
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:145

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Property used to set the canvas zindex value.

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

Outputs

checked
Type : EventEmitter<any>
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:237

Event Emitter. Event Emitter normally called in the onChange event.
click
Type : EventEmitter<any>
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:227

Event Emitter. Event Emitter normally called in the onChange event.
commandChange
Type : EventEmitter<boolean>
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:217

output to emit the new value of the command
isEnabledChange
Type : EventEmitter<boolean>
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:208

output to emit the new value of the isEnabled
unchecked
Type : EventEmitter<any>
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:247

Event Emitter. Event Emitter normally called in the onChange 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.

HostBindings

class.wmControlIsEnabledFalse
Type : boolean
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:303

Set a class to disable the checkbox.
class
Type : string
Default value : null
Inherited from BaseComponent
Defined in BaseComponent:407

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sets the z-index style.

Methods

applyPaddingStyle
applyPaddingStyle()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:438

Applies the padding to the parent dom element of the regularContent reference by getting the padding assigned to the component by a css class

Returns : void

{*}
getDynamicComponent
getDynamicComponent()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:456

Method that returns the component to render

Returns : void

{*}
getParentNodeOfRegularContent
getParentNodeOfRegularContent()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:427

Method that returns the parent dom element of the regularContent reference

Returns : any

{*}
keyDownHandler
keyDownHandler(event: any)
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:571

key down handler

Parameters :
Name Type Optional
event any No
Returns : void
modelChangeHandler
modelChangeHandler(name: string)
Inherited from BaseComponent
Defined in BaseComponent:470

Handler for the change in the model's properties.

Parameters :
Name Type Optional
name string No
Returns : void
mouseUpHandler
mouseUpHandler(ev: MouseEvent)
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:603

"If the mouse is up, then stop the propagation of the event."

The above function is called when the mouse is up.

Parameters :
Name Type Optional Description
ev MouseEvent No
  • MouseEvent - The event object.
Returns : void
ngAfterContentInit
ngAfterContentInit()
Inherited from BaseComponent
Defined in BaseComponent:514

Angular lifecycle.

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

Angular lifecycle.

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

Angular lifecycle.

Returns : void
onChange
onChange(state: boolean)
Decorators :
@stopEventPropagation()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:411

Event Handler for when the user interacts with the checkbox changing the state. This handler is called when the change event of the DOM element is triggered. Note: Since is binded to a pointerDown there are some scenarios where it needs to be delayed, because it need to be executed after a click event.

Parameters :
Name Type Optional
state boolean No
Returns : void
setCheckBackground
setCheckBackground()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:500

Set the check background color.

Returns : void
Protected setInputDiv
setInputDiv()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:585

Creates a container div for the input's validation messages

Returns : void
setLabelColor
setLabelColor()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:489

Set the label text color according to model foreground.

Returns : void
Protected alignmentHandler
alignmentHandler()
Inherited from BaseComponent
Defined in BaseComponent:2346

Calculate the values for the grid size behavior from the alignments

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

Apply pending assignments to properties with property values

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

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

memberof BaseComponent

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

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

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

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

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

Parameters :
Name Type Optional Description
property string No

the name of the property to check for
value any No

the property value
Returns : boolean

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

Checks if the element exists previously in the items collection

Parameters :
Name Type Optional Description
collection any No

The control items collection
itemToCheck any No

The static element to be reviewed
Returns : number

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

Create a given component on the HTML body.

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

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

Returns : string

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

Performs a single detect Changes over the component

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

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

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

Calculates the Foreground color to be applied

Returns : string

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

Returns string path to the image.

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

Returns the value from a $event

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

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

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

Applies the height CSS value

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

Calculates the auto height value

Returns : string

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

Assign all the horizontal bindings for the control

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

Assign all the vertical bindings for the control

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

Returns the path of the given image.

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

The static elements to be added
itemsCollection any No

The control items collection
Returns : void

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

Marks current component

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

Event Handler for when the mouse enter the Image component.

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

Event Handler for when the mouse enter the Image component.

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

Angular Lifecycle Hooks

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

Angular Lifecycle Hooks

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

Angular Lifecycle Hooks

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

Angular Lifecycle Hooks

Returns : void
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 :
Name Type Optional
itemsToRender any No
items any No
contentChildTemplate any No
afterContentInitCalled boolean No
injector Injector No
Returns : any[]
processAlignments
processAlignments(name: string)
Inherited from BaseComponent
Defined in BaseComponent:1704

Method to check if the component should assign a alignment property

Parameters :
Name Type Optional
name string No
Returns : void

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

Method to set the cursor style of the component

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

Method to set custom CSS Clases

Parameters :
Name Type Optional
name string No
Returns : void

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

Method to check and set the height of the grid

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

Process the FontFamily property

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

Method to apply the font styles for the component.

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

Process the FontSize property

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

Process the FontStyle property

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

Process the FontWeight property

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

Method to check and set the height of the grid

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

Process changes to IsEnabled property.

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

Method to apply the opacity for the component.

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

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

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

Method to check and set the width of the grid

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

Method to process the ZIndex when set through the model

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

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

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

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

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

Registers a DOM handler on the current element

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

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

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

Registers mouse events if required

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

Register observers from the given EventEmitter into the given SubscriptionEvent.

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

Registers a tooltip to a component

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

Clean up the handlers when the component is destroyed

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

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

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

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

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

Adds the references to the dependency components

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

Syncs the modelProxy with model

Parameters :
Name Type Optional
model FrameworkElement No
Returns : void

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

Updates the tooltip associated to a component

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

Syncs validation information with component properties

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

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

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

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

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

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

Unregisters a tooltip to a component

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

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

Parameters :
Name Type Optional Description
element Element No

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

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

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

Applies the width CSS value

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

Calculates the auto width value

Returns : string

{string}

Properties

Private _checkBackground
Type : string
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:178

Stores the value for the checkBackground property.
checkContent
Type : any
Decorators :
@ContentChild('Content', {static: true})
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:120

Content of the component, statically added.
checked
Type : EventEmitter<any>
Default value : new EventEmitter()
Decorators :
@Output()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:237

Event Emitter. Event Emitter normally called in the onChange event.
click
Type : EventEmitter<any>
Default value : new EventEmitter()
Decorators :
@Output()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:227

Event Emitter. Event Emitter normally called in the onChange event.
commandChange
Type : EventEmitter<boolean>
Default value : new EventEmitter()
Decorators :
@Output()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:217

output to emit the new value of the command
displayElement
Type : any
Default value : undefined
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:262

Contains the element to render
igxCheckbox
Type : IgxCheckboxComponent
Decorators :
@ViewChild('igxCheckbox')
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:86

Reference to the checkbox component
isEnabledChange
Type : EventEmitter<boolean>
Default value : new EventEmitter()
Decorators :
@Output()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:208

output to emit the new value of the isEnabled
model
Type : CheckBoxModel
Decorators :
@Input()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:145

Object with properties and events for the checkbox.
Public modelProxy
Type : CheckBoxModel
Default value : ModelProxy.create<CheckBoxModel>()
Inherited from BaseComponent
Defined in BaseComponent:271

ModelProxy is a copy of the model, used on the component initial building to prevent crashes with external bindings.
regularContent
Type : any
Decorators :
@ViewChild('regularContent')
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:77

Reference to the content
renderContent
Default value : true
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:254

Flag that allows the content rendering for static components or render dynamics.
unchecked
Type : EventEmitter<any>
Default value : new EventEmitter()
Decorators :
@Output()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:247

Event Emitter. Event Emitter normally called in the onChange event.
actualSizeCalled
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:481

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sets the z-index style.
isInitialized
Type : any
Default value : undefined
Inherited from BaseComponent
Defined in BaseComponent:523

Flag to know if the component is ready to render
isInternalInherit
Default value : false
Inherited from BaseComponent
Defined in BaseComponent:515

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Property for specifying validation error message

Accessors

command
getcommand()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:109

Gets the command.

Returns : ICommand
setcommand(value: ICommand)
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:93

Sets the command.

Parameters :
Name Type Optional
value ICommand No
Returns : void
content
setcontent(value: any)
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:127

Sets the Content model property for the control

Parameters :
Name Type Optional
value any No
Returns : void
foreground
getforeground()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:164

Gets the value of the Foreground property

Returns : any
setforeground(value: any)
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:153

Sets the value of the Foreground property

Parameters :
Name Type Optional
value any No
Returns : void
checkBackground
getcheckBackground()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:187

Gets the background color for the check.

Returns : string
setcheckBackground(value: string)
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:196

Sets the background color for the check.

Parameters :
Name Type Optional
value string No
Returns : void
isEnabledFalse
getisEnabledFalse()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:303

Set a class to disable the checkbox.

Returns : boolean
isChecked
getisChecked()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:333

Gets the value for the IsChecked property in the model

Returns : unknown
setisChecked(value: unknown)
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:314

Property used to save the state of the checkbox.

Parameters :
Name Type Optional
value unknown No
Returns : void
checkedValue
getcheckedValue()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:344

Gets the isChecked value property from the CheckBoxModel.

Returns : boolean
setcheckedValue(value: boolean)
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:354

Sets the isChecked value property for the CheckBoxModel.

Parameters :
Name Type Optional
value boolean No
Returns : void
contentValue
getcontentValue()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:372

Gets the content value for the model

Returns : any
setcontentValue(value: any)
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:363

Sets the content value for the model

Parameters :
Name Type Optional
value any No
Returns : void
fontWeight
getfontWeight()
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:382

property used to set the font weight for the text block

Returns : string
setfontWeight(value: string)
Defined in projects/i-components/src/lib/components/check-box/check-box.component.ts:391

Value used to set the font weight for model

Parameters :
Name Type Optional
value string No
Returns : void 
import {
  AfterContentInit,
  AfterViewInit,
  ChangeDetectionStrategy,
  ChangeDetectorRef,
  Component,
  ContentChild,
  ElementRef,
  EventEmitter,
  HostBinding,
  Injector,
  Input,
  OnInit,
  Optional,
  Output,
  Renderer2,
  ViewChild,
} from '@angular/core';
import {
  AngularComponentId,
  CheckBoxModel,
  ComponentId,
  ICommand,
  ModelProxy,
  RoutedEventArgs,
  smColorToCssColor,
  SolidColorBrush,
} from '@mobilize/wms-framework';
import { IgxCheckboxComponent } from 'igniteui-angular';
import { stopEventPropagation } from '../../decorators/stopEventPropagation';
import { Utils } from '../../utils/utilities';
import { BaseComponent } from '../base/base.component';

/**
 * Angular Component for the CheckBox Control.
 *
 * @export
 * @class CheckBoxComponent
 * @extends {BaseComponent}
 * @implements {OnInit}
 * @implements {AfterContentInit}
 * @implements {AfterViewInit}
 */
@Component({
  selector: 'wm-check-box',
  templateUrl: './check-box.component.html',
  styleUrls: ['./check-box.component.scss'],
  changeDetection: ChangeDetectionStrategy.OnPush,
})
@ComponentId([AngularComponentId.checkBox])
export class CheckBoxComponent
  extends BaseComponent
  implements OnInit, AfterContentInit, AfterViewInit
{
  /**
   * Reference to the content
   *
   * @memberof CheckBoxComponent
   */
  @ViewChild('regularContent')
  regularContent: any;

  /**
   * Reference to the checkbox component
   *
   * @type {IgxCheckboxComponent}
   * @memberof CheckBoxComponent
   */
  @ViewChild('igxCheckbox')
  igxCheckbox: IgxCheckboxComponent;

  /**
   * Sets the command.
   *
   * @memberof CheckBoxComponent
   */
  @Input() set command(value: ICommand) {
    if (
      !this.checkAndRegisterCompatibilityBinding(
        CheckBoxModel.CommandProperty,
        value
      )
    ) {
      this.modelProxy.Command = value;
    }
  }

  /**
   * Gets the command.
   *
   * @memberof CheckBoxComponent
   */
  get command(): ICommand {
    return this.model.Command;
  }

  /**
   * Content of the component, statically added.
   *
   * @type {*}
   * @memberof CheckBoxComponent
   */
  @ContentChild('Content', { static: true })
  checkContent: any;

  /**
   * Sets the Content model property for the control
   *
   * @memberof CheckBoxComponent
   */
  @Input() set content(value: any) {
    if (
      !this.checkAndRegisterCompatibilityBinding(
        CheckBoxModel.ContentProperty,
        value
      )
    ) {
      this.modelProxy.Content = value;
    }
  }

  /**
   * Object with properties and events for the checkbox.
   *
   * @type {CheckBoxModel}
   * @memberof CheckBoxComponent
   */
  @Input()
  model: CheckBoxModel;

  /**
   * Sets the value of the Foreground property
   *
   * @memberof CheckBoxComponent
   */
  @Input()
  set foreground(value: any) {
    super.foreground = value;
  }

  /**
   * Gets the value of the Foreground property
   *
   * @readonly
   * @type {*}
   * @memberof CheckBoxComponent
   */
  get foreground(): any {
    if (this.model.Foreground instanceof SolidColorBrush) {
      return smColorToCssColor(this.model.Foreground.Color);
    }
    return this.model.Foreground;
  }

  /**
   * Stores the value for the `checkBackground` property.
   *
   * @private
   * @type {string}
   * @memberof CheckBoxComponent
   */
  private _checkBackground: string;

  /**
   * Gets the background color for the check.
   *
   * @type {string}
   * @memberof CheckBoxComponent
   */
  @Input()
  get checkBackground(): string {
    return this._checkBackground;
  }

  /**
   * Sets the background color for the check.
   *
   * @memberof CheckBoxComponent
   */
  set checkBackground(value: string) {
    this._checkBackground = value;
    this.setCheckBackground();
  }

  /**
   * output to emit the new value of the isEnabled
   *
   * @type {EventEmitter<any>}
   * @memberof CheckBoxComponent
   */
  @Output()
  isEnabledChange: EventEmitter<boolean> = new EventEmitter();

  /**
   * output to emit the new value of the command
   *
   * @type {EventEmitter<any>}
   * @memberof CheckBoxComponent
   */
  @Output()
  commandChange: EventEmitter<boolean> = new EventEmitter();

  /**
   * Event Emitter.
   * Event Emitter normally called in the onChange event.
   *
   * @type {EventEmitter<any>}
   * @memberof CheckBoxComponent
   */
  @Output()
  click: EventEmitter<any> = new EventEmitter();

  /**
   * Event Emitter.
   * Event Emitter normally called in the onChange event.
   *
   * @type {EventEmitter<any>}
   * @memberof CheckBoxComponent
   */
  @Output()
  checked: EventEmitter<any> = new EventEmitter();

  /**
   * Event Emitter.
   * Event Emitter normally called in the onChange event.
   *
   * @type {EventEmitter<any>}
   * @memberof CheckBoxComponent
   */
  @Output()
  unchecked: EventEmitter<any> = new EventEmitter();

  /**
   * Flag that allows the content rendering for static components or render dynamics.
   *
   * @memberof CheckBoxComponent
   */
  renderContent = true;

  /**
   * Contains the element to render
   *
   * @type {*}
   * @memberof CheckBoxComponent
   */
  displayElement: any = undefined;

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

  /**
   * Creates an instance of CheckBoxComponent.
   *
   * @param {Injector} injector
   * @param {ElementRef} element
   * @param {Renderer2} renderer
   * @param {ChangeDetectorRef} cdRef
   * @param {CheckBoxModel} [injectedModel=null]
   * @memberof CheckBoxComponent
   */
  /* istanbul ignore next */
  public constructor(
    private injector: Injector,
    private element: ElementRef,
    private renderer: Renderer2,
    private cdRef: ChangeDetectorRef,
    @Optional() protected injectedModel: CheckBoxModel = null
  ) {
    super(cdRef, injector);
    this.model = injectedModel;
  }

  /**
   * Set a class to disable the checkbox.
   *
   * @readonly
   * @type {boolean}
   * @memberof CheckBoxComponent
   */
  @HostBinding('class.wmControlIsEnabledFalse')
  get isEnabledFalse(): boolean {
    return !this.isEnabled;
  }

  /**
   * Property used to save the state of the checkbox.
   *
   * @type {boolean}
   * @memberof CheckBoxComponent
   */
  @Input()
  set isChecked(value: unknown) {
    if (
      !this.checkAndRegisterCompatibilityBinding(
        CheckBoxModel.IsCheckedProperty,
        value
      ) &&
      typeof value === 'boolean'
    ) {
      this.modelProxy.IsChecked = value;
    }
  }

  /**
   * Gets the value for the IsChecked property in the model
   *
   * @readonly
   * @type {boolean}
   * @memberof CheckBoxComponent
   */
  get isChecked(): unknown {
    return this.modelProxy.IsChecked;
  }

  /**
   * Gets the isChecked value property from the CheckBoxModel.
   *
   * @readonly
   * @type {boolean}
   * @memberof CheckBoxComponent
   */
  get checkedValue(): boolean {
    return this.model.IsChecked;
  }

  /**
   * Sets the isChecked value property for the CheckBoxModel.
   *
   * @type {boolean}
   * @memberof CheckBoxComponent
   */
  set checkedValue(value: boolean) {
    this.model.IsChecked = value;
  }

  /**
   * Sets the content value for the model
   *
   * @memberof CheckBoxComponent
   */
  set contentValue(value: any) {
    this.model.Content = value;
  }

  /**
   * Gets the content value for the model
   *
   * @memberof CheckBoxComponent
   */
  get contentValue(): any {
    return this.model.Content;
  }
  /**
   * property used to set the font weight for the text block
   *
   * @readonly
   * @type {string}
   * @memberof CheckBoxComponent
   */
  get fontWeight(): string {
    return Utils.getFontWeight(this.model.FontWeight);
  }

  /**
   * Value used to set the font weight for model
   *
   * @memberof CheckBoxComponent
   */
  @Input() set fontWeight(value: string) {
    if (
      !this.checkAndRegisterCompatibilityBinding(
        CheckBoxModel.FontWeightProperty,
        value
      )
    ) {
      this.modelProxy.FontWeight = value;
    }
  }
  /**
   * Event Handler for when the user interacts with the checkbox changing the state.
   * This handler is called when the change event of the DOM element is triggered.
   * Note: Since is binded to a pointerDown there are some scenarios where it needs to be delayed,
   * because it need to be executed after a click event.
   *
   * @param {boolean} state
   * @memberof CheckBoxComponent
   */
  @stopEventPropagation()
  onChange(state: boolean): void {
    setTimeout(() => {
      this.isChecked = !state;
      const args = new RoutedEventArgs();
      args.OriginalSource = this.model;
      this.model.Click.fire([this.model, args]);
      this.model.Command?.Execute();
    }, 0);
  }

  /**
   * Method that returns the parent dom element of the regularContent reference
   *
   * @return {*}  {*}
   * @memberof CheckBoxComponent
   */
  getParentNodeOfRegularContent(): any {
    return this.regularContent?.elementRef?.nativeElement?.parentElement;
  }

  /**
   * Applies the padding to the parent dom element of the regularContent reference
   * by getting the padding assigned to the component by a css class
   *
   * @return {*}  {*}
   * @memberof CheckBoxComponent
   */
  applyPaddingStyle(): void {
    const parentRegContent = this.getParentNodeOfRegularContent();
    /* istanbul ignore else */
    if (parentRegContent) {
      this.renderer.setStyle(
        parentRegContent,
        'padding',
        getComputedStyle(this.element.nativeElement).padding
      );
    }
  }

  /**
   * Method that returns the component to render
   *
   * @return {*}  {*}
   * @memberof CheckBoxComponent
   */
  getDynamicComponent(): void {
    this.displayElement = Utils.getDynamicComponent(
      this.contentValue,
      this.injector
    );
    this.detectChangesAction();
  }

  /**
   * Handler for the change in the model's properties.
   *
   * @param {string} name
   * @memberof CheckBoxComponent
   */
  modelChangeHandler(name: string) {
    if (
      name === 'Content' &&
      this.afterContentInitCalled &&
      this.contentValue !== this.staticContent
    ) {
      this.renderContent = false;
      this.getDynamicComponent();
    } else if (name === 'Foreground') {
      this.setLabelColor();
    }
    super.modelChangeHandler(name);
  }

  /**
   * Set the label text color according to model foreground.
   *
   * @memberof CheckBoxComponent
   */
  setLabelColor() {
    const label = this.igxCheckbox?.placeholderLabel
      ?.nativeElement as HTMLElement;
    label?.style.setProperty('color', this.foreground ?? null);
  }

  /**
   * Set the check background color.
   *
   * @memberof CheckBoxComponent
   */
  setCheckBackground() {
    const innerCheckbox = this.igxCheckbox?.nativeLabel
      ?.nativeElement as HTMLElement;
    innerCheckbox?.style.setProperty(
      'background',
      this.checkBackground ?? null
    );
  }

  /**
   * Angular lifecycle.
   *
   * @memberof CheckBoxComponent
   */
  ngAfterContentInit() {
    super.ngAfterContentInit();
    this.afterContentInitCalled = true;
    /* istanbul ignore else */
    if (this.renderContent) {
      const content = this.checkContent?.model;
      if (content) {
        this.staticContent = content;
        this.contentValue = content;
      } else {
        const contentStr = this.element.nativeElement?.childNodes[0].innerText;
        if (contentStr) {
          this.staticContent = contentStr;
          this.contentValue = contentStr;
        } else {
          this.renderContent = false;
          this.getDynamicComponent();
          this.detectChangesAction();
        }
      }
    }
  }

  /**
   * Angular lifecycle.
   *
   * @memberof CheckBoxComponent
   */
  ngAfterViewInit(): void {
    super.ngAfterViewInit();
    this.applyPaddingStyle();
    this.setLabelColor();
    this.setCheckBackground();
    this.setInputDiv();
  }

  /**
   * Angular lifecycle.
   *
   * @memberof CheckBoxComponent
   */
  ngOnInit(): void {
    this.model = this.model || this.injectedModel || new CheckBoxModel();
    this.setupModel(this.model);
    super.ngOnInit();
    this.registerObservers(this.checked, this.model, this.model.Checked);
    this.registerObservers(this.unchecked, this.model, this.model.Unchecked);
    this.registerObservers(this.click, this.model, this.model.Click);
  }

  /**
   * key down handler
   *
   * @param {any} event
   * @type {void}
   * @memberof CheckBoxComponent
   */
  keyDownHandler(event: any): void {
    if (event.code === 'Space' || event.code === 'Enter') {
      this.checkedValue = !this.isChecked;
      event.preventDefault();
      event.stopPropagation();
    }
  }

  /**
   * Creates a container div for the input's validation messages
   *
   * @protected
   * @memberof CheckBoxComponent
   */
  protected setInputDiv(): void {
    if (!this.igxCheckbox?.nativeCheckbox) return;
    const input = this.igxCheckbox.nativeCheckbox.nativeElement;
    const parent = input.parentElement;
    const div = document.createElement('div');
    div.classList.add('input-container');
    parent.insertBefore(div, parent.childNodes[0]);
    div.appendChild(input);
  }

  /**
   * "If the mouse is up, then stop the propagation of the event."
   *
   * The above function is called when the mouse is up.
   *
   * @param {MouseEvent} ev - MouseEvent - The event object.
   * @memberof CheckBoxComponent
   */
  mouseUpHandler(ev: MouseEvent): void {
    this.model.MouseLeftButtonUp.fire([this.model, new RoutedEventArgs()]);
    ev.stopPropagation();
  }
}

<div
  *ngIf="visibility"
  (mouseup)="mouseUpHandler($event)"
  [wmValidationSupport]="[
    validationError,
    validationErrorMessage,
    '.input-container',
    '4px'
  ]"
  class="autoHeightWidth"
  [class]="{ disabled: !isEnabled }"
>
  <igx-checkbox
    #igxCheckbox
    [checked]="checkedValue"
    [disabled]="!isEnabled"
    (pointerdown)="onChange(checkedValue)"
    [readonly]="true"
    [tabindex]="tabIndex"
    (keydown)="keyDownHandler($event)"
  >
    <ng-container *ngIf="renderContent; else dynamics">
      <ng-content></ng-content>
    </ng-container>
    <ng-template #dynamics>
      <ng-container *ngIf="displayElement; else regularContent; let value">
        <ng-container
          *ngComponentOutlet="value.component; injector: value.customInjector"
        ></ng-container>
      </ng-container>
      <ng-template #regularContent>
        <span [style.font-weight]="fontWeight" [style.color]="foreground">{{
          contentValue
        }}</span>
      </ng-template>
    </ng-template>
  </igx-checkbox>
</div>

./check-box.component.scss 

@import '~igniteui-angular/lib/core/styles/themes/index';
@import '../../scss/variables';

wm-check-box > div {
  margin: inherit;
}

:host ::ng-deep {
  .igx-checkbox {
    .input-container {
      box-sizing: content-box;
      width: 1.25em;
      height: 1.25em;
      z-index: 2;
    }

    .input-container + .igx-checkbox__composite-wrapper {
      position: absolute;
      left: 1px;
    }

    &__label {
      white-space: pre;
    }

    &--disabled {
      .igx-checkbox__label {
        color: unset;
      }

      .input-container {
        border: 1px solid $default-control-border-color;
      }
    }
    &:focus-within .input-container {
      border: $default-focus-checkbox-border-color;
    }

    &:focus,
    &:hover {
      .igx-checkbox__composite {
        background: $default-control-background-hover;
        border-color: $default-control-active-color;
      }
    }

    .igx-checkbox__composite {
      background: var(--fill-color);

      &::after {
        background: var(--fill-color);
      }
    }
  }
}

$my-checkbox-theme: checkbox-theme(
  $focus-outline-color: $default-focus-border-color,
  $fill-color: $checkBox-background-color,
  $empty-color: $checkBox-background-color,
  $tick-color: $checkBox-tick-color,
  $disabled-color: $checkbox-disabled-color,
);

@include checkbox($my-checkbox-theme);
Legend
Html element
Component
Html element with directive

result-matching ""

    No results matching ""