projects/i-components/src/lib/components/text-block/text-block.component.ts
Angular Component for the TextBlock Control.
changeDetection | ChangeDetectionStrategy.OnPush |
selector | wm-text-block |
styleUrls | ./text-block.component.scss |
templateUrl | ./text-block.component.html |
Public
constructor(injector: Injector, cdRef: ChangeDetectorRef, injectedModel: TextBlockModel)
|
||||||||||||
Creates an instance of TextBlockComponent.
Parameters :
|
fontFamily | |
Type : string
|
|
Value used to set the font family for TextBlockModel |
fontSize | |
Type : number
|
|
Value used to set the fontSize for TextBlockModel |
fontStyle | |
Type : string
|
|
Value used to set the font style for TextBlockModel |
fontStyleConverter | |
Type : any
|
|
Value converter for |
fontWeight | |
Type : string
|
|
Value used to set the font weight for TextBlockModel |
fontWeightConverter | |
Type : any
|
|
Value converter for |
foreground | |
Type : any
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:446
|
|
Sets the value of the Foreground for TextBlockModel |
model | |
Type : TextBlockModel
|
|
Object with properties and events for the textBlock. |
padding | |
Type : any
|
|
Sets a value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by the TextBlock. |
text | |
string used in the text property of the textBlock |
textConverter | |
Type : any
|
|
Value converter for |
textDecorations | |
Type : any
|
|
Sets the value of the textDecorator for TextBlockModel |
textWrapping | |
Type : any
|
|
Specifies whether text wraps when it reaches the edge of its container. |
controlTemplate | |
Type : any
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1197
|
|
Sets the controlTemplate Input property for changing the model's |
cursor | |
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1451
|
|
Property used to save the cursor value |
dataContext | |
Type : any
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:952
|
|
Gets/sets the dataContext Input property for changing the model's |
dataGridRowHeight | |
Type : number
|
|
Default value : 22
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:507
|
|
Represents the row height of both the DataGrid and XamGrid components it affects the css and also an internal function that virtualized data, so do not change directly on css, use this variable instead. |
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... |
mouseEnter | |
Type : EventEmitter<literal type>
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:84
|
|
Event Emitter. MouseEnter event. |
mouseLeave | |
Type : EventEmitter<literal type>
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:94
|
|
Event Emitter. MouseLeave event. |
mouseLeftButtonDown | |
Type : EventEmitter<literal type>
|
|
Event Emitter. MouseLeftButtonDown 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. |
mouseLeftButtonUp | |
Type : EventEmitter<literal type>
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:147
|
|
MouseLeftButtonUp event Emitter. |
sizeChanged | |
Type : EventEmitter<any>
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:132
|
|
Output to emit when then component size is changed. |
class |
Type : string
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:407
|
Applies custom CSS classes |
class.defaultFontStyles |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:398
|
Applies default font styles class, used to allow specificity for each control css |
class.focusable |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:388
|
Display if the component is focusable or not |
class.hasDefinedCursor |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:415
|
Applies Defined Cursor class |
class.horizontal-center |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:308
|
Applies horizontal alignment left class |
class.horizontal-left |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:298
|
Applies horizontal alignment left class |
class.horizontal-right |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:368
|
Applies horizontal alignment right class |
class.horizontal-stretch |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:358
|
Applies horizontal alignment stretch class |
class.vertical-bottom |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:328
|
Applies vertical alignment bottom class |
class.vertical-center |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:338
|
Applies vertical alignment center class |
class.vertical-stretch |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:318
|
Applies horizontal alignment stretch class |
class.vertical-top |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:348
|
Applies vertical alignment top class |
style.display |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:243
|
Property use it to apply the host binding for the visibility |
style.font-family |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:261
|
Property use it to apply the host binding for the font-family |
style.font-size |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:270
|
Property use it to apply the host binding for the font-size |
style.font-style |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:279
|
Property use it to apply the host binding for the font-style |
style.font-weight |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:288
|
Property use it to apply the host binding for the font-weight |
style.height |
Type : string
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:218
|
Property use it to apply the host binding for the height |
style.max-height.px |
Type : number
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:234
|
Property used to apply the host binding for max-height |
style.max-width.px |
Type : number
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:210
|
Property used to apply the host binding for max-width |
style.min-height.px |
Type : number
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:226
|
Property used to apply the host binding for min-height |
style.min-width.px |
Type : number
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:202
|
Property used to apply the host binding for min-width |
style.opacity |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:252
|
Property use it to apply the host binding for the opacity |
style.width |
Type : string
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:194
|
Property use it to apply the host binding for the width |
style.z-index |
Type : string
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:424
|
Sets the z-index style. |
isVerticalCentered |
isVerticalCentered()
|
Verifies if the verticalAlignment property is centered.
Returns :
boolean
|
modelChangeHandler | ||||||
modelChangeHandler(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:592
|
||||||
Handler for the change in the model's properties.
Parameters :
Returns :
void
|
mouseDownHandler | ||||||
mouseDownHandler(event: any)
|
||||||
Mousedown event handler.
Parameters :
Returns :
void
|
mouseEnterHandler | ||||||
mouseEnterHandler(event: any)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:563
|
||||||
MouseEnter event handler.
Parameters :
Returns :
void
|
mouseLeaveHandler | ||||||
mouseLeaveHandler(event: any)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:577
|
||||||
MouseLeave event handler.
Parameters :
Returns :
void
|
ngAfterContentInit |
ngAfterContentInit()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:538
|
Angular lifecycle.
Returns :
void
|
ngOnInit |
ngOnInit()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:296
|
Angular lifecycle hook
Returns :
void
|
updateWrapping |
updateWrapping()
|
Updates the wrapping properties from the model.
Returns :
void
|
Protected alignmentHandler |
alignmentHandler()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2346
|
Calculate the values for the grid size behavior from the alignments
Returns :
void
|
Protected assignPendingPropertyValues |
assignPendingPropertyValues()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2057
|
Apply pending assignments to properties with property values
Returns :
void
|
calculateActualSize | ||||||||
calculateActualSize(name?: string)
|
||||||||
Inherited from
BaseComponent
|
||||||||
Defined in
BaseComponent:1674
|
||||||||
If the name is equal to 'calculateActualSize', then call the handlerCalcActualSize function and pass in false to avoid the timer in the function. memberof BaseComponent
Parameters :
Returns :
void
|
Protected checkAndRegisterCompatibilityBinding | |||||||||
checkAndRegisterCompatibilityBinding(property: DependencyProperty, bindingObjectCandidate: any)
|
|||||||||
Inherited from
BaseComponent
|
|||||||||
Defined in
BaseComponent:2023
|
|||||||||
Verifies if the given object (bindingObjectCandidate) is a binding object. If so the binding will be registered.
Parameters :
Returns :
boolean
{boolean} true if the value is a binding info object and if the binding was registered, false if not |
Protected checkForStaticResource | ||||||||||||
checkForStaticResource(property: string, value: any)
|
||||||||||||
Inherited from
BaseComponent
|
||||||||||||
Defined in
BaseComponent:2043
|
||||||||||||
Checks if the given value is a static resource reference or not, if a reference then the value is queue for later assignment.
Parameters :
Returns :
boolean
true if the value is a static resource reference, otherwise false |
checkStaticItemInModelCollection | ||||||||||||
checkStaticItemInModelCollection(collection: any, itemToCheck: any)
|
||||||||||||
Inherited from
BaseComponent
|
||||||||||||
Defined in
BaseComponent:1889
|
||||||||||||
Checks if the element exists previously in the items collection
Parameters :
Returns :
number
number Returns -1 if the item is not present in the items collection otherwise the index value |
createElementInRoot |
createElementInRoot(injector: Injector, componentToCreate: any)
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2698
|
Create a given component on the HTML body.
Returns :
ComponentRef<any>
|
cursorStyle |
cursorStyle()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:1549
|
Returns the correct CSS cursor style and sets the definedCursor flag if necessary
Returns :
string
{string} |
detectChanges |
detectChanges()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:813
|
Performs a single detect Changes over the component
Returns :
void
|
detectChangesAction |
detectChangesAction()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:1686
|
Handle subscription to the notifyDetectChanges action Refresh the component whenever a model modification was performed
Returns :
void
|
getForeground |
getForeground()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:1966
|
Calculates the Foreground color to be applied
Returns :
string
string |
getImageString | ||||||
getImageString(value: any)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2221
|
||||||
Returns string path to the image.
Parameters :
Returns :
any
|
getTargetValue | ||||||
getTargetValue(e: Event)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2239
|
||||||
Returns the value from a $event
Parameters :
Returns :
string
|
Protected handlerCalcActualSize | ||||||
handlerCalcActualSize(async: boolean)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2391
|
||||||
Handler that calculates ActualHeight & ActualWidth based on its inner content.
Parameters :
Returns :
void
|
heightCalc |
heightCalc()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:1939
|
Applies the height CSS value
Returns :
any
|
heightDefaultStyle |
heightDefaultStyle()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:1914
|
Calculates the auto height value
Returns :
string
{string} |
Protected hostHorizontalAlignmentCall |
hostHorizontalAlignmentCall()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2374
|
Assign all the horizontal bindings for the control
Returns :
void
|
Protected hostVerticalAlignmentCall |
hostVerticalAlignmentCall()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2357
|
Assign all the vertical bindings for the control
Returns :
void
|
imageToPath | ||||||
imageToPath(value: any)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2202
|
||||||
Returns the path of the given image.
Parameters :
Returns :
any
|
loadStaticItems | ||||||||||||
loadStaticItems(staticItems: any, itemsCollection: any)
|
||||||||||||
Inherited from
BaseComponent
|
||||||||||||
Defined in
BaseComponent:1634
|
||||||||||||
Parameters :
Returns :
void
void |
Private markForCheckComp |
markForCheckComp()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2451
|
Marks current component
Returns :
void
|
Public ngAfterContentChecked |
ngAfterContentChecked()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:867
|
Angular Lifecycle Hooks
Returns :
void
|
Public ngAfterViewChecked |
ngAfterViewChecked()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:893
|
Angular Lifecycle Hooks
Returns :
void
|
Public ngAfterViewInit |
ngAfterViewInit()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:877
|
Angular Lifecycle Hooks
Returns :
void
|
Public ngDoCheck |
ngDoCheck()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:847
|
Angular Lifecycle Hooks
Returns :
void
|
Public ngOnChanges |
ngOnChanges()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:824
|
Angular Lifecycle Hooks
Returns :
void
|
Public ngOnDestroy |
ngOnDestroy()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:906
|
Cleanup operations for base component
Returns :
void
|
preventItemsDuplication | ||||||||||||||||||
preventItemsDuplication(itemsToRender: any, items: any, contentChildTemplate: any, afterContentInitCalled: boolean, injector: Injector)
|
||||||||||||||||||
Inherited from
BaseComponent
|
||||||||||||||||||
Defined in
BaseComponent:2170
|
||||||||||||||||||
Validates if coming models are the same, and prevents to be recreated on Ribbon DOM. (Needs to be checked, in some statics scenarios RibbonTab, RibbonGroup duplicates items)
Parameters :
Returns :
any[]
|
processAlignments | ||||||
processAlignments(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:1704
|
||||||
Method to check if the component should assign a alignment property
Parameters :
Returns :
void
{void} |
processCursor | ||||||
processCursor(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:1850
|
||||||
Method to set the cursor style of the component
Parameters :
Returns :
void
|
processCustomCssClasses | ||||||
processCustomCssClasses(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:1723
|
||||||
Method to set custom CSS Clases
Parameters :
Returns :
void
{void} |
processFocusable | ||||||
processFocusable(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:1816
|
||||||
Method to check and set the height of the grid
Parameters :
Returns :
void
|
Private processFontFamily | ||||||
processFontFamily(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2784
|
||||||
Process the FontFamily property
Parameters :
Returns :
any
|
processFonts | ||||||
processFonts(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:1778
|
||||||
Method to apply the font styles for the component.
Parameters :
Returns :
void
|
Private processFontSize | ||||||
processFontSize(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2798
|
||||||
Process the FontSize property
Parameters :
Returns :
any
|
Private processFontStyle | ||||||
processFontStyle(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2815
|
||||||
Process the FontStyle property
Parameters :
Returns :
any
|
Private processFontWeight | ||||||
processFontWeight(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2832
|
||||||
Process the FontWeight property
Parameters :
Returns :
any
|
processHeights | ||||||
processHeights(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:1797
|
||||||
Method to check and set the height of the grid
Parameters :
Returns :
void
|
processIsEnabled | ||||||
processIsEnabled(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:1764
|
||||||
Process changes to
Parameters :
Returns :
void
|
processOpacity | ||||||
processOpacity(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:1751
|
||||||
Method to apply the opacity for the component.
Parameters :
Returns :
void
|
processVisibility | ||||||
processVisibility(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:1737
|
||||||
Method to check if the component should be show or hide.
Parameters :
Returns :
void
|
processWidths | ||||||
processWidths(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:1829
|
||||||
Method to check and set the width of the grid
Parameters :
Returns :
void
|
Private processZIndex | ||||||
processZIndex(name: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:1872
|
||||||
Method to process the ZIndex when set through the model
Parameters :
Returns :
void
|
Private recreateInvalidBindings |
recreateInvalidBindings()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2756
|
Execution of removeModelProxyHandlers in a previous instance of the component (that used the same model) could have set some bindings in an invalid state, this will check if some of them has to be recreated
Returns :
void
|
Private registerContextMenuActions | ||||||
registerContextMenuActions(ctxMenu: ContextMenuManager)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2533
|
||||||
Enable the contextMenu actions to be displayed when the user perform an action Creates dinamically a new instance of XamContextMenu to be displayed in the screen
Parameters :
Returns :
void
|
Protected registerDomEventListenerOnElement |
registerDomEventListenerOnElement(eventName: string, handler: any)
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2316
|
Registers a DOM handler on the current element
Returns :
void
|
Protected registerHandler | |||||||||
registerHandler(event: SubscriptionEvent<void>, arrowHandler: (s: any,a: any) => void)
|
|||||||||
Inherited from
BaseComponent
|
|||||||||
Defined in
BaseComponent:2298
|
|||||||||
Register arrow handler into the given
Parameters :
Returns :
void
|
Protected registerMouseEvents |
registerMouseEvents()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2272
|
Registers mouse events if required
Returns :
void
|
Protected registerObservers | ||||||||||||
registerObservers(emitter: EventEmitter
|
||||||||||||
Inherited from
BaseComponent
|
||||||||||||
Defined in
BaseComponent:2252
|
||||||||||||
Register observers from the given
Parameters :
Returns :
void
|
Private registerToolTip | |||||||||
registerToolTip(element: ElementRef
|
|||||||||
Inherited from
BaseComponent
|
|||||||||
Defined in
BaseComponent:2607
|
|||||||||
Registers a tooltip to a component
Parameters :
Returns :
void
|
Private removeModelProxyHandlers |
removeModelProxyHandlers()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2738
|
Clean up the handlers when the component is destroyed
Returns :
void
|
Private setComponentForDirectives |
setComponentForDirectives()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2512
|
Sets an internal reference through the element ref to access the component in a directive
Returns :
void
|
Protected setPendingPropertyValue |
setPendingPropertyValue(property: string, value: any)
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2336
|
Stores the pending property values for instance attach properties. Which will be applied when the model is available
Returns :
void
|
setupDependencyComponents | ||||||
setupDependencyComponents(model: FrameworkElement)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:1612
|
||||||
Adds the references to the dependency components
Parameters :
Returns :
void
|
setupModel | ||||||
setupModel(model: FrameworkElement)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:1559
|
||||||
Syncs the modelProxy with model
Parameters :
Returns :
void
void |
Private syncToolTip | ||||||
syncToolTip(tooltip: ToolTipModel)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2587
|
||||||
Updates the tooltip associated to a component
Parameters :
Returns :
void
|
Private syncValidationError | ||||||
syncValidationError(name?: string)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2766
|
||||||
Syncs validation information with component properties
Parameters :
Returns :
void
|
Private tabSelectionSubscription |
tabSelectionSubscription()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2471
|
Subscribe to the tabhandler event if Required When the component is inside a tab control it should trigger the load event every time the tab is selected
Returns :
void
|
trackByFn | ||||||||||||
trackByFn(index: any, item: any)
|
||||||||||||
Inherited from
BaseComponent
|
||||||||||||
Defined in
BaseComponent:1904
|
||||||||||||
Function used by Angular to track elements in the ngFor directive. We use the GUID property to compare elements.
Parameters :
Returns :
any
{*} -return the model or object itself |
Private unregisterToolTip | ||||||
unregisterToolTip(element: ElementRef
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2719
|
||||||
Unregisters a tooltip to a component
Parameters :
Returns :
void
|
Private updateSizePropertiesForActualSizeChange | ||||||||
updateSizePropertiesForActualSizeChange(element: Element)
|
||||||||
Inherited from
BaseComponent
|
||||||||
Defined in
BaseComponent:2421
|
||||||||
Updates the size properties of the component based on the initial size change
Parameters :
Returns :
void
|
validatesLoadingFlag |
validatesLoadingFlag()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:1519
|
Validates loading flag for components outside current tab index TabIndexService should be only tabItem provider, and when currentTabId is different from selectedTab IsFirstTimeLoad is set to false because tabService is going to be one in charge to trigger only one time when tab changes.
Returns :
void
|
widthCalc |
widthCalc()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:1953
|
Applies the width CSS value
Returns :
any
|
widthDefaultStyle |
widthDefaultStyle()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:1926
|
Calculates the auto width value
Returns :
string
{string} |
fontStyleConverter |
Type : any
|
Decorators :
@Input()
|
Value converter for |
fontWeightConverter |
Type : any
|
Decorators :
@Input()
|
Value converter for |
isBindingText |
Type : boolean
|
Flag to know if the text comes from a binding and have TextWrapping set to NoWrap, if this is the case the white-space css property must be 'pre' |
model |
Type : TextBlockModel
|
Decorators :
@Input()
|
Object with properties and events for the textBlock. |
Protected modelProxy |
Type : TextBlockModel
|
Default value : ModelProxy.create<TextBlockModel>()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:272
|
ModelProxy is a copy of the model, used on the component initial building to prevent crashes with external bindings. |
mouseEnter |
Type : EventEmitter<literal type>
|
Default value : new EventEmitter()
|
Decorators :
@Output()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:84
|
Event Emitter. MouseEnter event. |
mouseLeave |
Type : EventEmitter<literal type>
|
Default value : new EventEmitter()
|
Decorators :
@Output()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:94
|
Event Emitter. MouseLeave event. |
mouseLeftButtonDown |
Type : EventEmitter<literal type>
|
Default value : new EventEmitter()
|
Decorators :
@Output()
|
Event Emitter. MouseLeftButtonDown event. |
textConverter |
Type : any
|
Decorators :
@Input()
|
Value converter for |
whiteSpace |
Type : string
|
Default value : 'nowrap'
|
whiteSpace property for wrapping styles |
wordWrap |
Type : string
|
Default value : 'normal'
|
wordwrap property for styles |
actualSizeCalled |
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:481
|
Flag to know if the Angular event was called |
afterContentInitCalled |
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:465
|
Flag to know if the Angular event was called |
afterViewCheckedCalled |
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:473
|
Flag to know if the Angular event was called |
afterViewInitCalled |
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:457
|
Flag to know if the Angular event was called |
Private bindingValidationCallback |
Type : function
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:618
|
Callback for binding validation |
bindingValidationError |
Type : EventEmitter<any>
|
Default value : new EventEmitter()
|
Decorators :
@Output()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:114
|
output to emit the new value of the bindingValidationError event |
Private cdRefInjection |
Type : ChangeDetectorRef
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:659
|
Change Detector Reference for the component |
Private changeDetectionTimer |
Type : any
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:668
|
A timer to debounce changedetection actions |
Protected changeDetectorNotifier |
Type : ChangeDectionNotifierService
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:576
|
Change Detection Notifier Service instace. |
Private contextMenuUnlistener |
Type : function
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:676
|
Context Menu event unlisten action. |
Private ctxMenuInstance |
Type : any
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:630
|
Reference to the ctxMenuInstance |
customCssClasses |
Type : string
|
Default value : null
|
Decorators :
@HostBinding('class')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:407
|
Applies custom CSS classes |
Private customTooltipInstance |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:641
|
Reference to the custom tooltip instance this is used to render a popup with custom elements used when the content value is not a string |
dataGridRowHeight |
Type : number
|
Default value : 22
|
Decorators :
@Input()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:507
|
Represents the row height of both the DataGrid and XamGrid components it affects the css and also an internal function that virtualized data, so do not change directly on css, use this variable instead. |
Protected domHandlerUnListeners |
Type : Array<void>
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:567
|
A collection (possible undefined) of DOM unlistener functions . That is, functions to de register handlers |
fireLoadedSubscription |
Type : Subscription
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:449
|
Flag to control load event for components inside tab control |
focusable |
Default value : false
|
Decorators :
@HostBinding('class.focusable')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:388
|
Display if the component is focusable or not |
Protected handlersToUnregister |
Type : Array<>
|
Default value : []
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:558
|
handlers to unregister when the component is destroyed |
hasDefinedCursor |
Default value : false
|
Decorators :
@HostBinding('class.hasDefinedCursor')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:415
|
Applies Defined Cursor class |
hostFontFamily |
Type : any
|
Default value : null
|
Decorators :
@HostBinding('style.font-family')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:261
|
Property use it to apply the host binding for the font-family |
hostFontSize |
Type : any
|
Default value : null
|
Decorators :
@HostBinding('style.font-size')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:270
|
Property use it to apply the host binding for the font-size |
hostFontStyle |
Type : any
|
Default value : null
|
Decorators :
@HostBinding('style.font-style')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:279
|
Property use it to apply the host binding for the font-style |
hostFontStyles |
Default value : false
|
Decorators :
@HostBinding('class.defaultFontStyles')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:398
|
Applies default font styles class, used to allow specificity for each control css |
hostFontWeight |
Type : any
|
Default value : null
|
Decorators :
@HostBinding('style.font-weight')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:288
|
Property use it to apply the host binding for the font-weight |
hostHeight |
Type : string
|
Default value : null
|
Decorators :
@HostBinding('style.height')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:218
|
Property use it to apply the host binding for the height |
hostHozCenter |
Default value : false
|
Decorators :
@HostBinding('class.horizontal-center')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:308
|
Applies horizontal alignment left class |
hostHozLeft |
Default value : false
|
Decorators :
@HostBinding('class.horizontal-left')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:298
|
Applies horizontal alignment left class |
hostHozRight |
Default value : false
|
Decorators :
@HostBinding('class.horizontal-right')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:368
|
Applies horizontal alignment right class |
hostHozSelfAlign |
Default value : false
|
Decorators :
@HostBinding('class.horizontal-selfalign')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:380
|
Applies horizontal selfalign class. Flags indicates when the control should handle its own horizontal alignment and ignore container alignment. |
hostHozStretch |
Default value : false
|
Decorators :
@HostBinding('class.horizontal-stretch')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:358
|
Applies horizontal alignment stretch class |
hostMaxHeight |
Type : number
|
Decorators :
@HostBinding('style.max-height.px')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:234
|
Property used to apply the host binding for max-height |
hostMaxWidth |
Type : number
|
Decorators :
@HostBinding('style.max-width.px')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:210
|
Property used to apply the host binding for max-width |
hostMinHeight |
Type : number
|
Decorators :
@HostBinding('style.min-height.px')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:226
|
Property used to apply the host binding for min-height |
hostMinWidth |
Type : number
|
Decorators :
@HostBinding('style.min-width.px')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:202
|
Property used to apply the host binding for min-width |
hostOpacity |
Type : any
|
Default value : null
|
Decorators :
@HostBinding('style.opacity')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:252
|
Property use it to apply the host binding for the opacity |
hostVerBottom |
Default value : false
|
Decorators :
@HostBinding('class.vertical-bottom')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:328
|
Applies vertical alignment bottom class |
hostVerCenter |
Default value : false
|
Decorators :
@HostBinding('class.vertical-center')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:338
|
Applies vertical alignment center class |
hostVerStretch |
Default value : false
|
Decorators :
@HostBinding('class.vertical-stretch')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:318
|
Applies horizontal alignment stretch class |
hostVerTop |
Default value : false
|
Decorators :
@HostBinding('class.vertical-top')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:348
|
Applies vertical alignment top class |
hostVisibility |
Type : any
|
Default value : null
|
Decorators :
@HostBinding('style.display')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:243
|
Property use it to apply the host binding for the visibility |
hostWidth |
Type : string
|
Default value : null
|
Decorators :
@HostBinding('style.width')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:194
|
Property use it to apply the host binding for the width |
hostZIndex |
Type : string
|
Default value : null
|
Decorators :
@HostBinding('style.z-index')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:424
|
Sets the z-index style. |
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 |
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 |
textWrapping | ||||||
gettextWrapping()
|
||||||
Gets the text wrap from the model.
Returns :
any
|
||||||
settextWrapping(value: any)
|
||||||
Specifies whether text wraps when it reaches the edge of its container.
Parameters :
Returns :
void
|
internalWidth |
getinternalWidth()
|
Gets the width for the internal component
Returns :
any
|
textAlignment | ||||||
gettextAlignment()
|
||||||
Gets the text alignment from the model.
Returns :
any
|
||||||
settextAlignment(value: any)
|
||||||
Specifies whether text is centered, left-aligned, or right-aligned.
Parameters :
Returns :
void
|
padding | ||||||
getpadding()
|
||||||
Gets a value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by the TextBlock.
Returns :
any
|
||||||
setpadding(value: any)
|
||||||
Sets a value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by the TextBlock.
Parameters :
Returns :
void
|
text | ||||||
settext(value: string | BindingInfo)
|
||||||
string used in the text property of the textBlock
Parameters :
Returns :
void
|
value |
getvalue()
|
Gets the Text value property from the TextBlockModel.
Returns :
string
|
fontStyle | ||||||
getfontStyle()
|
||||||
property used to set the font style for the text block
Returns :
string
|
||||||
setfontStyle(value: string)
|
||||||
Value used to set the font style for TextBlockModel
Parameters :
Returns :
void
|
fontFamily | ||||||
getfontFamily()
|
||||||
property used to set the font family for the text block
Returns :
string
|
||||||
setfontFamily(value: string)
|
||||||
Value used to set the font family for TextBlockModel
Parameters :
Returns :
void
|
fontWeight | ||||||
getfontWeight()
|
||||||
property used to set the font weight for the text block
Returns :
string
|
||||||
setfontWeight(value: string)
|
||||||
Value used to set the font weight for TextBlockModel
Parameters :
Returns :
void
|
fontSize | ||||||
getfontSize()
|
||||||
Gets the value of the fontSize for TextBlockModel
Returns :
number
|
||||||
setfontSize(value: number)
|
||||||
Value used to set the fontSize for TextBlockModel
Parameters :
Returns :
void
|
foreground | ||||||
getforeground()
|
||||||
Gets the value of the Color for TextBlockModel
Returns :
any
|
||||||
setforeground(value: any)
|
||||||
Sets the value of the Foreground for TextBlockModel
Parameters :
Returns :
void
|
textDecorations | ||||||
settextDecorations(value: any)
|
||||||
Sets the value of the textDecorator for TextBlockModel
Parameters :
Returns :
void
|
textUnderline |
gettextUnderline()
|
Gets the value of the TextDecorations for TextBlockModel
Returns :
string
|
import {
AfterContentInit,
ChangeDetectionStrategy,
ChangeDetectorRef,
Component,
EventEmitter,
Injector,
Input,
OnInit,
Optional,
Output,
} from '@angular/core';
import {
AngularComponentId,
BindingInfo,
ComponentId,
ModelProxy,
MouseEventArgs,
TextAlignment,
TextBlockModel,
TextDecorations,
TextWrapping,
ThicknessModel,
VerticalAlignment,
} from '@mobilize/wms-framework';
import { Utils } from '../../utils/index';
import { BaseComponent } from '../base/base.component';
/**
* Angular Component for the TextBlock Control.
*
* @export
* @class TextBlockComponent
* @extends {BaseComponent}
* @implements {OnInit}
* @implements {AfterContentInit}
*/
@Component({
selector: 'wm-text-block',
templateUrl: './text-block.component.html',
styleUrls: ['./text-block.component.scss'],
changeDetection: ChangeDetectionStrategy.OnPush,
})
@ComponentId([AngularComponentId.textBlock])
export class TextBlockComponent
extends BaseComponent
implements OnInit, AfterContentInit
{
/**
* Event Emitter.
* MouseLeftButtonDown event.
*
* @type {EventEmitter<TextBlockModel>}
* @memberof TextBlockComponent
*/
@Output() mouseLeftButtonDown: EventEmitter<{
sender: TextBlockModel;
e: any;
}> = new EventEmitter();
/**
* Event Emitter.
* MouseEnter event.
*
* @type {EventEmitter<TextBlockModel>}
* @memberof TextBlockComponent
*/
@Output() mouseEnter: EventEmitter<{ sender: TextBlockModel; e: any }> =
new EventEmitter();
/**
* Event Emitter.
* MouseLeave event.
*
* @type {EventEmitter<TextBlockModel>}
* @memberof TextBlockComponent
*/
@Output() mouseLeave: EventEmitter<{ sender: TextBlockModel; e: any }> =
new EventEmitter();
/**
* Specifies whether text wraps when it reaches the edge of its container.
*
* @memberof TextBlockComponent
*/
@Input() set textWrapping(value: any) {
/* istanbul ignore else */
if (TextWrapping[value] !== undefined) {
this.modelProxy.TextWrapping = TextWrapping[value] as any;
}
}
/**
* Gets the text wrap from the model.
*
* @returns {string}
* @memberof TextBlockComponent
*/
get textWrapping(): any {
/* istanbul ignore else */
if (this.model.TextWrapping === TextWrapping.NoWrap && this.isBindingText) {
return 'nowrap';
}
// Changed from 'normal' to 'pre-wrap' to support line breaks, bug #393830
// Silverlight line break behavior depends on where the text is set
// if it is set in the model, line break is applied
// if is set using the text input, line break is not applied
else if (this.model.TextWrapping === TextWrapping.Wrap) {
return 'pre-wrap';
} else {
return 'pre';
}
}
/**
* Gets the width for the internal component
*
* @readonly
* @type {*}
* @memberof TextBlockComponent
*/
get internalWidth(): any {
return this.modelProxy.Width <= 0 ? 'unset' : `${this.modelProxy.Width}px`;
}
/**
* Specifies whether text is centered, left-aligned, or right-aligned.
*
* @memberof TextBlockComponent
*/
set textAlignment(value: any) {
/* istanbul ignore else */
if (TextAlignment[value] !== undefined) {
this.modelProxy.TextAlignment = TextAlignment[value] as any;
}
}
/**
* Gets the text alignment from the model.
*
* @type {any}
* @memberof TextBlockComponent
*/
get textAlignment(): any {
let aligned = '';
switch (this.model.TextAlignment) {
case TextAlignment.Center:
aligned = 'center';
break;
case TextAlignment.Right:
aligned = 'right';
break;
case TextAlignment.Justify:
aligned = 'justify';
break;
case TextAlignment.Left:
aligned = 'left';
break;
default:
aligned = 'left';
break;
}
return aligned;
}
/**
* Sets a value that indicates the thickness of padding space between the
* boundaries of the content area and the content displayed by the TextBlock.
*
* @memberof TextBlockComponent
*/
@Input()
set padding(value: any) {
/* istanbul ignore else */
if (value) {
this.modelProxy.Padding = ThicknessModel.parse(value.toString());
}
}
/**
* Gets a value that indicates the thickness of padding space between the
* boundaries of the content area and the content displayed by the TextBlock.
*
* @memberof TextBlockComponent
*/
get padding(): any {
return this.model.Padding ? this.model.Padding : ThicknessModel.parse('0');
}
/**
* Object with properties and events for the textBlock.
*
* @type {TextBlockModel}
* @memberof TextBlockComponent
*/
@Input() model: TextBlockModel;
/**
* Value converter for `text`.
*
* @type {*}
* @memberof TextBlockComponent
*/
@Input() textConverter: any;
/**
* Value converter for `fontStyle`.
*
* @type {*}
* @memberof TextBlockComponent
*/
@Input() fontStyleConverter: any;
/**
* Value converter for `fontWeight`.
*
* @type {*}
* @memberof TextBlockComponent
*/
@Input() fontWeightConverter: any;
/**
* whiteSpace property for wrapping styles
*
* @type {string}
* @memberof TextBlockComponent
*/
whiteSpace = 'nowrap';
/**
* wordwrap property for styles
*
* @type {string}
* @memberof TextBlockComponent
*/
wordWrap = 'normal';
/**
* Flag to know if the text comes from a binding and
* have TextWrapping set to NoWrap, if this is the
* case the white-space css property must be 'pre'
*
* @type {boolean}
* @memberof TextBlockComponent
*/
isBindingText: boolean;
/**
* ModelProxy is a copy of the model,
* used on the component initial building to prevent crashes with external bindings.
*
* @protected
* @type {TextBlockModel}
* @memberof TextBlockComponent
*/
protected modelProxy: TextBlockModel = ModelProxy.create<TextBlockModel>();
/**
* Creates an instance of TextBlockComponent.
*
* @param {Injector} injector
* @param {TextBlockModel} [injectedModel=null]
* @memberof TextBlockComponent
*/
/* istanbul ignore next */
public constructor(
private injector: Injector,
private cdRef: ChangeDetectorRef,
@Optional() protected injectedModel: TextBlockModel = null
) {
super(cdRef, injector);
this.model = injectedModel;
}
/**
* Angular lifecycle hook
*
* @memberof TextBlockComponent
*/
ngOnInit(): void {
this.model = this.model || this.injectedModel || new TextBlockModel();
this.setupModel(this.model);
super.ngOnInit();
this.registerMouseEvents();
}
/**
* string used in the text property of the textBlock
*
* @memberof TextBlockComponent
*/
@Input() set text(value: string | BindingInfo) {
/* istanbul ignore else */
if (typeof value === 'string') {
this.isBindingText = true;
}
if (
!this.checkAndRegisterCompatibilityBinding(
TextBlockModel.TextProperty,
value
)
) {
this.modelProxy.Text = value?.toString();
}
}
/**
* Gets the *Text* value property from the TextBlockModel.
*
* @readonly
* @type {string}
* @memberof TextBlockComponent
*/
get value(): string {
return this.model.Text;
}
/**
* property used to set the font style for the text block
*
* @readonly
* @type {string}
* @memberof TextBlockComponent
*/
get fontStyle(): string {
return Utils.getFontStyle(this.model.FontStyle);
}
/**
* Value used to set the font style for TextBlockModel
*
* @memberof TextBlockComponent
*/
@Input() set fontStyle(value: string) {
if (
!this.checkAndRegisterCompatibilityBinding(
TextBlockModel.FontStyleProperty,
value
)
) {
this.modelProxy.FontStyle = value;
}
}
/**
* property used to set the font family for the text block
*
* @readonly
* @type {string}
* @memberof TextBlockComponent
*/
get fontFamily(): string {
return this.model.FontFamily;
}
/**
* Value used to set the font family for TextBlockModel
*
* @memberof TextBlockComponent
*/
@Input() set fontFamily(value: string) {
if (
!this.checkAndRegisterCompatibilityBinding(
TextBlockModel.FontFamilyProperty,
value
)
) {
this.modelProxy.FontFamily = value;
}
}
/**
* property used to set the font weight for the text block
*
* @readonly
* @type {string}
* @memberof TextBlockComponent
*/
get fontWeight(): string {
return Utils.getFontWeight(this.model.FontWeight);
}
/**
* Value used to set the font weight for TextBlockModel
*
* @memberof TextBlockComponent
*/
@Input() set fontWeight(value: string) {
if (
!this.checkAndRegisterCompatibilityBinding(
TextBlockModel.FontWeightProperty,
value
)
) {
this.modelProxy.FontWeight = value;
}
}
/**
* Value used to set the fontSize for TextBlockModel
*
* @memberof TextBlockComponent
*/
@Input() set fontSize(value: number) {
if (
!this.checkAndRegisterCompatibilityBinding(
TextBlockModel.FontSizeProperty,
value
)
) {
this.modelProxy.FontSize = value;
}
}
/**
* Gets the value of the fontSize for TextBlockModel
*
* @type {number}
* @memberof TextBlockComponent
*/
get fontSize(): number {
return this.model.FontSize;
}
/**
* Sets the value of the Foreground for TextBlockModel
*
* @memberof TextBlockComponent
*/
@Input() set foreground(value: any) {
if (
!this.checkAndRegisterCompatibilityBinding(
TextBlockModel.ForegroundProperty,
value
)
) {
this.modelProxy.Foreground = Utils.createSolidBrush(value);
}
}
/**
* Gets the value of the Color for TextBlockModel
*
* @readonly
* @type {any}
* @memberof TextBlockComponent
*/
get foreground(): any {
return this.model.Foreground;
}
/**
* Sets the value of the textDecorator for TextBlockModel
*
* @memberof TextBlockComponent
*/
@Input() set textDecorations(value: any) {
/* istanbul ignore else */
if (
!this.checkAndRegisterCompatibilityBinding(
TextBlockModel.TextDecorationsProperty,
value
)
) {
this.modelProxy.TextDecorations = value;
}
}
/**
* Gets the value of the TextDecorations for TextBlockModel
*
* @readonly
* @type {string}
* @memberof TextBlockComponent
*/
get textUnderline(): string {
if (
this.model.TextDecorations != null &&
typeof this.model.TextDecorations === 'string'
) {
return this.model.TextDecorations.toLowerCase() === 'underline'
? 'underline'
: '';
}
return this.model.TextDecorations === TextDecorations.Underline
? 'underline'
: '';
}
/**
* Updates the wrapping properties from the model.
*
* @type {any}
* @memberof TextBlockComponent
*/
updateWrapping(): void {
let newWordWrap = '';
switch (this.model.TextWrapping) {
case TextWrapping.NoWrap:
newWordWrap = 'normal';
break;
case TextWrapping.Wrap:
newWordWrap = 'anywhere';
break;
default:
newWordWrap = 'normal';
break;
}
if (this.wordWrap !== newWordWrap) {
this.wordWrap = newWordWrap;
}
if (this.whiteSpace !== this.textWrapping) {
this.whiteSpace = this.textWrapping;
}
}
/**
* Angular lifecycle.
*
* @memberof TextBlockComponent
*/
ngAfterContentInit() {
super.ngAfterContentInit();
this.updateWrapping();
this.detectChangesAction();
}
/**
* Mousedown event handler.
*
* @memberof TextBlockComponent
*/
mouseDownHandler(event: any): void {
const params = {
sender: this.modelProxy as any,
e: new MouseEventArgs(event),
};
this.modelProxy.MouseLeftButtonDown.fire([params.sender, params.e]);
this.mouseLeftButtonDown.emit(params);
}
/**
* MouseEnter event handler.
*
* @memberof TextBlockComponent
*/
mouseEnterHandler(event: any): void {
const params = {
sender: this.modelProxy as any,
e: new MouseEventArgs(event),
};
this.modelProxy.MouseEnter.fire([params.sender, params.e]);
this.mouseEnter.emit(params);
}
/**
* MouseLeave event handler.
*
* @memberof TextBlockComponent
*/
mouseLeaveHandler(event: any): void {
const params = {
sender: this.modelProxy as any,
e: new MouseEventArgs(event),
};
this.modelProxy.MouseLeave.fire([params.sender, params.e]);
this.mouseLeave.emit(params);
}
/**
* Handler for the change in the model's properties.
*
* @param {string} name
* @memberof TextBlockComponent
*/
modelChangeHandler(name: string) {
super.modelChangeHandler(name);
if (name === 'Text') {
this.detectChangesAction();
}
}
/**
* Verifies if the verticalAlignment property is centered.
*
* @type {boolean}
* @memberof TextBlockComponent
*/
isVerticalCentered(): boolean {
return this.verticalAlignment === VerticalAlignment.Center;
}
}
<span
[style.font-weight]="fontWeight"
*ngIf="visibility"
[style.font-size.px]="fontSize"
[style.color]="getForeground | memoize: foreground"
[style.font-family]="fontFamily"
[style.font-style]="fontStyle"
[style.text-decoration]="textUnderline"
[style.white-space]="textWrapping"
[style.overflow-wrap]="wordWrap"
[style.padding-left.px]="padding.Left"
[style.padding-right.px]="padding.Right"
[style.padding-top.px]="padding.Top"
[style.padding-bottom.px]="padding.Bottom"
[style.width]="internalWidth"
[ngClass]="{ 'vertical-span': isVerticalCentered() }"
(mousedown)="mouseDownHandler($event)"
(mouseenter)="mouseEnterHandler($event)"
(mouseleave)="mouseLeaveHandler($event)"
class="autoHeightWidth"
>{{ value }}</span
>
./text-block.component.scss
span {
display: block;
text-align: inherit;
white-space: inherit;
overflow: inherit;
}
:host {
overflow: inherit;
max-width: 100%;
max-height: 100%;
}
.vertical-span {
display: flex;
align-items: center;
}