projects/i-components/src/lib/components/stack-panel/stack-panel.component.ts
Angular Component for the StackPanel Control.
OnInit
DoCheck
AfterContentInit
OnDestroy
changeDetection | ChangeDetectionStrategy.OnPush |
providers |
{ provide: StackPanelModel, useValue: null }
|
selector | wm-stack-panel |
styleUrls | ./stack-panel.component.scss |
templateUrl | ./stack-panel.component.html |
Public
constructor(injector: Injector, injectedModel: StackPanelModel, cd: ChangeDetectorRef)
|
||||||||||||
Defines stackPanel model.
Parameters :
|
itemsControlDataSource | |
Type : any
|
|
Contains the items sent by the ItemsControl |
itemsControlDisplayMemberPath | |
Type : string
|
|
Contains the ItemsTemplate template sent by the ItemsControl |
itemsControlItemTemplate | |
Contains the ItemTemplate template sent by the ItemsControl |
model | |
Type : StackPanelModel
|
|
Stack Panel model |
orientation | |
Type : any
|
|
Set stackPanelOrientation |
virtualScrollEnabled | |
Type : boolean
|
|
Verifies if the virtual scroll functionality is enabled |
controlTemplate | |
Type : any
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1197
|
|
Sets the controlTemplate Input property for changing the model's |
cursor | |
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1451
|
|
Property used to save the cursor value |
dataContext | |
Type : any
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:952
|
|
Gets/sets the dataContext Input property for changing the model's |
dataGridRowHeight | |
Type : number
|
|
Default value : 22
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:507
|
|
Represents the row height of both the DataGrid and XamGrid components it affects the css and also an internal function that virtualized data, so do not change directly on css, use this variable instead. |
foreground | |
Type : any
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1223
|
|
Sets the value of the Foreground property |
height | |
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1394
|
|
Sets the height |
horizontalAlignment | |
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1096
|
|
Sets the horizontal alignment. |
horizontalContentAlignment | |
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1125
|
|
Sets the horizontal content alignment. |
hostHozSelfAlign | |
Type : boolean
|
|
Default value : false
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:380
|
|
Applies horizontal selfalign class. Flags indicates when the control should handle its own horizontal alignment and ignore container alignment. |
isEnabled | |
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1008
|
|
Gets/sets the isEnabled property for the BaseComponent |
isTabStop | |
Type : boolean
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:760
|
|
Sets/gets IsTabStop property of the BaseComponent |
margin | |
Type : string
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:782
|
|
Sets Margin property of the BaseComponent. |
maxHeight | |
Type : any
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1325
|
|
Sets maxHeight |
maxWidth | |
Type : any
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1283
|
|
Sets maxWidth |
minHeight | |
Type : any
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1304
|
|
Sets minHeight |
minWidth | |
Type : any
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1262
|
|
Sets min Width |
name | |
Type : string
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1153
|
|
Sets the name model property for the control when the name is an input |
opacity | |
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1336
|
|
Sets Opacity value property of the component |
spellCheck | |
Type : boolean
|
|
Default value : false
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:186
|
|
Flag to determinate if the component should do the spell check or not. Default value is false. |
style | |
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1434
|
|
Sets the style |
tabIndex | |
Type : number
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:733
|
|
Sets the property TabIndex of the control model. |
tag | |
Type : any
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1171
|
|
Object used in the Tag property of the Button |
useCss | |
Type : boolean
|
|
Default value : false
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:177
|
|
Determines if the component uses CSS height/width values, instead of inputs |
verticalAlignment | |
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1038
|
|
Sets the vertical alignment. |
verticalContentAlignment | |
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1067
|
|
Sets the vertical content alignment. |
visibility | |
Type : any
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:980
|
|
Gets/sets the visibility property for the BaseComponent |
width | |
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1365
|
|
Sets the width |
zindex | |
Type : number
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:1498
|
|
Property used to set the canvas zindex value. Note: Consider moving this @Input to canvas.direcive.ts, refactoring the directive so all inputs are declared in the directive, and all @HostBindings are declared here in baseComponent, the directive would be responsible for updating the models, while baseComponent will be responsible for binding the values: zIndex, Top, Left... |
bindingValidationError | |
Type : EventEmitter<any>
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:114
|
|
output to emit the new value of the bindingValidationError event |
layoutUpdated | |
Type : EventEmitter<any>
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:140
|
|
Output to emit when then component's layout is updated. |
loaded | |
Type : EventEmitter<any>
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:123
|
|
Output to emit when then component is loaded. |
mouseEnter | |
Type : EventEmitter<literal type>
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:157
|
|
Event Emitter. EventEmitter normally called in the mouseEnterHandler. |
mouseLeave | |
Type : EventEmitter<literal type>
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:167
|
|
Event Emitter Called in the mouseLeave handler |
mouseLeftButtonUp | |
Type : EventEmitter<literal type>
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:147
|
|
MouseLeftButtonUp event Emitter. |
sizeChanged | |
Type : EventEmitter<any>
|
|
Inherited from
BaseComponent
|
|
Defined in
BaseComponent:132
|
|
Output to emit when then component size is changed. |
class |
Type : string
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:407
|
Applies custom CSS classes |
class.defaultFontStyles |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:398
|
Applies default font styles class, used to allow specificity for each control css |
class.focusable |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:388
|
Display if the component is focusable or not |
class.hasDefinedCursor |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:415
|
Applies Defined Cursor class |
class.horizontal-center |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:308
|
Applies horizontal alignment left class |
class.horizontal-left |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:298
|
Applies horizontal alignment left class |
class.horizontal-right |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:368
|
Applies horizontal alignment right class |
class.horizontal-stretch |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:358
|
Applies horizontal alignment stretch class |
class.vertical-bottom |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:328
|
Applies vertical alignment bottom class |
class.vertical-center |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:338
|
Applies vertical alignment center class |
class.vertical-stretch |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:318
|
Applies horizontal alignment stretch class |
class.vertical-top |
Type : boolean
|
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:348
|
Applies vertical alignment top class |
style.display |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:243
|
Property use it to apply the host binding for the visibility |
style.font-family |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:261
|
Property use it to apply the host binding for the font-family |
style.font-size |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:270
|
Property use it to apply the host binding for the font-size |
style.font-style |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:279
|
Property use it to apply the host binding for the font-style |
style.font-weight |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:288
|
Property use it to apply the host binding for the font-weight |
style.height |
Type : string
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:218
|
Property use it to apply the host binding for the height |
style.max-height.px |
Type : number
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:234
|
Property used to apply the host binding for max-height |
style.max-width.px |
Type : number
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:210
|
Property used to apply the host binding for max-width |
style.min-height.px |
Type : number
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:226
|
Property used to apply the host binding for min-height |
style.min-width.px |
Type : number
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:202
|
Property used to apply the host binding for min-width |
style.opacity |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:252
|
Property use it to apply the host binding for the opacity |
style.width |
Type : string
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:194
|
Property use it to apply the host binding for the width |
style.z-index |
Type : string
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:424
|
Sets the z-index style. |
calculatePageData |
calculatePageData(forceUpdate: boolean, index: number)
|
loads items based of scrolling position.
Returns :
void
|
checkItemsHandlers |
checkItemsHandlers()
|
Check if the Children collection has the right handlers
Returns :
void
|
childrenCountChangeHandler | ||||||||
childrenCountChangeHandler(name: string)
|
||||||||
method use it to handle the children properties change.
Parameters :
Returns :
void
|
getContext | ||||||
getContext(item: any)
|
||||||
Return a wrapped object with a context property. If the data comes from a dataContext, it will used this method to generate the groups. This context is used when the ItemsControl passed the datasource to the stackpanel component.
Parameters :
Returns :
any
{context: any} |
Private getDataSource |
getDataSource()
|
Returns the current data collection for the stack panel.
Returns :
any
{*} |
getDynamicUIElements | ||||||
getDynamicUIElements(arrayToInspect: any)
|
||||||
Function that returns the dynamic components to render
Parameters :
Returns :
any
any Array of components |
isGridItem |
isGridItem()
|
Verify if some its items is a Grid Instance
Returns :
void
|
isHorizontal |
isHorizontal()
|
Returns true if horizontal orientation
Returns :
boolean
{boolean} |
isVertical |
isVertical()
|
Returns true if vertical orientation
Returns :
boolean
{boolean} |
itemsCountChanging | ||||||
itemsCountChanging(flag: any)
|
||||||
Process the flag emited by combobox and update scrolling status
Parameters :
Returns :
void
|
ngAfterContentInit |
ngAfterContentInit()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:598
|
Angular lifecycle hook.
Returns :
void
|
ngDoCheck |
ngDoCheck()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:512
|
Angular lifecycle, creates modelProxy copy.
Returns :
void
|
ngOnDestroy |
ngOnDestroy()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:638
|
Angular life cycle hook
Returns :
void
|
ngOnInit |
ngOnInit()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:522
|
Angular lifecycle, creates modelProxy copy.
Returns :
void
|
normalizeSplice | ||||||
normalizeSplice(index: number)
|
||||||
This function validates if current index is in the range of the final data request and change the index to the top scrollIndex to prevent gap in the scrolling
Parameters :
Returns :
number
{number} |
orientationClass |
orientationClass()
|
Function that defines class orientation
Returns :
any
{*} |
scrollEventHandler | ||||||
scrollEventHandler(event: any)
|
||||||
Handle user action for scrolling on the component
Parameters :
Returns :
void
|
validateRequestItems |
validateRequestItems(index: number, forceUpdate: boolean)
|
Validates with topIndex if is necessary to request new items
Returns :
void
|
Protected alignmentHandler |
alignmentHandler()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2346
|
Calculate the values for the grid size behavior from the alignments
Returns :
void
|
Protected assignPendingPropertyValues |
assignPendingPropertyValues()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2057
|
Apply pending assignments to properties with property values
Returns :
void
|
calculateActualSize | ||||||||
calculateActualSize(name?: string)
|
||||||||
Inherited from
BaseComponent
|
||||||||
Defined in
BaseComponent:1674
|
||||||||
If the name is equal to 'calculateActualSize', then call the handlerCalcActualSize function and pass in false to avoid the timer in the function. memberof BaseComponent
Parameters :
Returns :
void
|
Protected checkAndRegisterCompatibilityBinding | |||||||||
checkAndRegisterCompatibilityBinding(property: DependencyProperty, bindingObjectCandidate: any)
|
|||||||||
Inherited from
BaseComponent
|
|||||||||
Defined in
BaseComponent:2023
|
|||||||||
Verifies if the given object (bindingObjectCandidate) is a binding object. If so the binding will be registered.
Parameters :
Returns :
boolean
{boolean} true if the value is a binding info object and if the binding was registered, false if not |
Protected checkForStaticResource | ||||||||||||
checkForStaticResource(property: string, value: any)
|
||||||||||||
Inherited from
BaseComponent
|
||||||||||||
Defined in
BaseComponent:2043
|
||||||||||||
Checks if the given value is a static resource reference or not, if a reference then the value is queue for later assignment.
Parameters :
Returns :
boolean
true if the value is a static resource reference, otherwise false |
checkStaticItemInModelCollection | ||||||||||||
checkStaticItemInModelCollection(collection: any, itemToCheck: any)
|
||||||||||||
Inherited from
BaseComponent
|
||||||||||||
Defined in
BaseComponent:1889
|
||||||||||||
Checks if the element exists previously in the items collection
Parameters :
Returns :
number
number Returns -1 if the item is not present in the items collection otherwise the index value |
createElementInRoot |
createElementInRoot(injector: Injector, componentToCreate: any)
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2698
|
Create a given component on the HTML body.
Returns :
ComponentRef<any>
|
cursorStyle |
cursorStyle()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:1549
|
Returns the correct CSS cursor style and sets the definedCursor flag if necessary
Returns :
string
{string} |
detectChanges |
detectChanges()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:813
|
Performs a single detect Changes over the component
Returns :
void
|
detectChangesAction |
detectChangesAction()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:1686
|
Handle subscription to the notifyDetectChanges action Refresh the component whenever a model modification was performed
Returns :
void
|
getForeground |
getForeground()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:1966
|
Calculates the Foreground color to be applied
Returns :
string
string |
getImageString | ||||||
getImageString(value: any)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2221
|
||||||
Returns string path to the image.
Parameters :
Returns :
any
|
getTargetValue | ||||||
getTargetValue(e: Event)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2239
|
||||||
Returns the value from a $event
Parameters :
Returns :
string
|
Protected handlerCalcActualSize | ||||||
handlerCalcActualSize(async: boolean)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2391
|
||||||
Handler that calculates ActualHeight & ActualWidth based on its inner content.
Parameters :
Returns :
void
|
heightCalc |
heightCalc()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:1939
|
Applies the height CSS value
Returns :
any
|
heightDefaultStyle |
heightDefaultStyle()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:1914
|
Calculates the auto height value
Returns :
string
{string} |
Protected hostHorizontalAlignmentCall |
hostHorizontalAlignmentCall()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2374
|
Assign all the horizontal bindings for the control
Returns :
void
|
Protected hostVerticalAlignmentCall |
hostVerticalAlignmentCall()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2357
|
Assign all the vertical bindings for the control
Returns :
void
|
imageToPath | ||||||
imageToPath(value: any)
|
||||||
Inherited from
BaseComponent
|
||||||
Defined in
BaseComponent:2202
|
||||||
Returns the path of the given image.
Parameters :
Returns :
any
|
loadStaticItems | ||||||||||||
loadStaticItems(staticItems: any, itemsCollection: any)
|
||||||||||||
Inherited from
BaseComponent
|
||||||||||||
Defined in
BaseComponent:1634
|
||||||||||||
Parameters :
Returns :
void
void |
Private markForCheckComp |
markForCheckComp()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:2451
|
Marks current component
Returns :
void
|
modelChangeHandler | ||||||||
modelChangeHandler(name?: string)
|
||||||||
Inherited from
BaseComponent
|
||||||||
Defined in
BaseComponent:1650
|
||||||||
Method to handle the model's change
Parameters :
Returns :
void
|
mouseEnterHandler | ||||||||
mouseEnterHandler(event: any)
|
||||||||
Inherited from
BaseComponent
|
||||||||
Defined in
BaseComponent:1982
|
||||||||
Event Handler for when the mouse enter the Image component.
Parameters :
Returns :
void
|
mouseLeaveHandler | ||||||||
mouseLeaveHandler(event: any)
|
||||||||
Inherited from
BaseComponent
|
||||||||
Defined in
BaseComponent:2001
|
||||||||
Event Handler for when the mouse enter the Image component.
Parameters :
Returns :
void
|
Public ngAfterContentChecked |
ngAfterContentChecked()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:867
|
Angular Lifecycle Hooks
Returns :
void
|
Public ngAfterViewChecked |
ngAfterViewChecked()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:893
|
Angular Lifecycle Hooks
Returns :
void
|
Public ngAfterViewInit |
ngAfterViewInit()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:877
|
Angular Lifecycle Hooks
Returns :
void
|
Public ngOnChanges |
ngOnChanges()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:824
|
Angular Lifecycle Hooks
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} |
countScrollHandlerTimer |
Type : any
|
Scroll timer to handle items loading from combobox |
isInitialized |
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:376
|
Flag to know if the component is ready to render |
Private itemsCntrlDisplayMemberPath |
Type : string
|
Property used to save the template that will be use to render the itemsCtrlDataSource items |
Private itemsCntrlItemTemplate |
Type : TemplateRef<any> | DataTemplate
|
Property used to save the template that will be use to render the itemsCtrlDataSource items |
Private itemsCountChangingSubscription |
Type : Subscription
|
Default value : null
|
Subscription to |
Private itemsCtrlDataSource |
Type : any
|
Property used to save the collection to render as dynamic controls |
itemsToRender |
Type : any
|
Object that contains a list of control to be render |
model |
Type : StackPanelModel
|
Decorators :
@Input()
|
Stack Panel model |
Protected modelProxy |
Type : StackPanelModel
|
Default value : ModelProxy.create<StackPanelModel>()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:385
|
ModelProxy is a copy of the model, used on the component initial building to prevent crashes with external bindings. |
Protected radComboBoxProperties |
Type : any
|
Default value : {}
|
This property is not related to the functionality of the StackPanel but its necesssary for the RadComboBoxComponent to work. |
Private requestDataEventSubscription |
Type : Subscription
|
Default value : null
|
Subscription to |
scrollFlag |
Default value : false
|
Flag used to know if control is still scrolling |
scrollPanel |
Type : ElementRef<any>
|
Decorators :
@ViewChild('panelScrollable')
|
The scrollable stack panel element |
scrollProviderService |
Type : DataProviderService
|
Virtual Scrolling feature mechanism |
scrollTimer |
Type : any
|
ScrollTimer Event |
stackPanelItem |
Type : QueryList<any>
|
Decorators :
@ContentChildren('stackPanelItem', {descendants: true})
|
Set of child stack panel elements |
Public virtualScroll |
Type : VirtualScrollerDirective
|
Decorators :
@ViewChild(VirtualScrollerDirective)
|
The virtual scroll directive Can be used to reduce the amount of data displayed in this component to improve performance |
virtualScrollEnabled |
Type : boolean
|
Decorators :
@Input()
|
Verifies if the virtual scroll functionality is enabled |
actualSizeCalled |
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:481
|
Flag to know if the Angular event was called |
afterContentInitCalled |
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:465
|
Flag to know if the Angular event was called |
afterViewCheckedCalled |
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:473
|
Flag to know if the Angular event was called |
afterViewInitCalled |
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:457
|
Flag to know if the Angular event was called |
Private bindingValidationCallback |
Type : function
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:618
|
Callback for binding validation |
bindingValidationError |
Type : EventEmitter<any>
|
Default value : new EventEmitter()
|
Decorators :
@Output()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:114
|
output to emit the new value of the bindingValidationError event |
Private cdRefInjection |
Type : ChangeDetectorRef
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:659
|
Change Detector Reference for the component |
Private changeDetectionTimer |
Type : any
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:668
|
A timer to debounce changedetection actions |
Protected changeDetectorNotifier |
Type : ChangeDectionNotifierService
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:576
|
Change Detection Notifier Service instace. |
Private contextMenuUnlistener |
Type : function
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:676
|
Context Menu event unlisten action. |
Private ctxMenuInstance |
Type : any
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:630
|
Reference to the ctxMenuInstance |
customCssClasses |
Type : string
|
Default value : null
|
Decorators :
@HostBinding('class')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:407
|
Applies custom CSS classes |
Private customTooltipInstance |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:641
|
Reference to the custom tooltip instance this is used to render a popup with custom elements used when the content value is not a string |
dataGridRowHeight |
Type : number
|
Default value : 22
|
Decorators :
@Input()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:507
|
Represents the row height of both the DataGrid and XamGrid components it affects the css and also an internal function that virtualized data, so do not change directly on css, use this variable instead. |
Protected domHandlerUnListeners |
Type : Array<void>
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:567
|
A collection (possible undefined) of DOM unlistener functions . That is, functions to de register handlers |
fireLoadedSubscription |
Type : Subscription
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:449
|
Flag to control load event for components inside tab control |
focusable |
Default value : false
|
Decorators :
@HostBinding('class.focusable')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:388
|
Display if the component is focusable or not |
Protected handlersToUnregister |
Type : Array<>
|
Default value : []
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:558
|
handlers to unregister when the component is destroyed |
hasDefinedCursor |
Default value : false
|
Decorators :
@HostBinding('class.hasDefinedCursor')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:415
|
Applies Defined Cursor class |
hostFontFamily |
Type : any
|
Default value : null
|
Decorators :
@HostBinding('style.font-family')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:261
|
Property use it to apply the host binding for the font-family |
hostFontSize |
Type : any
|
Default value : null
|
Decorators :
@HostBinding('style.font-size')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:270
|
Property use it to apply the host binding for the font-size |
hostFontStyle |
Type : any
|
Default value : null
|
Decorators :
@HostBinding('style.font-style')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:279
|
Property use it to apply the host binding for the font-style |
hostFontStyles |
Default value : false
|
Decorators :
@HostBinding('class.defaultFontStyles')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:398
|
Applies default font styles class, used to allow specificity for each control css |
hostFontWeight |
Type : any
|
Default value : null
|
Decorators :
@HostBinding('style.font-weight')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:288
|
Property use it to apply the host binding for the font-weight |
hostHeight |
Type : string
|
Default value : null
|
Decorators :
@HostBinding('style.height')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:218
|
Property use it to apply the host binding for the height |
hostHozCenter |
Default value : false
|
Decorators :
@HostBinding('class.horizontal-center')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:308
|
Applies horizontal alignment left class |
hostHozLeft |
Default value : false
|
Decorators :
@HostBinding('class.horizontal-left')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:298
|
Applies horizontal alignment left class |
hostHozRight |
Default value : false
|
Decorators :
@HostBinding('class.horizontal-right')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:368
|
Applies horizontal alignment right class |
hostHozSelfAlign |
Default value : false
|
Decorators :
@HostBinding('class.horizontal-selfalign')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:380
|
Applies horizontal selfalign class. Flags indicates when the control should handle its own horizontal alignment and ignore container alignment. |
hostHozStretch |
Default value : false
|
Decorators :
@HostBinding('class.horizontal-stretch')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:358
|
Applies horizontal alignment stretch class |
hostMaxHeight |
Type : number
|
Decorators :
@HostBinding('style.max-height.px')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:234
|
Property used to apply the host binding for max-height |
hostMaxWidth |
Type : number
|
Decorators :
@HostBinding('style.max-width.px')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:210
|
Property used to apply the host binding for max-width |
hostMinHeight |
Type : number
|
Decorators :
@HostBinding('style.min-height.px')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:226
|
Property used to apply the host binding for min-height |
hostMinWidth |
Type : number
|
Decorators :
@HostBinding('style.min-width.px')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:202
|
Property used to apply the host binding for min-width |
hostOpacity |
Type : any
|
Default value : null
|
Decorators :
@HostBinding('style.opacity')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:252
|
Property use it to apply the host binding for the opacity |
hostVerBottom |
Default value : false
|
Decorators :
@HostBinding('class.vertical-bottom')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:328
|
Applies vertical alignment bottom class |
hostVerCenter |
Default value : false
|
Decorators :
@HostBinding('class.vertical-center')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:338
|
Applies vertical alignment center class |
hostVerStretch |
Default value : false
|
Decorators :
@HostBinding('class.vertical-stretch')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:318
|
Applies horizontal alignment stretch class |
hostVerTop |
Default value : false
|
Decorators :
@HostBinding('class.vertical-top')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:348
|
Applies vertical alignment top class |
hostVisibility |
Type : any
|
Default value : null
|
Decorators :
@HostBinding('style.display')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:243
|
Property use it to apply the host binding for the visibility |
hostWidth |
Type : string
|
Default value : null
|
Decorators :
@HostBinding('style.width')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:194
|
Property use it to apply the host binding for the width |
hostZIndex |
Type : string
|
Default value : null
|
Decorators :
@HostBinding('style.z-index')
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:424
|
Sets the z-index style. |
isInternalInherit |
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:515
|
Flag which indicates that the component is an internal use for inheritance |
layoutUpdated |
Type : EventEmitter<any>
|
Default value : new EventEmitter()
|
Decorators :
@Output()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:140
|
Output to emit when then component's layout is updated. |
loaded |
Type : EventEmitter<any>
|
Default value : new EventEmitter()
|
Decorators :
@Output()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:123
|
Output to emit when then component is loaded. |
Protected modelChangeRef |
Type : function
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:601
|
Contains the reference of the function added for handle the model's change |
mouseEnter |
Type : EventEmitter<literal type>
|
Default value : new EventEmitter()
|
Decorators :
@Output()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:157
|
Event Emitter. EventEmitter normally called in the mouseEnterHandler. |
mouseLeave |
Type : EventEmitter<literal type>
|
Default value : new EventEmitter()
|
Decorators :
@Output()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:167
|
Event Emitter Called in the mouseLeave handler |
Private mouseLeaveTooltipUnlistener |
Type : function
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:684
|
Mouse over event for tooltip unlisten action. |
mouseLeftButtonUp |
Type : EventEmitter<literal type>
|
Default value : new EventEmitter<any>()
|
Decorators :
@Output()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:147
|
MouseLeftButtonUp event Emitter. |
Private mouseMoveTooltipUnlistener |
Type : function
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:701
|
Mouse move event for tooltip unlisten action. This should have a short lifespan, as much as it takes for the tooltip to be shown |
Private mouseOverTooltipUnlistener |
Type : function
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:692
|
Mouse over event for tooltip unlisten action. |
Protected ngZone |
Type : NgZone
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:585
|
Angular´s NgZone accessor |
Protected pendingDependencyPropertyValue |
Type : Array<>
|
Default value : []
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:549
|
A collection of pending dependency properties values to assign to the model |
Protected pendingSetValues |
Type : Array<>
|
Default value : []
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:540
|
A collection of pending values to assign to the model |
Protected renderer2 |
Type : Renderer2
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:594
|
Angular´s Renderer2 |
sizeChanged |
Type : EventEmitter<any>
|
Default value : new EventEmitter()
|
Decorators :
@Output()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:132
|
Output to emit when then component size is changed. |
Private sizeChangedPendingTimeout |
Type : any
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:610
|
Timeout id for triggering the sizechanged event |
spellCheck |
Default value : false
|
Decorators :
@Input()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:186
|
Flag to determinate if the component should do the spell check or not. Default value is false. |
staticContent |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:432
|
cache the static content of the control to validate if the current data is not equals. |
tabSubscription |
Type : Subscription
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:440
|
TabSelection event subscription |
Private tooltipMousePosition |
Type : DOMRect
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:710
|
To track the position of the mouse while the tooltip is being displayed |
Private toolTipTimeout |
Type : any
|
Default value : null
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:650
|
To control the timer to show the tooltip |
useCss |
Default value : false
|
Decorators :
@Input()
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:177
|
Determines if the component uses CSS height/width values, instead of inputs |
validationError |
Default value : false
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:488
|
Property to set the validationError class in the component |
validationErrorMessage |
Type : string
|
Default value : ''
|
Inherited from
BaseComponent
|
Defined in
BaseComponent:496
|
Property for specifying validation error message |
itemsControlDataSource | ||||||
getitemsControlDataSource()
|
||||||
setitemsControlDataSource(value: any)
|
||||||
Contains the items sent by the ItemsControl
Parameters :
Returns :
void
|
virtualScrollRequired |
getvirtualScrollRequired()
|
Flag indicating the virtual scroll is required to be shown, functionality should be enabled first and the amount of items to be display should require the virtual scroll
Returns :
boolean
|
viewPortHeight |
getviewPortHeight()
|
Get Viewport height defined in the virtual scroll directive
Returns :
number
|
topPaddingHeight |
gettopPaddingHeight()
|
Top padding height for virtual scroll
Returns :
number
|
bottomPaddingHeight |
getbottomPaddingHeight()
|
Gets the bottom padding height
Returns :
number
|
itemsabove | ||||||
getitemsabove()
|
||||||
Calculates the amoun of items above the viewport
Returns :
number
|
||||||
setitemsabove(value: number)
|
||||||
Items above amount
Parameters :
Returns :
void
|
itemsControlItemTemplate | ||||||
getitemsControlItemTemplate()
|
||||||
setitemsControlItemTemplate(value: TemplateRef
|
||||||
Contains the ItemTemplate template sent by the ItemsControl
Parameters :
Returns :
void
|
itemsControlItemTemplateDT |
getitemsControlItemTemplateDT()
|
Contains the DataTemplate sent by the ItemsControl
Returns :
DataTemplate
|
itemsControlDisplayMemberPath | ||||||
getitemsControlDisplayMemberPath()
|
||||||
setitemsControlDisplayMemberPath(value: string)
|
||||||
Contains the ItemsTemplate template sent by the ItemsControl
Parameters :
Returns :
void
|
orientation | ||||||
getorientation()
|
||||||
Gets StackPanel orientation vertical is default.
Returns :
any
|
||||||
setorientation(value: any)
|
||||||
Set stackPanelOrientation
Parameters :
Returns :
void
|
children |
getchildren()
|
Get the collection of children
Returns :
any
|
itemsControlContainsUIElements |
getitemsControlContainsUIElements()
|
Verifies if the items collections contains UIElements to be rendered
Returns :
boolean
|
import {
AfterContentInit,
ChangeDetectionStrategy,
ChangeDetectorRef,
Component,
ContentChildren,
DoCheck,
ElementRef,
Injector,
Input,
OnDestroy,
OnInit,
Optional,
QueryList,
SkipSelf,
TemplateRef,
ViewChild,
} from '@angular/core';
import {
AngularComponentId,
ComponentId,
HorizontalAlignment,
ModelProxy,
Orientation,
StackPanelModel,
DataTemplate,
} from '@mobilize/wms-framework';
import { Subscription } from 'rxjs';
import { VirtualScrollerDirective } from '../../directives/virtual-scroller.directive';
import { DataProviderService } from '../../services/data-provider.service';
import { Utils } from '../../utils/utilities';
import { BaseComponent } from '../base/base.component';
import { GridComponent } from '../grid/grid.component';
/**
* Angular Component for the StackPanel Control.
*
* @export
* @class StackPanelComponent
* @extends {BaseComponent}
* @implements {OnInit}
* @implements {DoCheck}
* @implements {AfterContentInit}
* @implements {OnDestroy}
*/
@Component({
selector: 'wm-stack-panel',
templateUrl: './stack-panel.component.html',
styleUrls: ['./stack-panel.component.scss'],
providers: [{ provide: StackPanelModel, useValue: null }],
changeDetection: ChangeDetectionStrategy.OnPush,
})
@ComponentId([AngularComponentId.stackPanel])
export class StackPanelComponent
extends BaseComponent
implements OnInit, DoCheck, AfterContentInit, OnDestroy
{
/**
* Stack Panel model
*
* @type {StackPanelModel}
* @memberof StackPanelComponent
*/
@Input()
model: StackPanelModel;
/**
* The virtual scroll directive
* Can be used to reduce the amount of
* data displayed in this component to improve performance
*
* @protected
* @type {VirtualScrollerDirective}
* @memberof RadComboBoxComponent
*/
@ViewChild(VirtualScrollerDirective)
public virtualScroll: VirtualScrollerDirective;
/**
* The scrollable stack panel element
*
* @type {TemplateRef<any>}
* @memberof StackPanelComponent
*/
@ViewChild('panelScrollable')
scrollPanel: ElementRef<any>;
/**
* ScrollTimer Event
*
* @type {*}
* @memberof StackPanelComponent
*/
scrollTimer: any;
/**
* Scroll timer to handle items loading from combobox
*
* @type {*}
* @memberof StackPanelComponent
*/
countScrollHandlerTimer: any;
/**
* Flag used to know if control is still scrolling
*
* @memberof StackPanelComponent
*/
scrollFlag = false;
/**
* Contains the items sent by the ItemsControl
*
* @type {any}
* @memberof StackPanelComponent
*/
@Input()
set itemsControlDataSource(value: any) {
this.itemsCtrlDataSource = value;
this.itemsCtrlDataSource?.change?.addHandler(
this.childrenCountChangeHandler,
this
);
}
get itemsControlDataSource(): any {
return this.itemsCtrlDataSource;
}
/************************************************************************************************
* Virtual Scrolling feature mechanism
* */
scrollProviderService: DataProviderService;
/**
* Verifies if the virtual scroll functionality is enabled
*
* @readonly
* @memberof RadComboBoxComponent
*/
@Input()
virtualScrollEnabled: boolean;
/**
* Flag indicating the virtual scroll is required to be shown, functionality should
* be enabled first and the amount of items to be display should require the virtual scroll
*
* @readonly
* @type {boolean}
* @memberof StackPanelComponent
*/
get virtualScrollRequired(): boolean {
return (
this.virtualScrollEnabled && this.virtualScroll.virtualScrollRequired
);
}
/**
* Get Viewport height defined in the
* virtual scroll directive
*
* @readonly
* @type {number}
* @memberof StackPanelComponent
*/
get viewPortHeight(): number {
return this.virtualScroll.viewportHeight;
}
/**
* Top padding height for virtual scroll
*
* @readonly
* @type {number}
* @memberof StackPanelComponent
*/
get topPaddingHeight(): number {
return this.virtualScroll.topPaddingHeight;
}
/**
* Gets the bottom padding height
*
* @type {number}
* @memberof StackPanelComponent
*/
get bottomPaddingHeight(): number {
return this.virtualScroll.bottomPaddingHeight;
}
/**
* Calculates the amoun of items above the viewport
*
* @type {number}
* @memberof StackPanelComponent
*/
get itemsabove(): number {
return this.virtualScroll.itemsAbove;
}
/**
* Items above amount
*
* @memberof StackPanelComponent
*/
set itemsabove(value: number) {
this.virtualScroll.itemsAbove = value;
}
/**
* Handle user action for scrolling on the component
*
* @param {*} $event
* @memberof StackPanelComponent
*/
scrollEventHandler(event: any): void {
if (this.scrollProviderService && !this.scrollFlag) {
if (this.scrollTimer) {
clearTimeout(this.scrollTimer);
}
this.scrollTimer = setTimeout(() => {
this.scrollFlag = true;
this.calculatePageData(false, -1);
}, this.virtualScroll.scrollDelay);
}
}
/**
* loads items based of scrolling position.
*
* @param {boolean} forceUpdate
* @param {number} index
* @memberof StackPanelComponent
*/
calculatePageData(forceUpdate: boolean, index: number): void {
this.virtualScroll.scrollTop = this.scrollPanel.nativeElement.scrollTop;
if (index === -1) {
index =
this.virtualScroll.minIndex +
Math.floor(
(this.scrollPanel.nativeElement.scrollTop -
this.virtualScroll.toleranceHeight) /
this.virtualScroll.itemHeight
);
index =
index > this.virtualScroll.totalItems
? this.virtualScroll.totalItems - this.virtualScroll.pageSize - 1
: index;
index = this.normalizeSplice(
Math.round(
this.scrollPanel.nativeElement.scrollTop /
this.virtualScroll.itemHeight
)
);
}
this.itemsabove =
this.virtualScroll.totalItems > 10
? Math.max(index - this.virtualScroll.minIndex, 0)
: 0;
this.validateRequestItems(index, forceUpdate);
}
/**
* Validates with topIndex if is necessary to request new items
*
* @param {number} index
* @param {boolean} forceUpdate
*
* @memberof StackPanelComponent
*/
validateRequestItems(index: number, forceUpdate: boolean): void {
if (
index === 0 ||
this.virtualScroll.topIndex !== index ||
forceUpdate ||
this.virtualScroll.totalItems <= this.scrollProviderService.maxPageSize ||
index ===
this.virtualScroll.totalItems - this.scrollProviderService.maxPageSize
) {
this.virtualScroll.scrollTop = index * this.virtualScroll.itemHeight;
this.scrollPanel.nativeElement.scrollTop = this.virtualScroll.scrollTop;
this.scrollProviderService.getPage(index, this.virtualScroll.bufferSize);
} else {
this.scrollFlag = false;
}
}
/**
* This function validates if current index is in the range of the final data request
* and change the index to the top scrollIndex to prevent gap in the scrolling
*
* @param {*} index
* @return {*} {number}
* @memberof StackPanelComponent
*/
normalizeSplice(index: number): number {
return index !== 0 &&
this.virtualScroll.totalItems - index - 1 < this.virtualScroll.bufferSize
? this.virtualScroll.totalItems - this.virtualScroll.bufferSize
: index;
}
/**
* Contains the ItemTemplate template sent by the ItemsControl
*
* @type {TemplateRef<any>}
* @memberof StackPanelComponent
*/
@Input()
set itemsControlItemTemplate(value: TemplateRef<any>) {
this.itemsCntrlItemTemplate = value;
const dataSource = this.getDataSource();
this.getDynamicUIElements(dataSource);
}
get itemsControlItemTemplate(): TemplateRef<any> {
return this.itemsCntrlItemTemplate as TemplateRef<any>;
}
/**
* Contains the DataTemplate sent by the ItemsControl
*
* @returns DataTemplate
* @returns StackPanelComponent
*/
get itemsControlItemTemplateDT(): DataTemplate {
return this.itemsCntrlItemTemplate as DataTemplate;
}
/**
* Contains the ItemsTemplate template sent by the ItemsControl
*
* @type {any}
* @memberof StackPanelComponent
*/
@Input()
set itemsControlDisplayMemberPath(value: string) {
this.itemsCntrlDisplayMemberPath = value;
}
get itemsControlDisplayMemberPath(): string {
return this.itemsCntrlDisplayMemberPath;
}
/**
* Set of child stack panel elements
*
* @type {QueryList<any>}
* @memberof StackPanelComponent
*/
@ContentChildren('stackPanelItem', { descendants: true })
stackPanelItem: QueryList<any>;
/**
* Flag to know if the component is ready to render
*
* @type {boolean}
* @memberof StackPanelComponent
*/
isInitialized = false;
/**
* ModelProxy is a copy of the model, used on the component initial building to prevent crashes with external bindings.
*
* @protected
* @type {StackPanelModel}
* @memberof StackPanelComponent
*/
protected modelProxy: StackPanelModel = ModelProxy.create<StackPanelModel>();
/**
* This property is not related to the functionality of the StackPanel but its necesssary
* for the RadComboBoxComponent to work.
*
* @type {any}
* @memberof StackPanelComponent
*/
protected radComboBoxProperties: any = {};
/**
* Gets StackPanel orientation vertical is default.
*
* @readonly
* @type {*}
* @memberof StackPanelComponent
*/
get orientation(): any {
return this.model.Orientation;
}
/**
* Set stackPanelOrientation
*
* @memberof StackPanelComponent
*/
@Input()
set orientation(value: any) {
this.modelProxy.Orientation = Orientation[value];
}
/**
* Get the collection of children
*
* @readonly
* @type {*}
* @memberof StackPanelComponent
*/
get children(): any {
return this.model.Children;
}
/**
* Verifies if the items collections contains UIElements to be rendered
*
* @returns boolean True if the collection contains UIElements otherwise false
* @memberof StackPanelComponent
*/
get itemsControlContainsUIElements(): boolean {
return Utils.containsUIElement(this.itemsControlDataSource);
}
/**
* Property used to save the collection to render as dynamic controls
*
* @private
* @type *
* @memberof StackPanelComponent
*/
private itemsCtrlDataSource: any;
/**
* Property used to save the template that will be use to render the itemsCtrlDataSource items
*
* @private
* @type {*}
* @memberof StackPanelComponent
*/
private itemsCntrlItemTemplate: TemplateRef<any> | DataTemplate;
/**
* Property used to save the template that will be use to render the itemsCtrlDataSource items
*
* @private
* @type {*}
* @memberof StackPanelComponent
*/
private itemsCntrlDisplayMemberPath: string;
/**
* Object that contains a list of control to be render
*
* @private
* @type *
* @memberof StackPanelComponent
*/
itemsToRender: any;
/**
* Subscription to `requestDataEvent` on scroll `DataProviderService`.
*
* @private
* @type {Subscription}
* @memberof StackPanelComponent
*/
private requestDataEventSubscription: Subscription = null;
/**
* Subscription to `itemsCountChanging` on scroll `DataProviderService`.
*
* @private
* @type {Subscription}
* @memberof StackPanelComponent
*/
private itemsCountChangingSubscription: Subscription = null;
/**
* Defines stackPanel model.
*
* @param {StackPanelModel} injectedModel
* @param {ChangeDetectorRef} cd
* @memberof StackPanelComponent
*/
public constructor(
private injector: Injector,
@SkipSelf() @Optional() private injectedModel: StackPanelModel,
private cd: ChangeDetectorRef
) {
super(cd, injector);
this.model = injectedModel;
}
/**
* Angular lifecycle, creates modelProxy copy.
*
* @memberof StackPanelComponent
*/
ngDoCheck(): void {
super.ngDoCheck();
this.checkItemsHandlers();
}
/**
* Angular lifecycle, creates modelProxy copy.
*
* @memberof StackPanelComponent
*/
ngOnInit(): void {
this.model = this.model || this.injectedModel || new StackPanelModel();
this.scrollProviderService = this.injectorBase.get<DataProviderService>(
DataProviderService,
new DataProviderService()
);
/* istanbul ignore next */
this.requestDataEventSubscription =
this.scrollProviderService.requestDataEvent.subscribe((index: number) => {
if (this.scrollPanel) {
this.scrollPanel.nativeElement.scrollTop =
this.virtualScroll.scrollTop; // Restore previous position to open the popup in selected item
this.calculatePageData(false, index);
} else {
this.scrollProviderService.getPage(0, this.virtualScroll.bufferSize);
}
});
/* istanbul ignore next */
this.itemsCountChangingSubscription =
this.scrollProviderService.itemsCountChanging.subscribe((flag: any) => {
this.itemsCountChanging(flag);
});
this.setupModel(this.model);
super.ngOnInit();
this.model.Children.change.addHandler(
this.childrenCountChangeHandler,
this
);
}
/**
* Process the flag emited by combobox and update scrolling status
*
* @param {*} flag
* @memberof StackPanelComponent
*/
/* istanbul ignore next */
itemsCountChanging(flag: any): void {
if (!flag) {
if (this.countScrollHandlerTimer) {
clearTimeout(this.countScrollHandlerTimer);
}
this.countScrollHandlerTimer = setTimeout(() => {
this.scrollFlag = false;
/* istanbul ignore else */
if (this.scrollPanel) {
this.scrollPanel.nativeElement.scrollTop =
this.virtualScroll.scrollTop;
}
}, this.virtualScroll.scrollDelay);
} else {
this.scrollFlag = true;
}
}
/**
* method use it to handle the children properties change.
*
* @param {string} name property name
* @return {void}
* @memberof StackPanelComponent
*/
childrenCountChangeHandler(name: string): void {
/* istanbul ignore else */
if ('Count' === name) {
const dataSource = this.getDataSource();
this.getDynamicUIElements(dataSource);
this.scrollFlag = false;
}
}
/**
* Angular lifecycle hook.
*
* @memberof StackPanelComponent
*/
ngAfterContentInit(): void {
super.ngAfterContentInit();
this.isInitialized = true;
const dataSource = this.getDataSource();
this.getDynamicUIElements(dataSource);
this.isGridItem();
if (this.virtualScrollEnabled) {
setTimeout(() => {
this.scrollProviderService.getPage(0, this.virtualScroll.bufferSize);
this.detectChangesAction();
}, 0);
}
}
/**
* Verify if some its items is a Grid Instance
*
* @return {void}
* @memberof StackPanelComponent
*/
isGridItem(): void {
this.stackPanelItem.forEach((item) => {
/* istanbul ignore else */
if (item instanceof GridComponent) {
item.widthDefaultStyle = () =>
this.modelProxy?.HorizontalAlignment === HorizontalAlignment.Center &&
this.modelProxy.Orientation === Orientation.Vertical
? 'auto'
: '100%';
item.processWidths('Width');
}
});
}
/**
* Angular life cycle hook
*
* @return {void}
* @memberof StackPanelComponent
*/
ngOnDestroy(): void {
super.ngOnDestroy();
this.itemsCtrlDataSource?.change?.removeHandler(
this.childrenCountChangeHandler,
this
);
this.model.Children.change.removeHandler(
this.childrenCountChangeHandler,
this
);
this.requestDataEventSubscription.unsubscribe();
this.itemsCountChangingSubscription.unsubscribe();
}
/**
* Returns true if vertical orientation
*
* @return {*} {boolean}
* @memberof StackPanelComponent
*/
isVertical(): boolean {
return this.model.Orientation === Orientation.Vertical;
}
/**
* Returns true if horizontal orientation
*
* @return {*} {boolean}
* @memberof StackPanelComponent
*/
isHorizontal(): boolean {
return this.model.Orientation === Orientation.Horizontal;
}
/**
* Function that defines class orientation
*
* @return {*} {*}
* @memberof StackPanelComponent
*/
orientationClass(): any {
return this.isVertical() ? 'OrientationVertical' : 'OrientationHorizontal';
}
/**
* Function that returns the dynamic components to render
*
* @returns any Array of components
*/
getDynamicUIElements(arrayToInspect: any): any {
let newControlsToRender = [];
// Getting the controls to inspect, we have two options:
// 1) controls from the itemsControl sent by context
// 2) controls from the stack panel itself
if (this.isInitialized && arrayToInspect) {
// Gets the controls that are dynamic
const staticCtrlModels = this.stackPanelItem.map((x) => x.model);
newControlsToRender = Utils.differenceWith(
arrayToInspect,
staticCtrlModels
);
/* istanbul ignore else */
if (newControlsToRender && newControlsToRender.length > 0) {
// Returns the list of dynamic components to be render
this.itemsToRender = {
dynamics: newControlsToRender,
injector: this.injector,
container: 'stackpanel',
};
}
this.detectChangesAction();
}
}
/**
* Return a wrapped object with a context property.
* If the data comes from a dataContext, it will used this method
* to generate the groups. This context is used when the ItemsControl
* passed the datasource to the stackpanel component.
*
* @param {any} item
* @return {*} {context: any}
* @memberof StackPanelComponent
*/
getContext(item: any): any {
return { context: item };
}
/**
* Check if the Children collection has the right handlers
*
* @type {void}
* @memberof StackPanelComponent
*/
checkItemsHandlers(): void {
if (this.model.Children.change.hasHandlers()) return;
this.model.Children.change.addHandler(
this.childrenCountChangeHandler,
this
);
}
/**
* Returns the current data collection for the stack panel.
*
* @private
* @return {*} {*}
* @memberof StackPanelComponent
*/
private getDataSource(): any {
return this.itemsControlDataSource
? this.itemsControlDataSource.internalArray
: this.children.internalArray;
}
}
<ng-container wmVirtualScroller [hostComponent]="this">
<div
*ngIf="model && visibility && isInitialized && !virtualScrollRequired"
[ngClass]="orientationClass()"
class="autoHeightWidth panelContext"
>
<ng-content></ng-content>
<ng-container *ngIf="!itemsControlDataSource">
<ng-container *ngTemplateOutlet="generateDynamicControls"></ng-container>
</ng-container>
<!-- Start rendering content from ItemsControl component-->
<ng-container *ngIf="itemsControlDataSource">
<ng-container *ngIf="!itemsControlContainsUIElements">
<ng-container
*ngFor="
let value of itemsControlDataSource;
let i = index;
trackBy: trackByFn
"
>
<!-- This section is for standard item template (xaml)-->
<ng-container
*ngIf="
itemsControlItemTemplate &&
!itemsControlItemTemplateDT.TemplateComponentConstructor
"
>
<ng-container
*ngTemplateOutlet="
itemsControlItemTemplate;
context: getContext(value)
"
>
</ng-container>
</ng-container>
<!-- This section represent the items control when the items data comes through dataTemplate.-->
<ng-container
*ngIf="
itemsControlItemTemplate &&
itemsControlItemTemplateDT.TemplateComponentConstructor
"
>
<ng-container
*ngComponentOutlet="
itemsControlItemTemplateDT.TemplateComponentConstructor;
injector: value
| toInjector: itemsControlItemTemplateDT.declaringContext
"
>
</ng-container>
</ng-container>
<!-- Represents a element with not template and display member -->
<ng-container
*ngIf="!itemsControlItemTemplate && itemsControlDisplayMemberPath"
>
{{ value[itemsControlDisplayMemberPath]?.toString() }}
</ng-container>
<!-- Represents a element with not template and not display member -->
<ng-container
*ngIf="!itemsControlItemTemplate && !itemsControlDisplayMemberPath"
>
{{ value?.toString() }}
</ng-container>
</ng-container>
</ng-container>
<ng-container *ngIf="itemsControlContainsUIElements">
<ng-container
*ngTemplateOutlet="generateDynamicControls"
></ng-container>
</ng-container>
</ng-container>
</div>
<!-- VIRTUAL SCROLLING STACK PANEL -->
<div
#panelScrollable
[attr.wm-item-height]="virtualScroll.itemHeight"
[attr.wm-page-size]="virtualScroll.pageSize"
[attr.wm-view-port-height]="virtualScroll.viewportHeight"
*ngIf="model && visibility && isInitialized && virtualScrollRequired"
[ngClass]="orientationClass()"
class="panelContext virtual-scroll"
(scroll)="scrollEventHandler($event)"
[style.height.px]="viewPortHeight"
>
<div class="topPadding" [style.height.px]="topPaddingHeight"></div>
<ng-container *ngIf="!itemsControlDataSource">
<ng-container *ngTemplateOutlet="generateDynamicControls"></ng-container>
</ng-container>
<!-- Start rendering content from ItemsControl component-->
<ng-container *ngIf="itemsControlDataSource">
<ng-container *ngIf="!itemsControlContainsUIElements">
<ng-container
*ngFor="
let value of itemsControlDataSource;
let i = index;
trackBy: trackByFn
"
>
<!-- This section is for standard item template (xaml)-->
<ng-container
*ngIf="
itemsControlItemTemplate &&
!itemsControlItemTemplateDT.TemplateComponentConstructor
"
>
<ng-container
*ngTemplateOutlet="
itemsControlItemTemplate;
context: getContext(value)
"
>
</ng-container>
</ng-container>
<!-- This section represent the items control when the items data comes through dataTemplate.-->
<ng-container
*ngIf="
itemsControlItemTemplate &&
itemsControlItemTemplateDT.TemplateComponentConstructor
"
>
<ng-container
*ngComponentOutlet="
itemsControlItemTemplateDT.TemplateComponentConstructor;
injector: value
| toInjector: itemsControlItemTemplateDT.declaringContext
"
>
</ng-container>
</ng-container>
<!-- Represents a element with not template and display member -->
<ng-container
*ngIf="!itemsControlItemTemplate && itemsControlDisplayMemberPath"
>
{{ value[itemsControlDisplayMemberPath]?.toString() }}
</ng-container>
<!-- Represents a element with not template and not display member -->
<ng-container
*ngIf="!itemsControlItemTemplate && !itemsControlDisplayMemberPath"
>
{{ value?.toString() }}
</ng-container>
</ng-container>
</ng-container>
<ng-container *ngIf="itemsControlContainsUIElements">
<ng-container
*ngTemplateOutlet="generateDynamicControls"
></ng-container>
</ng-container>
</ng-container>
<!-- End rendering content from ItemsControl component-->
<div class="bottomPadding" [style.height.px]="bottomPaddingHeight"></div>
</div>
</ng-container>
<ng-template #generateDynamicControls>
<wm-container
*ngIf="itemsToRender"
[ngClass]="orientationClass | memoize: orientation"
[controls]="itemsToRender"
></wm-container>
</ng-template>
./stack-panel.component.scss
.Orientation {
display: flex;
align-items: flex-start;
}
:host::ng-deep .OrientationVertical {
@extend .Orientation;
flex-direction: column;
> wm-button.vertical-stretch,
wm-toggle-button.vertical-stretch {
height: auto !important;
}
}
:host::ng-deep .OrientationHorizontal {
@extend .Orientation;
flex-direction: row;
> wm-button.horizontal-stretch,
wm-toggle-button.horizontal-stretch {
width: auto !important;
}
}
.virtual-scroll {
overflow-y: auto;
display: block;
}