projects/wms-framework/src/lib/models/controls/ItemsControlModel.ts
Model class to represent Image component
constructor()
|
| Public AngularComponentId |
Default value : AngularComponentId.itemsControl
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:189
|
|
Identifies the angular component associated with the model |
| Private collectionChangedSubscription |
Type : function
|
|
Subscription for the CollectionChanged event of the items source (if exists) |
| Public DisplayMemberPath |
Type : string
|
Decorators :
@Dependency(ItemsControlModel.DisplayMemberPathProperty)
|
|
The display member path |
| Static DisplayMemberPathProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'DisplayMemberPath',
null,
null
)
|
|
DisplayMemberPathProperty dependency property |
| Private itemContainerGenerator |
Type : any
|
Default value : null
|
| Public items |
Type : ItemsCollectionModel
|
| Private itemsCollectionListenerRef |
Type : INotifyCollectionChanged
|
|
Reference to subscription when the model is initilized. |
| Public ItemsPanel |
Type : any
|
Decorators :
@Dependency(ItemsControlModel.ItemsPanelProperty)
|
|
The items panel |
| Static ItemsPanelProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'ItemsPanel',
null,
null
)
|
|
ItemsPanelProperty dependency property |
| Public ItemsSource |
Type : Iterable<any>
|
Decorators :
@Dependency(ItemsControlModel.ItemsSourceProperty)
|
|
Items source |
| Static ItemsSourceProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'ItemsSource',
null,
ItemsControlModel.ItemsSourceCallback
)
|
|
ItemsSourceProperty dependency property |
| Public ItemTemplate |
Type : any
|
Decorators :
@Dependency(ItemsControlModel.ItemTemplateProperty)
|
|
The item template |
| Static ItemTemplateProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'ItemTemplate',
null,
null
)
|
|
ItemTemplateProperty dependency property |
| Private valueConvertRef |
Type : INotifyCollectionChanged
|
|
Reference to callbar called whenever the ItemsSource have changed. |
| avoidTemplateModelResolution |
Type : boolean
|
|
Inherited from
Control
|
|
Defined in
Control:431
|
|
Flag to determine if the default template must used instead of the dynamic template when resolving the component to use to render the current control. When a control model has a control template associated, the component of the control template is used to render the current model |
| Public Background |
Type : Brush
|
Decorators :
@Dependency(Control.BackgroundProperty)
|
|
Inherited from
Control
|
|
Defined in
Control:255
|
|
Gets or sets the background property |
| Static BackgroundProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'Background',
null,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:45
|
|
BackgroundProperty dependency property |
| Public BorderBrush |
Type : any
|
Decorators :
@Dependency(Control.BorderBrushProperty)
|
|
Inherited from
Control
|
|
Defined in
Control:264
|
|
Gets or sets the border brush |
| Static BorderBrushProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'BorderBrush',
null,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:59
|
|
BorderBrushProperty dependency property |
| Public BorderThickness |
Type : any
|
Decorators :
@Dependency(Control.BorderThicknessProperty)
|
|
Inherited from
Control
|
|
Defined in
Control:273
|
|
Gets or sets the border thickness |
| Static BorderThicknessProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'BorderThickness',
null,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:72
|
|
BorderThicknessProperty dependency property |
| Static CharacterSpacingProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'CharacterSpacing',
null,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:85
|
|
CharacterSpacingProperty dependency property |
| Public DefaultStyleKey |
Type : unknown
|
|
Inherited from
Control
|
|
Defined in
Control:367
|
| Static DefaultStyleKeyProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'DeafaultStyleKey',
null,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:98
|
|
DefaultStyleKeyProperty dependency property |
| Public FontFamily |
Type : any
|
Decorators :
@Dependency(Control.FontFamilyProperty)
|
|
Inherited from
Control
|
|
Defined in
Control:282
|
|
Gets or sets the font family |
| Static FontFamilyProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'FontFamily',
null,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:111
|
|
FontFamilyProperty dependency property |
| Public FontSize |
Type : number
|
Decorators :
@Dependency(Control.FontSizeProperty)
|
|
Inherited from
Control
|
|
Defined in
Control:291
|
|
Gets or sets the font size |
| Static FontSizeProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'FontSize',
null,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:124
|
|
FontSizeProperty dependency property |
| Public FontStretch |
Type : any
|
Decorators :
@Dependency(Control.FontStretchProperty)
|
|
Inherited from
Control
|
|
Defined in
Control:300
|
|
Gets or sets the font stretch |
| Static FontStretchProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'FontStretch',
null,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:137
|
|
FontStretchProperty dependency property |
| Public FontStyle |
Type : any
|
Decorators :
@Dependency(Control.FontStyleProperty)
|
|
Inherited from
Control
|
|
Defined in
Control:309
|
|
Gets or sets the font style |
| Static FontStyleProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'FontStyle',
null,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:150
|
|
FontStyleProperty dependency property |
| Public FontWeight |
Type : any
|
Decorators :
@Dependency(Control.FontWeightProperty)
|
|
Inherited from
Control
|
|
Defined in
Control:318
|
|
Gets or sets the font weight |
| Static FontWeightProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'FontWeight',
null,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:163
|
|
FontWeightProperty dependency property |
| Public Foreground |
Type : any
|
Decorators :
@Dependency(Control.ForegroundProperty)
|
|
Inherited from
Control
|
|
Defined in
Control:327
|
|
Gets or sets the foreground |
| Static ForegroundProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'Foreground',
null,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:176
|
|
ForegroundProperty dependency property |
| Public IsEnabledChanged |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent()
|
|
Inherited from
Control
|
|
Defined in
Control:374
|
|
The IsEnabledChanged event |
| Public IsTabStop |
Type : boolean
|
Decorators :
@Dependency(Control.IsTabStopProperty)
|
|
Inherited from
Control
|
|
Defined in
Control:336
|
|
Gets or sets the is tab stop property |
| Static IsTabStopProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'IsTabStop',
true,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:189
|
|
IsTabStopProperty dependency property |
| Public Padding |
Type : any
|
Decorators :
@Dependency(Control.PaddingProperty)
|
|
Inherited from
Control
|
|
Defined in
Control:345
|
|
Gets or sets the padding |
| Static PaddingProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'Padding',
null,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:202
|
|
PaddingProperty dependency property |
| Public TabIndex |
Type : number
|
Decorators :
@Dependency(Control.TabIndexProperty)
|
|
Inherited from
Control
|
|
Defined in
Control:354
|
|
Gets or sets the tab index |
| Static TabIndexProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'TabIndex',
0,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:215
|
|
TabIndexProperty dependency property |
| TabNavigation |
Type : any
|
Default value : null
|
|
Inherited from
Control
|
|
Defined in
Control:365
|
| Static TabNavigationProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'TabNavigation',
null,
null
)
|
|
Inherited from
Control
|
|
Defined in
Control:228
|
|
TabNavigationProperty dependency property |
| Public Template |
Type : any
|
Decorators :
@Dependency(Control.TemplateProperty)
|
|
Inherited from
Control
|
|
Defined in
Control:363
|
|
Gets or sets the template |
| templateModel |
Type : any
|
|
Inherited from
Control
|
|
Defined in
Control:418
|
|
Model for the control template This property has value when a |
| Static TemplateProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'TemplateProperty',
null,
Control.TemplateCallback
)
|
|
Inherited from
Control
|
|
Defined in
Control:241
|
|
TemplateProperty dependency property |
| Public ActualHeight |
Type : number
|
Decorators :
@Dependency(FrameworkElement.ActualHeightProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:905
|
| Static ActualHeightProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'ActualHeight',
0,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:53
|
|
ActualHeightProperty dependency property |
| Public ActualWidth |
Type : number
|
Decorators :
@Dependency(FrameworkElement.ActualWidthProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:908
|
| Static ActualWidthProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'ActualWidth',
0,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:66
|
|
ActualWidthProperty dependency property |
| allowDataContextAnchestorSet |
Default value : true
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:738
|
| Public Clip |
Type : any
|
Decorators :
@Dependency(FrameworkElement.ClipProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:660
|
|
Gets or sets the clip |
| Public ctxMenuManager |
Type : ContextMenuManager
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:725
|
|
Instance related to a XamContextMenuComponent |
| Public CtxMenuOpened |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:602
|
|
Context menu opened event |
| Private currentStyleChange |
Type : string[]
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:320
|
| Public Cursor |
Type : Cursor
|
Decorators :
@Dependency(FrameworkElement.CursorProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:652
|
|
Gets or sets the cursor |
| Static CursorProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'Cursor',
null,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:79
|
|
CursorProperty dependency property |
| Static DataContextProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'DataContext',
null,
FrameworkElement.DataContextCallback
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:92
|
|
DataContextProperty dependency property |
| Public FlowDirection |
Type : any
|
Decorators :
@Dependency(FrameworkElement.FlowDirectionProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:668
|
|
Gets or sets the flow direction |
| Static FlowDirectionProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'FlowDirection',
null,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:105
|
|
FlowDirectionProperty dependency property |
| Public hasFocus |
Default value : false
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:624
|
|
Flag to determine if the framework element has the docus |
| height |
Type : number
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:802
|
| Static Readonly HeightProperty |
Default value : new DependencyProperty(
'Height',
Number.NaN,
FrameworkElement.HeightChangeCallback
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:118
|
|
HeightProperty dependency property |
| Public HorizontalAlignment |
Type : HorizontalAlignment
|
Decorators :
@Dependency(FrameworkElement.HorizontalAlignmentProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:755
|
|
Gets or sets the horizontal alignment |
| Static HorizontalAlignmentProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'HorizontalAlignment',
HorizontalAlignment.Stretch,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:131
|
|
HorizontalAlignmentProperty dependency property |
| Public HorizontalContentAlignment |
Type : HorizontalAlignment
|
Decorators :
@Dependency(FrameworkElement.HorizontalContentAlignmentProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:764
|
|
Gets or sets the horizontal content alignment. |
| Static Readonly HorizontalContentAlignmentProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'HorizontalContentAlignment',
HorizontalAlignment.Center,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:145
|
|
HorizontalContentAlignment dependency property. |
| Protected isDefaultStyleApplied |
Type : boolean
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:917
|
|
Indicates if the current style is from a default style |
| Public IsEnabled |
Type : boolean
|
Decorators :
@Dependency(FrameworkElement.IsEnabledProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:635
|
|
Gets value indicating if the control is enabled /// TODO check property defined in Control instead of framework element |
| Static Readonly IsEnabledProperty |
Default value : new DependencyProperty(
'IsEnabled',
true,
FrameworkElement.IsEnabledCallback
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:160
|
|
IsEnabledProperty dependency property |
| Private isFirstTimeLoad |
Default value : true
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:824
|
|
Flag used to check if it is the first time loading a model or not. |
| Static LanguageProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'Language',
null,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:173
|
|
LanguageProperty dependency property |
| Public LayoutUpdated |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:593
|
| Public Loaded |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:589
|
| Public Margin |
Type : ThicknessModel
|
Decorators :
@Dependency(FrameworkElement.MarginProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:644
|
|
Gets or sets the margin |
| Static MarginProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'Margin',
null,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:186
|
|
MarginProperty dependency property |
| Public maxHeight |
Type : number
|
Decorators :
@Dependency(FrameworkElement.MaxHeightProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:708
|
|
Gets or sets max height |
| Static MaxHeightProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'MaxHeight',
0,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:199
|
|
MaxHeightProperty dependency property |
| Public maxWidth |
Type : number
|
Decorators :
@Dependency(FrameworkElement.MaxWidthProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:678
|
|
Gets or sets the max width |
| Static MaxWidthProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'MaxWidth',
0,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:212
|
|
MaxWidthProperty dependency property |
| Public minHeight |
Type : number
|
Decorators :
@Dependency(FrameworkElement.MinHeightProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:698
|
|
Gets or sets the min height |
| Static MinHeightProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'MinHeight',
0,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:225
|
|
MinHeightProperty dependency property |
| Public minWidth |
Type : number
|
Decorators :
@Dependency(FrameworkElement.MinWidthProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:688
|
|
Gets or sets the min width |
| Static MinWidthProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'MinWidth',
0,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:238
|
|
MinWidthProperty dependency property |
| Public name |
Type : string
|
Default value : ''
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:617
|
| Static NameProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'Name',
null,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:251
|
|
NameProperty dependency property |
| Private parent |
Type : FrameworkElement
|
Default value : null
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:736
|
| parentChangeHandler |
Type : function
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:746
|
| Public resources |
Type : ResourceDictionary
|
Default value : new ResourceDictionary()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:717
|
|
Resources property |
| Public SizeChanged |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:614
|
| Private sizeChangedPendingTimeout |
Type : any
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:321
|
| Public Style |
Type : RuntimeStyleInfo
|
Decorators :
@Dependency(FrameworkElement.StyleProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:800
|
|
Gets or sets the style |
| Static StyleProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'Style',
null,
FrameworkElement.StyleCallback
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:264
|
|
StyleProperty dependency property |
| Public Tag |
Type : any
|
Decorators :
@Dependency(FrameworkElement.TagProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:902
|
|
Gets or sets the tag |
| Static TagProperty |
Default value : new DependencyProperty('Tag', null, null)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:277
|
|
TagProperty dependency property |
| Public tooltip |
Type : ToolTipModel
|
Default value : null
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:734
|
|
Instance related to a tooltip component for this control |
| Public ToolTipSet |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:611
|
|
ToolTipSet event |
| Public Unloaded |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:591
|
| Public VerticalAlignment |
Type : VerticalAlignment
|
Decorators :
@Dependency(FrameworkElement.VerticalAlignmentProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:773
|
|
Gets or sets the vertical alignment |
| Static VerticalAlignmentProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'VerticalAlignment',
VerticalAlignment.Stretch,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:286
|
|
VerticalAlignmentProperty dependency property |
| Public VerticalContentAlignment |
Type : VerticalAlignment
|
Decorators :
@Dependency(FrameworkElement.VerticalContentAlignmentProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:782
|
|
Gets or sets the vertical content alignment. |
| Static VerticalContentAlignmentProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'VerticalContentAlignment',
VerticalAlignment.Center,
null
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:299
|
|
VerticalContentAlignment dependency property. |
| Public Width |
Type : number
|
Decorators :
@Dependency(FrameworkElement.WidthProperty)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:791
|
|
Gets or sets the width |
| Static WidthProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'Width',
Number.NaN,
FrameworkElement.WidthChangeCallback
)
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:314
|
|
WidthProperty dependency property |
| Private __internalVisibility |
Type : boolean
|
Default value : true
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:289
|
| Public AllowDrop |
Type : boolean
|
Decorators :
@Dependency(UIElement.AllowDropProperty)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:279
|
|
Gets or sets the allow drop value |
| Static AllowDropProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'AllowDrop',
false,
null
)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:52
|
|
AllowDropProperty dependency property |
| Public CacheMode |
Type : any
|
Decorators :
@Dependency(UIElement.CacheModeProperty)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:287
|
|
Gets or sets the cache mode value |
| Static CacheModeProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'CacheMode',
null,
null
)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:65
|
|
CacheModeProperty dependency property |
| capturedMoveHandler |
Type : function
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:339
|
| capturedUpHandler |
Type : function
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:338
|
| Static ClipProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'Clip',
null,
null
)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:78
|
|
ClipProperty dependency property |
| Private customCSSClasses |
Type : string
|
Default value : ''
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:271
|
|
Custom property to save CSS classes that need to be applied to the control |
| Static EffectProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'Effect',
null,
null
)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:91
|
|
EffectProperty dependency property |
| Public GotFocus |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent<(s: any, e: any) => void>()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:229
|
| Private hasAutoColumnGridParent |
Type : boolean
|
Default value : false
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:262
|
|
Custom property to know if control is inside grid with auto columns |
| Public IsHitTestVisible |
Type : boolean
|
Default value : false
|
Decorators :
@Dependency(UIElement.IsHitTestVisibleProperty)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:322
|
|
IsHitTestVisible property |
| Static IsHitTestVisibleProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'IsHitTestVisible',
null,
null
)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:104
|
|
IsHitTestVisibleProperty dependency property |
| Public KeyDown |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent<(s: any, e: any) => void>()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:225
|
| Public KeyUp |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent<(s: any, e: any) => void>()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:227
|
| Public LostFocus |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent<(sender: any, e: any) => void>()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:231
|
| Public MouseEnter |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent<(s: any, e: any) => MouseEventArgs>()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:213
|
| Public MouseLeave |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent<(s: any, e: any) => MouseEventArgs>()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:215
|
| Public MouseLeftButtonDown |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent<(s: any, e: MouseEventArgs) => void>()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:207
|
| Public MouseLeftButtonUp |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent<(s: any, e: MouseEventArgs) => void>()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:217
|
| Public MouseMove |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent<(s: any, e: MouseEventArgs) => void>()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:223
|
| Public MouseRightButtonDown |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent<(s: any, e: MouseEventArgs) => void>()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:210
|
| Public MouseRightButtonUp |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent<(s: any, e: MouseEventArgs) => void>()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:220
|
| Public Name |
Type : string
|
Default value : ''
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:242
|
|
Name property |
| Public OnModelChange |
Type : function
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:42
|
|
On model change handler reference |
| Public Opacity |
Type : number
|
Decorators :
@Dependency(UIElement.OpacityProperty)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:253
|
|
Gets or sets the opacity value |
| Static OpacityMaskProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'OpacityMask',
null,
null
)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:117
|
|
OpacityMaskProperty dependency property |
| Static OpacityProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'Opacity',
1,
null
)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:130
|
|
OpacityProperty dependency property |
| Static ProjectionProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'Projection',
null,
null
)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:143
|
|
ProjectionProperty dependency property |
| Public RenderSize |
Type : Size
|
Decorators :
@Dependency(UIElement.RenderSizeProperty)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:297
|
|
Gets the final render size of a UIElement. |
| Static RenderSizeProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'RenderSize',
new Size(0, 0),
null
)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:156
|
|
RenderSizeProperty dependency property |
| Public RenderTransform |
Type : any
|
Decorators :
@Dependency(UIElement.RenderTransformProperty)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:314
|
|
Gets or sets the render transform |
| Public RenderTransformOrigin |
Type : any
|
Decorators :
@Dependency(UIElement.RenderTransformOriginProperty)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:305
|
|
Gets or sets the render transform origin |
| Static RenderTransformOriginProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty('RenderTransformOrigin', null, null)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:169
|
|
RenderTransformOriginProperty dependency property |
| Static RenderTransformProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'RenderTransform',
null,
null
)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:179
|
|
RenderTransformProperty dependency property |
| Public Spin |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent<(sender: any, e: any) => void>()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:233
|
| Static UseLayoutRoundingProperty |
Type : DependencyProperty
|
Default value : new DependencyProperty(
'UseLayoutRounding',
true,
null
)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:192
|
|
UseLayoutRoundingProperty dependency property |
| Static VisibilityProperty |
Default value : new DependencyProperty('Visibility', true, null)
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:205
|
|
VisibilityProperty dependency property |
| Protected bindingExpressions |
Default value : new SimpleDictionary<
string,
BindingExpression
>()
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:65
|
| Public BindingValidationError |
Default value : new SubscriptionEvent<
(sender: any, e: BindingValidationErrorEventArgs) => void
>()
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:78
|
|
Event for validation errors |
| Public change |
Type : SubscriptionEvent<void>
|
Default value : new SubscriptionEvent()
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:61
|
|
Infrastructure event for notifying event changes |
| Public Dispatcher |
Type : Dispatcher
|
Default value : Dispatcher.GetDispatcher()
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:55
|
| isEnableSetPropertiesRegistry |
Type : boolean
|
Default value : true
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:125
|
|
Flag which indicates if the dependency property set mechanism is enable |
| Public IsInitializingBindings |
Type : boolean
|
Default value : false
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:178
|
|
Property to determine if bindings are being initialized |
| previousValidationMessage |
Type : string
|
Default value : ''
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:70
|
| Protected properties |
Type : object
|
Default value : {}
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:64
|
| Private setPropertiesRegistry |
Type : Map<string | boolean>
|
Default value : new Map()
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:116
|
|
Registry with dependencies properties which has been set |
| validationerr |
Default value : false
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:69
|
| validationMessagesStack |
Type : Array<>
|
Default value : []
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:106
|
|
Keeps a queue of validation messages registered on the current Dependency Object |
| Public forceSyncItemsWithItemsSource |
forceSyncItemsWithItemsSource()
|
|
Force sync items collection
Returns :
void
|
| GetChild | ||||||
GetChild(idx: number)
|
||||||
|
Inherited from
DependencyObject
|
||||||
|
Defined in
DependencyObject:243
|
||||||
|
Gets the child element at the index position
Parameters :
Returns :
DependencyObject
{DependencyObject} |
| GetChildrenCount |
GetChildrenCount()
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:231
|
|
Return the amount of children the parent has
Returns :
number
{number} |
| Static ItemsSourceCallback | |||||||||
ItemsSourceCallback(sender: DependencyObject, args: DependencyPropertyChangedEventArgs)
|
|||||||||
|
ItemsSource dependency property callback
Parameters :
Returns :
void
|
| OnDestroy |
OnDestroy()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:284
|
|
Called when the component is being destroyed, clear some handlers attach to this model.
Returns :
void
|
| Public OnItemsSourceChanged | ||||||
OnItemsSourceChanged(args: DependencyPropertyChangedEventArgs)
|
||||||
|
On ItemsSource changed handler
Parameters :
Returns :
void
|
| Private propagateCollectionChanges | ||||||||||||
propagateCollectionChanges(collection: any, info: CollectionChangeInfo)
|
||||||||||||
|
Applies the changes in bound collection to this { ItemsConttrolModel } internal collection changes in bound collection
Parameters :
Returns :
void
|
| Private rebuildCollection |
rebuildCollection(collection: any, info: any)
|
|
Rebuild collection without triggering reset event and restore the items
Returns :
void
|
| Private setItemsProperty | ||||||
setItemsProperty(collection: any)
|
||||||
|
Call this method to fill the items property
Parameters :
Returns :
void
|
| Private setItemsPropertyEvent | ||||||||||||
setItemsPropertyEvent(collection: any, info: CollectionChangeInfo)
|
||||||||||||
|
Call this method to fill the items property
Parameters :
Returns :
void
|
| Private SetUpHierarchyListeners | ||||||
SetUpHierarchyListeners(value: Iterable<any>)
|
||||||
|
Sets the listeners for the items property
Parameters :
Returns :
void
|
| Private ValidateInfo | |||||||||
ValidateInfo(_: any, info: CollectionChangeInfo)
|
|||||||||
|
Validates the listener information for the items modifed
Parameters :
Returns :
void
|
| ApplyTemplate |
ApplyTemplate()
|
|
Inherited from
Control
|
|
Defined in
Control:433
|
|
Returns :
any
|
| Public Focus |
Focus()
|
|
Inherited from
Control
|
|
Defined in
Control:403
|
|
Focus control
Returns :
void
|
| Public GetTemplateChild | ||||||
GetTemplateChild(name: string)
|
||||||
|
Inherited from
Control
|
||||||
|
Defined in
Control:386
|
||||||
|
Gets a control model defined inside the control template model (if assigned)
Parameters :
Returns :
DependencyObject
{DependencyObject} |
| Protected loadModels |
loadModels()
|
|
Inherited from
Control
|
|
Defined in
Control:526
|
|
Loads the model for the child elements defined in component.
Returns :
void
|
| OnGotFocus | ||||||
OnGotFocus(args: RoutedEventArgs)
|
||||||
|
Inherited from
Control
|
||||||
|
Defined in
Control:450
|
||||||
|
OnGotFocus handler
Parameters :
Returns :
void
|
| OnKeyDown | ||||||
OnKeyDown(args: KeyEventArgs)
|
||||||
|
Inherited from
Control
|
||||||
|
Defined in
Control:442
|
||||||
|
Parameters :
Returns :
void
|
| OnKeyUp | |||||||||
OnKeyUp(sender: any, args?: KeyEventArgs)
|
|||||||||
|
Inherited from
Control
|
|||||||||
|
Defined in
Control:443
|
|||||||||
|
Parameters :
Returns :
void
|
| OnLostFocus | ||||||
OnLostFocus(args: RoutedEventArgs)
|
||||||
|
Inherited from
Control
|
||||||
|
Defined in
Control:459
|
||||||
|
OnLostFocus handler
Parameters :
Returns :
void
|
| OnMouseEnter | |||||||||
OnMouseEnter(a0?, args?: any)
|
|||||||||
|
Inherited from
Control
|
|||||||||
|
Defined in
Control:437
|
|||||||||
|
Parameters :
Returns :
any
|
| OnMouseLeave | ||||
OnMouseLeave(a0?)
|
||||
|
Inherited from
Control
|
||||
|
Defined in
Control:438
|
||||
|
Parameters :
Returns :
any
|
| OnMouseLeftButtonDown | ||||
OnMouseLeftButtonDown(a0?)
|
||||
|
Inherited from
Control
|
||||
|
Defined in
Control:439
|
||||
|
Parameters :
Returns :
any
|
| OnMouseLeftButtonUp | ||||
OnMouseLeftButtonUp(a0?)
|
||||
|
Inherited from
Control
|
||||
|
Defined in
Control:441
|
||||
|
Parameters :
Returns :
any
|
| OnMouseMove | ||||
OnMouseMove(a0?)
|
||||
|
Inherited from
Control
|
||||
|
Defined in
Control:440
|
||||
|
Parameters :
Returns :
any
|
| Public OnTemplateChanged | |||||||||
OnTemplateChanged(sender: any, args: DependencyPropertyChangedEventArgs)
|
|||||||||
|
Inherited from
Control
|
|||||||||
|
Defined in
Control:481
|
|||||||||
|
Operation to apply when changing control template
Parameters :
Returns :
void
|
| OnTextChanged |
OnTextChanged(sender: any, args?: any)
|
|
Inherited from
Control
|
|
Defined in
Control:471
|
|
OnTextChanged handler
Returns :
void
|
| Static TemplateCallback | |||||||||
TemplateCallback(sender: DependencyObject, args: DependencyPropertyChangedEventArgs)
|
|||||||||
|
Inherited from
Control
|
|||||||||
|
Defined in
Control:510
|
|||||||||
|
Callback for the template changed property
Parameters :
Returns :
void
|
| Protected tryApplyStyleFromParentOrDefault |
tryApplyStyleFromParentOrDefault()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:535
|
|
Tries to apply style from parent or from default
Returns :
void
|
| Protected tryGetDefaultThemeStyle |
tryGetDefaultThemeStyle()
|
|
Inherited from
Control
|
|
Defined in
Control:553
|
|
Tries to resolve style from default theme
Returns :
any
|
| Public AfterContentChecked |
AfterContentChecked()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:496
|
|
Angular Lifecycle Hooks
Returns :
void
|
| Public AfterContentInit |
AfterContentInit()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:469
|
|
Angular Lifecycle Hook
Returns :
void
|
| Public AfterViewChecked |
AfterViewChecked()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:505
|
|
Angular Lifecycle Hooks
Returns :
void
|
| Public AfterViewInit |
AfterViewInit()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:526
|
|
Angular Lifecycle Hook. According to SL Documentation LayoutUpdated is the last object lifetime event to occur in the sequence before a control is ready for interaction. A setTimeout is set to ensure that it is triggered after everything is resolved.
Returns :
void
|
| Public CleanupBindingSubscriptions |
CleanupBindingSubscriptions()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:971
|
|
Clean up any subscription created for user bindings
Returns :
void
|
| Static DataContextCallback | |||||||||
DataContextCallback(sender: DependencyObject, args: DependencyPropertyChangedEventArgs)
|
|||||||||
|
Inherited from
FrameworkElement
|
|||||||||
|
Defined in
FrameworkElement:420
|
|||||||||
|
DataContext Callback Executed when the Width changes
Parameters :
Returns :
void
|
| Public DoCheck |
DoCheck()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:487
|
|
Angular Lifecycle Hooks
Returns :
void
|
| Public FindName | ||||||
FindName(name: string)
|
||||||
|
Inherited from
FrameworkElement
|
||||||
|
Defined in
FrameworkElement:930
|
||||||
|
Find an object by its
Parameters :
Returns :
unknown
{unknown} |
| Public fireLoaded |
fireLoaded()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:1073
|
|
Fire
Returns :
void
|
| Public getApplicationResource | ||||||||||||
getApplicationResource(key: string, ...properties: string[])
|
||||||||||||
|
Inherited from
FrameworkElement
|
||||||||||||
|
Defined in
FrameworkElement:1027
|
||||||||||||
|
Retrieves a resource with the given key or with the given property path Paths are just a collection of properties to be identified. Also static fields could be accessed using object instances. @example let obj = tmp.getApplicationResource('reskey', 'P1', 'P2')
Parameters :
Example :
Returns :
any
{any} the resulting data element |
| GetBindingExpression | ||||||
GetBindingExpression(dependencyProperty: DependencyProperty)
|
||||||
|
Inherited from
FrameworkElement
|
||||||
|
Defined in
FrameworkElement:919
|
||||||
|
Parameters :
Returns :
any
|
| Public getResourceByKey | ||||||
getResourceByKey(key: string)
|
||||||
|
Inherited from
FrameworkElement
|
||||||
|
Defined in
FrameworkElement:1058
|
||||||
|
Gets the specific resource by the given key
Parameters :
Returns :
unknown
{unknown} |
| Static HeightChangeCallback | |||||||||
HeightChangeCallback(sender: DependencyObject, args: DependencyPropertyChangedEventArgs)
|
|||||||||
|
Inherited from
FrameworkElement
|
|||||||||
|
Defined in
FrameworkElement:377
|
|||||||||
|
HeightChange Callback Executed when the Height changes
Parameters :
Returns :
void
|
| Protected initProperties |
initProperties()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:1113
|
|
Initialize the child elements properties of the component in code behind.
Returns :
void
|
| Private innerGetChild | ||||||
innerGetChild(idx: number)
|
||||||
|
Inherited from
FrameworkElement
|
||||||
|
Defined in
FrameworkElement:1153
|
||||||
|
Gets the child number
Parameters :
Returns :
DependencyObject
{DependencyObject} |
| Private innerGetChildrenCount |
innerGetChildrenCount()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:1165
|
|
Gets the number of children on this
Returns :
number
{number} |
| Private innerGetChildrenParent | ||||||
innerGetChildrenParent(prop: string)
|
||||||
|
Inherited from
FrameworkElement
|
||||||
|
Defined in
FrameworkElement:1178
|
||||||
|
Gets the parent from which children should be taken from.
Parameters :
Returns :
FrameworkElement
{FrameworkElement} |
| Static IsEnabledCallback | |||||||||
IsEnabledCallback(sender: DependencyObject, args: DependencyPropertyChangedEventArgs)
|
|||||||||
|
Inherited from
FrameworkElement
|
|||||||||
|
Defined in
FrameworkElement:438
|
|||||||||
|
IsEnabled dependency property callback
Parameters :
Returns :
void
|
| MeasureOverride | ||||||
MeasureOverride(availableSize: Size)
|
||||||
|
Inherited from
FrameworkElement
|
||||||
|
Defined in
FrameworkElement:582
|
||||||
|
Measure override method NOTE: We are not supporting this functionality in angular, this implementation is meant only to avoid runtime exceptions, but any code that relies on MeasureOverride should be review and analyze for manual changes
Parameters :
Returns :
Size
{Size} |
| Public OnApplyTemplate |
OnApplyTemplate()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:963
|
|
This method is involved in a
Returns :
void
|
| Public OnChanges |
OnChanges()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:478
|
|
Angular Lifecycle Hooks
Returns :
void
|
| Protected OnDataContextCallback | ||||||
OnDataContextCallback(args: DependencyPropertyChangedEventArgs)
|
||||||
|
Inherited from
FrameworkElement
|
||||||
|
Defined in
FrameworkElement:1103
|
||||||
|
Callback action for DataContext property changes
Parameters :
Returns :
void
|
| Public OnInit |
OnInit()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:460
|
|
Angular Lifecycle Hook
Returns :
void
|
| Public OnIsEnabledChanged | ||||||
OnIsEnabledChanged(args: DependencyPropertyChangedEventArgs)
|
||||||
|
Inherited from
FrameworkElement
|
||||||
|
Defined in
FrameworkElement:453
|
||||||
|
On IsEnabled changed handler
Parameters :
Returns :
void
|
| OpenCtxMenu | ||||||
OpenCtxMenu(menu: ContextMenuManager)
|
||||||
|
Inherited from
FrameworkElement
|
||||||
|
Defined in
FrameworkElement:555
|
||||||
|
Opens an instance of the XamContextMenu This is declared here because it can be set as an attached property and the component should know when it has a XamContextMenu setted to be displayed.
Parameters :
Returns :
void
|
| Public RaiseSizeChangedEvent |
RaiseSizeChangedEvent()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:1086
|
|
Raise the
Returns :
void
|
| Public RecreateInvalidBindings |
RecreateInvalidBindings()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:992
|
|
Calling CleanupBindingSubscriptions will set bindingExpression into an invalid state, the expressions and bindings still might persist (if the model is not destroyed), yet the subscriptions were cleaned, if this model is re-bind to a new angular component previous bindings and bindingExpressions will required to be recreated to work properly. This happens when the angular component is destroyed but the model still persists, like when an *ngIf is used to hide an item in the DOM, yet the model instance still persist until it gets visible again, the binding and bindingExpression will be the same but their subscriptions are gone.
Returns :
void
|
| Public refreshBindings |
refreshBindings()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:955
|
|
Refresh element binding values
Returns :
void
|
| Private scheduleFiringSizeChanged |
scheduleFiringSizeChanged()
|
|
Inherited from
FrameworkElement
|
|
Defined in
FrameworkElement:1191
|
|
Schedules executing the SizeChanged event
Returns :
void
|
| Private setDataContextFromAnchestor | ||||||
setDataContextFromAnchestor(parent: any)
|
||||||
|
Inherited from
FrameworkElement
|
||||||
|
Defined in
FrameworkElement:1138
|
||||||
|
Sets the datacontext from anchestor when was not directly set to property
Parameters :
Returns :
void
|
| SetTooltipToModel | ||||||
SetTooltipToModel(tooltip: ToolTipModel)
|
||||||
|
Inherited from
FrameworkElement
|
||||||
|
Defined in
FrameworkElement:567
|
||||||
|
Set tooltip component
Parameters :
Returns :
void
|
| Static StyleCallback | |||||||||
StyleCallback(sender: DependencyObject, args: DependencyPropertyChangedEventArgs)
|
|||||||||
|
Inherited from
FrameworkElement
|
|||||||||
|
Defined in
FrameworkElement:332
|
|||||||||
|
StyleCallback
Parameters :
Returns :
void
|
| UpdateLayout |
UpdateLayout()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:541
|
|
Updates the layout
Returns :
void
|
| Static WidthChangeCallback | |||||||||
WidthChangeCallback(sender: DependencyObject, args: DependencyPropertyChangedEventArgs)
|
|||||||||
|
Inherited from
FrameworkElement
|
|||||||||
|
Defined in
FrameworkElement:397
|
|||||||||
|
WidthChange Callback Executed when the Width changes
Parameters :
Returns :
void
|
| Public Arrange | ||||||
Arrange(obj: any)
|
||||||
|
Inherited from
UIElement
|
||||||
|
Defined in
UIElement:393
|
||||||
|
Arrange method
Parameters :
Returns :
void
|
| Public captureMouse |
captureMouse()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:368
|
|
Captures the mouse events
Returns :
boolean
|
| Public Measure | ||||||
Measure(obj: any)
|
||||||
|
Inherited from
UIElement
|
||||||
|
Defined in
UIElement:404
|
||||||
|
Measure method
Parameters :
Returns :
any
|
| Public releaseMouseCapture |
releaseMouseCapture()
|
|
Inherited from
UIElement
|
|
Defined in
UIElement:379
|
|
Returns :
void
|
| Protected SyncModelWithComponent | ||||||||
SyncModelWithComponent(params: any)
|
||||||||
|
Inherited from
UIElement
|
||||||||
|
Defined in
UIElement:409
|
||||||||
|
Parameters :
Returns :
void
|
| Public TransformToVisual | ||||||
TransformToVisual(obj: UIElement)
|
||||||
|
Inherited from
UIElement
|
||||||
|
Defined in
UIElement:354
|
||||||
|
Transforms to visual
Parameters :
Returns :
any
|
| Public withName | ||||||
withName(name: string)
|
||||||
|
Inherited from
UIElement
|
||||||
|
Defined in
UIElement:341
|
||||||
|
Parameters :
Returns :
UIElement
|
| Private addRelatedSubscriptionIfRequired | ||||||||||||
addRelatedSubscriptionIfRequired(event: SubscriptionEvent<any>, theHandler: any, bindingExpression: BindingExpression)
|
||||||||||||
|
Inherited from
DependencyObject
|
||||||||||||
|
Defined in
DependencyObject:502
|
||||||||||||
|
Parameters :
Returns :
void
|
| Private addSubscriptionForTwoWayBindings | ||||||||||||
addSubscriptionForTwoWayBindings(dependencyProperty: DependencyProperty, binding: Binding, bindingExpression: BindingExpression)
|
||||||||||||
|
Inherited from
DependencyObject
|
||||||||||||
|
Defined in
DependencyObject:383
|
||||||||||||
|
Parameters :
Returns :
void
|
| addsValidationMessage | |||||||||
addsValidationMessage(propKey: Binding | string, message: string)
|
|||||||||
|
Inherited from
DependencyObject
|
|||||||||
|
Defined in
DependencyObject:135
|
|||||||||
|
Adds a new validation message associated to a binding or a property name
Parameters :
Returns :
void
|
| Private beginSubscribeToMultiPropertyPathChanges | |||||||||||||||
beginSubscribeToMultiPropertyPathChanges(context: any, binding: Binding, dependencyProperty: DependencyProperty, bindingExpression: BindingExpression)
|
|||||||||||||||
|
Inherited from
DependencyObject
|
|||||||||||||||
|
Defined in
DependencyObject:542
|
|||||||||||||||
|
Parameters :
Returns :
void
|
| Private checkForSubscriptoinToDataErrorInfo | |||||||||||||||
checkForSubscriptoinToDataErrorInfo(currentContext: any, binding: Binding, propertyToSubscribe: string, bindingExpression: BindingExpression)
|
|||||||||||||||
|
Inherited from
DependencyObject
|
|||||||||||||||
|
Defined in
DependencyObject:716
|
|||||||||||||||
|
Parameters :
Returns :
void
|
| Public clearValue | ||||||
clearValue(property: DependencyProperty)
|
||||||
|
Inherited from
DependencyObject
|
||||||
|
Defined in
DependencyObject:212
|
||||||
|
Clears the dependency property value
Parameters :
Returns :
void
|
| Equals | ||||||
Equals(obj: any)
|
||||||
|
Inherited from
DependencyObject
|
||||||
|
Defined in
DependencyObject:201
|
||||||
|
Compares this dependency object agains another object.
Parameters :
Returns :
boolean
{boolean} |
| GetHashCode |
GetHashCode()
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:187
|
|
Gets a hash code for this dependency object.
Returns :
number
{number} |
| Public getValue | ||||||
getValue(property: DependencyProperty)
|
||||||
|
Inherited from
DependencyObject
|
||||||
|
Defined in
DependencyObject:226
|
||||||
|
Gets the value of a dependency property
Parameters :
Returns :
any
|
| Private handleErrorsOnContext | |||||||||
handleErrorsOnContext(errorCtxt: INotifyDataErrorInfo, args: DataErrorsChangedEventArgs)
|
|||||||||
|
Inherited from
DependencyObject
|
|||||||||
|
Defined in
DependencyObject:777
|
|||||||||
|
Check and register possible errors in an error context
Parameters :
Returns :
void
|
| Public IsPropertySet | ||||||
IsPropertySet(propertyName: string)
|
||||||
|
Inherited from
DependencyObject
|
||||||
|
Defined in
DependencyObject:376
|
||||||
|
Indicates if the property has been already set.
Parameters :
Returns :
any
|
| Private performDataErrorValidationIfRequired |
performDataErrorValidationIfRequired(binding: Binding, theBindingContext: any)
|
|
Inherited from
DependencyObject
|
|
Defined in
DependencyObject:481
|
|
Performs validation on model if the model implementes IDataErrorINfo
Returns :
void
|
| Private performRemoveValidationIfInValidationError | ||||||
performRemoveValidationIfInValidationError(binding: Binding)
|
||||||
|
Inherited from
DependencyObject
|
||||||
|
Defined in
DependencyObject:461
|
||||||
|
Performs the remove validation if the InValidationError is true
Parameters :
Returns :
void
|
| Public performTargetObjectBindingUpdate | |||||||||
performTargetObjectBindingUpdate(dependencyProperty: DependencyProperty, binding: Binding)
|
|||||||||
|
Inherited from
DependencyObject
|
|||||||||
|
Defined in
DependencyObject:429
|
|||||||||
|
Updates the target object value associated to the binding.
Parameters :
Returns :
void
|
| Private preprocessValue | |||||||||
preprocessValue(property: DependencyProperty, value: any)
|
|||||||||
|
Inherited from
DependencyObject
|
|||||||||
|
Defined in
DependencyObject:889
|
|||||||||
|
Preprocess value to be set to dependency property
Parameters :
Returns :
any
|
| Private recreateSubscriptionsForMultiPropertyBindingPath | ||||||||||||||||||||||||
recreateSubscriptionsForMultiPropertyBindingPath(currentContext: any, outerContext: any, properties: string[], propertyIndex: number, dependencyProperty: DependencyProperty, bindingExpression: BindingExpression, subscriptionsForCurrentBindingPath: Array<>)
|
||||||||||||||||||||||||
|
Inherited from
DependencyObject
|
||||||||||||||||||||||||
|
Defined in
DependencyObject:682
|
||||||||||||||||||||||||
|
Parameters :
Returns :
void
|
| Private registerSetPropertyIfRequired | ||||||
registerSetPropertyIfRequired(name: string)
|
||||||
|
Inherited from
DependencyObject
|
||||||
|
Defined in
DependencyObject:903
|
||||||
|
Register set property if required
Parameters :
Returns :
void
|
| Private removeSubscriptionsForMultiPropertyBindingPath | |||||||||
removeSubscriptionsForMultiPropertyBindingPath(subscriptionsForCurrentBindingPath: [], propertyIndex: number)
|
|||||||||
|
Inherited from
DependencyObject
|
|||||||||
|
Defined in
DependencyObject:663
|
|||||||||
|
Parameters :
Returns :
void
|
| removeValidationMessage | ||||||
removeValidationMessage(propKey: Binding | string)
|
||||||
|
Inherited from
DependencyObject
|
||||||
|
Defined in
DependencyObject:158
|
||||||
|
Removes a validation message associated to a binding or a property name
Parameters :
Returns :
void
|
| SetBinding | ||||||||||||
SetBinding(dependencyProperty: DependencyProperty, binding: Binding)
|
||||||||||||
|
Inherited from
DependencyObject
|
||||||||||||
|
Defined in
DependencyObject:317
|
||||||||||||
|
Sets a binding to the specified property at runtime
Parameters :
Returns :
void
|
| Public setValue | |||||||||
setValue(property: DependencyProperty, value: any)
|
|||||||||
|
Inherited from
DependencyObject
|
|||||||||
|
Defined in
DependencyObject:249
|
|||||||||
|
Sets the value for a dependency property
Parameters :
Returns :
void
|
| Public setValueForScopedRegion | ||||||||||||
setValueForScopedRegion(property: DependencyProperty, value: any, scopedRegionManager: IRegionManager)
|
||||||||||||
|
Inherited from
DependencyObject
|
||||||||||||
|
Defined in
DependencyObject:282
|
||||||||||||
|
Sets the value for a dependency property. This is a workaround to support Scoped Region Managers. A research is required to find out the way to get the application region Manager when scoped region managers are used (when creating the DelayedRegionBehavior, the correct scoped region manager must be passed as an argument).
Parameters :
Returns :
void
|
| Protected shouldPreventDefaultSourceUpdate | |||||||||
shouldPreventDefaultSourceUpdate(dependencyProperty: DependencyProperty, binding: BindingExpression)
|
|||||||||
|
Inherited from
DependencyObject
|
|||||||||
|
Defined in
DependencyObject:870
|
|||||||||
|
Parameters :
Returns :
boolean
|
| Private subscribeToBindingPathChanges | |||||||||||||||
subscribeToBindingPathChanges(context: any, binding: Binding, dependencyProperty: DependencyProperty, bindingExpression: BindingExpression)
|
|||||||||||||||
|
Inherited from
DependencyObject
|
|||||||||||||||
|
Defined in
DependencyObject:512
|
|||||||||||||||
|
Parameters :
Returns :
void
|
| Private subscribeToErrorsChangedInModel | ||||||||||||
subscribeToErrorsChangedInModel(errorCtxt: INotifyDataErrorInfo, propertyToSubscribe: string, bindingExpression: BindingExpression)
|
||||||||||||
|
Inherited from
DependencyObject
|
||||||||||||
|
Defined in
DependencyObject:748
|
||||||||||||
|
Parameters :
Returns :
void
|
| Private subscribeToPropertyChanges | ||||||||||||||||||||||||
subscribeToPropertyChanges(currentContext: any, outerContext: any, properties: string[], propertyIndex: number, dependencyProperty: DependencyProperty, bindingExpression: BindingExpression, subscriptionsForCurrentBindingPath: Array<>)
|
||||||||||||||||||||||||
|
Inherited from
DependencyObject
|
||||||||||||||||||||||||
|
Defined in
DependencyObject:586
|
||||||||||||||||||||||||
|
Parameters :
Returns :
void
|
| Private updateSourceOfBinding | ||||||||||||
updateSourceOfBinding(binding: Binding, outerContext: any, dependencyProperty: DependencyProperty)
|
||||||||||||
|
Inherited from
DependencyObject
|
||||||||||||
|
Defined in
DependencyObject:811
|
||||||||||||
|
Updates the source of a binding
Parameters :
Returns :
void
|
| ItemContainerGenerator | ||||||
getItemContainerGenerator()
|
||||||
|
Gets or sets the item container generator
Returns :
any
|
||||||
setItemContainerGenerator(v: any)
|
||||||
|
Parameters :
Returns :
void
|
import { Control } from '../../basecomponentmodel/Control';
import { Dependency } from '../../basecomponentmodel/Dependency';
import { DependencyObject } from '../../basecomponentmodel/DependencyObject';
import { DependencyProperty } from '../../basecomponentmodel/DependencyProperty';
import { DependencyPropertyChangedEventArgs } from '../../basecomponentmodel/DependencyPropertyChangedEventArgs';
import { FrameworkElement } from '../../basecomponentmodel/FrameworkElement';
import { tryToConvertType } from '../../baseframework/ReflectionSupport';
import {
CollectionChangeAction,
CollectionChangeInfo,
IComparer,
IList,
INotifyCollectionChanged,
SimpleList,
} from '../../baseframework/collections';
import { ReflectionHelper } from '../../baseframework/ReflectionSupport';
import { asExplicitImplementation } from '../../decorators/AsExplicitImplementation';
import { ClassInfo } from '../../decorators/ClassInfo';
import { AngularComponentId } from '../../helpers/AngularComponentId';
import { SubscriptionEvent } from '../../utils/SubscriptionEvent';
/**
* Model class to represent Image component
*
* @export
* @class ItemsControlModel
* @extends {Control}
* @wType System.Windows.Controls.ItemsControl
* @wType Telerik.Windows.Controls.ItemsControl
*/
export class ItemsControlModel extends Control {
/**
* DisplayMemberPathProperty dependency property
*
* @static
* @type {DependencyProperty}
* @memberof ItemsControlModel
*/
static DisplayMemberPathProperty: DependencyProperty = new DependencyProperty(
'DisplayMemberPath',
null,
null
);
/**
* ItemsPanelProperty dependency property
*
* @static
* @type {DependencyProperty}
* @memberof ItemsControlModel
*/
static ItemsPanelProperty: DependencyProperty = new DependencyProperty(
'ItemsPanel',
null,
null
);
/**
* ItemsSourceProperty dependency property
*
* @static
* @type {DependencyProperty}
* @memberof ItemsControlModel
*/
static ItemsSourceProperty: DependencyProperty = new DependencyProperty(
'ItemsSource',
null,
ItemsControlModel.ItemsSourceCallback
);
/**
* ItemTemplateProperty dependency property
*
* @static
* @type {DependencyProperty}
* @memberof ItemsControlModel
*/
static ItemTemplateProperty: DependencyProperty = new DependencyProperty(
'ItemTemplate',
null,
null
);
/**
* Force sync items collection
*
* @memberof ItemsControlModel
*/
public forceSyncItemsWithItemsSource() {
if (this.ItemsSource) {
this.setItemsProperty(this.ItemsSource);
}
}
private itemContainerGenerator: any = null;
/**
* Call this method to fill the items property
*
* @private
* @param {*} collection
* @memberof ItemsControlModel
*/
private setItemsProperty(collection: any) {
this.items.clear();
if (collection) {
this.items.setWithCollection(collection);
}
}
/**
* Call this method to fill the items property
*
* @private
* @param {*} collection
* @memberof ItemsControlModel
*/
private setItemsPropertyEvent(
collection: any,
info: CollectionChangeInfo = null
): void {
if (info) {
this.propagateCollectionChanges(collection, info);
} else {
this.rebuildCollection(collection);
}
}
public items: ItemsCollectionModel;
/**
* Items source
*
* @type {Iterable<any>}
* @memberof ItemsControlModel
*/
@Dependency(ItemsControlModel.ItemsSourceProperty)
public ItemsSource: Iterable<any>;
/**
* The items panel
*
* @type {*}
* @memberof ItemsControlModel
*/
@Dependency(ItemsControlModel.ItemsPanelProperty)
public ItemsPanel: any;
/**
* The display member path
*
* @type {string}
* @memberof ItemsControlModel
*/
@Dependency(ItemsControlModel.DisplayMemberPathProperty)
public DisplayMemberPath: string;
/**
* The item template
*
* @type {*}
* @memberof ItemsControlModel
*/
@Dependency(ItemsControlModel.ItemTemplateProperty)
public ItemTemplate: any;
/**
* Identifies the angular component associated with the model
*
* @type {string}
* @memberof ItemsControlModel
*/
public AngularComponentId = AngularComponentId.itemsControl;
/**
* Rebuild collection without triggering
* reset event and restore the items
*
* @private
* @param {*} collection
* @memberof ItemsControlModel
*/
private rebuildCollection(collection: any, info: any = null) {
this.items.clearWithoutReset();
/* istanbul ignore else */
if (collection) {
this.items.setWithCollection(collection);
}
/* istanbul ignore else */
if (info) {
this.items.fire(info);
}
}
/**
* Gets or sets the item container generator
*
* @type {*}
* @memberof ItemsControlModel
*/
public get ItemContainerGenerator(): any {
return this.itemContainerGenerator;
}
public set ItemContainerGenerator(v: any) {
this.itemContainerGenerator = v;
}
/**
* Return the amount of children the parent has
*
* @return {*} {number}
* @memberof ItemsControlModel
* @wIgnore
*/
GetChildrenCount(): number {
return this.items.count;
}
/**
* Gets the child element at the index position
*
* @param {number} idx
* @return {*} {DependencyObject}
* @memberof ItemsControlModel
* @wIgnore
*/
GetChild(idx: number): DependencyObject {
return this.items.getItem(idx);
}
constructor() {
super();
this.items = new ItemsCollectionModel();
this.SetUpHierarchyListeners(this.items);
}
/**
* Subscription for the CollectionChanged event of the items source (if exists)
*
* @memberof ItemsControlModel
*/
private collectionChangedSubscription: (e: any, args: any) => void;
/**
* Reference to callbar called whenever the ItemsSource have changed.
*
* @private
* @type {INotifyCollectionChanged}
* @memberof ItemsControlModel
*/
private valueConvertRef: INotifyCollectionChanged;
/**
* Reference to subscription when the model is initilized.
*
* @private
* @type {INotifyCollectionChanged}
* @memberof ItemsControlModel
*/
private itemsCollectionListenerRef: INotifyCollectionChanged;
/**
* Called when the component is being destroyed, clear some handlers attach to this model.
*
* @type {void}
* @memberof ItemsControlModel
*/
OnDestroy(): void {
super.OnDestroy();
this.valueConvertRef?.CollectionChanged.removeHandler(
this.collectionChangedSubscription,
this
);
this.itemsCollectionListenerRef?.CollectionChanged.removeHandler(
this.ValidateInfo,
this
);
this.collectionChangedSubscription = null;
}
/**
* On ItemsSource changed handler
*
* @param {DependencyPropertyChangedEventArgs} args
* @memberof ItemsControlModel
* @wIgnore
*/
public OnItemsSourceChanged(args: DependencyPropertyChangedEventArgs) {
// deregister previous handler
if (args.OldValue && this.collectionChangedSubscription) {
this.valueConvertRef = tryToConvertType<INotifyCollectionChanged>(
args.OldValue,
ReflectionHelper.getInterfaceRuntimeTypeInfo(
'System.Collections.Specialized.INotifyCollectionChanged'
)
);
this.valueConvertRef?.CollectionChanged.removeHandler(
this.collectionChangedSubscription,
this
);
this.collectionChangedSubscription = null;
}
// adds new handler
try {
this.valueConvertRef = tryToConvertType<INotifyCollectionChanged>(
args.NewValue,
ReflectionHelper.getInterfaceRuntimeTypeInfo(
'System.Collections.Specialized.INotifyCollectionChanged'
)
);
if (this.valueConvertRef) {
this.collectionChangedSubscription =
this.valueConvertRef.CollectionChanged.addHandler(
this.setItemsPropertyEvent,
this
);
}
this.setItemsProperty(args.NewValue);
} catch (error) {
this.setItemsProperty(args.NewValue);
}
}
/**
* ItemsSource dependency property callback
*
* @static
* @param {DependencyObject} sender
* @param {DependencyPropertyChangedEventArgs} args
* @memberof ItemsControlModel
* @wIgnore
*/
public static ItemsSourceCallback(
sender: DependencyObject,
args: DependencyPropertyChangedEventArgs
) {
if (sender instanceof ItemsControlModel) {
sender.OnItemsSourceChanged(args);
}
}
/**
* Sets the listeners for the items property
*
* @param {Iterable<any>} value
* @memberof ItemsControlModel
*/
private SetUpHierarchyListeners(value: Iterable<any>) {
this.itemsCollectionListenerRef =
tryToConvertType<INotifyCollectionChanged>(
value,
ReflectionHelper.getInterfaceRuntimeTypeInfo(
'System.Collections.Specialized.INotifyCollectionChanged'
)
);
this.itemsCollectionListenerRef?.CollectionChanged.addHandler(
this.ValidateInfo,
this
);
}
/**
* Validates the listener information for the items modifed
*
* @param {CollectionChangeInfo} info
* @memberof ItemsControlModel
*/
private ValidateInfo(_: any, info: CollectionChangeInfo) {
if (info.action == CollectionChangeAction.Add) {
for (const item of info.NewItems) {
if (item instanceof FrameworkElement) {
item.Parent = this;
}
}
} else if (
(info.action == CollectionChangeAction.Reset && info.OldItems) ||
info.action == CollectionChangeAction.Remove
) {
for (const item of info.OldItems) {
if (item instanceof FrameworkElement) {
item.Parent = null;
}
}
}
}
/**
* Applies the changes in bound collection to this { ItemsConttrolModel } internal
* collection
*
* @private
* @param {CollectionChangeInfo} info the { @link CollectionChangeInfo } object containing the
* changes in bound collection
* @memberof ItemsControlModel
*/
private propagateCollectionChanges(
collection: any,
info: CollectionChangeInfo
) {
switch (info.action) {
case CollectionChangeAction.Add:
case CollectionChangeAction.Replace:
let i = info.NewStartingIndex;
for (const e of info.NewItems) {
if (info.action === CollectionChangeAction.Add) {
this.items.insert(i++, e);
} else {
this.items.setItem(i++, e);
this.items.fire(info);
}
}
break;
case CollectionChangeAction.Remove:
for (let index = 0; index < info.OldItems.count; index++) {
this.items.removeAt(info.OldStartingIndex);
}
break;
case CollectionChangeAction.Reset:
this.rebuildCollection(collection, info);
break;
}
}
}
export abstract class PresentationFrameworkCollectionModel<T>
extends DependencyObject
implements IList<T>
{
private innerCollection = new SimpleList<T>();
getItem(index: number): T {
return this.innerCollection.getItem(index);
}
setItem(index: number, value: T) {
this.innerCollection.setItem(index, value);
this.change.fire(['Count']);
}
indexOf(value: T): number {
return this.innerCollection.indexOf(value);
}
insert(index: number, value: T) {
this.innerCollection.insert(index, value);
this.change.fire(['Count']);
}
removeAt(index: number) {
this.innerCollection.removeAt(index);
this.change.fire(['Count']);
}
get count(): number {
return this.innerCollection.count;
}
sort();
sort(comparer: IComparer<T>);
sort(comparer?) {
this.innerCollection.sort(comparer);
}
add(value: T): void {
this.internalAdd(value);
this.change.fire(['Count']);
}
/**
* Add used for internal processing of added elements to collection without trigger change
*
* @param {T} value
* @memberof PresentationFrameworkCollectionModel
*/
internalAdd(value: T): void {
if (
value &&
value instanceof Object &&
value.hasOwnProperty &&
value.hasOwnProperty('Parent')
) {
// eslint-disable-next-line @typescript-eslint/dot-notation
value['Parent'] = this;
}
this.innerCollection.add(value);
}
clear(): void {
const count = this.innerCollection.count;
this.innerCollection.clear();
if (count !== this.innerCollection.count) {
this.change.fire(['Count']);
}
}
contains(value: T): boolean {
return this.innerCollection.contains(value);
}
remove(value: T): boolean {
const result = this.innerCollection.remove(value);
this.change.fire(['Count']);
return result;
}
copyTo(target: T[], index: number): void {
this.innerCollection.copyTo(target, index);
}
[Symbol.iterator](): Iterator<T, any, undefined> {
return this.innerCollection[Symbol.iterator]();
}
get internalArray(): T[] {
return this.innerCollection.internalArray;
}
}
@ClassInfo({
classId: 'ItemsCollectionModel',
implements: ['System.Collections.Specialized.INotifyCollectionChanged'],
})
/**
* Items Collection Model
*
* @export
* @class ItemsCollectionModel
* @extends {PresentationFrameworkCollectionModel<any>}
*/
export class ItemsCollectionModel extends PresentationFrameworkCollectionModel<any> {
/**
* Function that allows to do sync of the items collection in the model
*
* @memberof ItemsCollectionModel
*/
syncItems: Function;
/**
* Collection changed subsccription event
*
* @memberof ItemsCollectionModel
*/
#CollectionChanged: SubscriptionEvent<
(e: any, args: CollectionChangeInfo) => void
> = new SubscriptionEvent();
/**
* Internal access for explicit implemented property
*
* @readonly
* @memberof ItemsCollectionModel
*/
get CollectionChanged_INotifyCollectionChanged(): SubscriptionEvent<
(e: any, args: CollectionChangeInfo) => void
> {
return this.#CollectionChanged;
}
/**
* Insert item at postion
*
* @param {number} index
* @param {*} value
* @memberof ItemsCollectionModel
*/
insert(index: number, value: any) {
if (index <= this.internalArray.length && index >= 0) {
super.insert(index, value);
const info = new CollectionChangeInfo(CollectionChangeAction.Add);
const newItems = new SimpleList();
newItems.add(value);
info.NewItems = newItems;
info.NewStartingIndex = index;
this.#CollectionChanged.fire([this, info]);
this.syncItems?.();
} else {
throw new Error(
'Specified argument was out of the range of valid values.'
);
}
}
/**
* Removes item in the given index
*
* @param {number} index
* @memberof ItemsCollectionModel
*/
removeAt(index: number) {
if (index < this.internalArray.length && index >= 0) {
const itemToRemove = super.getItem(index);
super.removeAt(index);
const info = new CollectionChangeInfo(CollectionChangeAction.Remove);
const oldItems = new SimpleList();
oldItems.add(itemToRemove);
info.OldItems = oldItems;
info.OldStartingIndex = index;
this.#CollectionChanged.fire([this, info]);
this.syncItems?.();
} else {
throw new Error(
'Specified argument was out of the range of valid values.'
);
}
}
/**
* Adds item to the collection
*
* @param {*} value
* @memberof ItemsCollectionModel
*/
add(value: any): void {
super.add(value);
const info = new CollectionChangeInfo(CollectionChangeAction.Add);
const newItems = new SimpleList();
newItems.add(value);
info.NewItems = newItems;
info.NewStartingIndex = this.internalArray.length - 1;
this.#CollectionChanged.fire([this, info]);
this.syncItems?.();
}
/**
* Adds a new collections to the items collection.
* Clear the items collection before adding the new values.
*
* @param {*} collection
* @memberof ItemsCollectionModel
*/
setWithCollection(collection: any): void {
for (const item of collection) {
super.internalAdd(item);
}
this.change.fire(['Count']);
this.syncItems?.();
}
/**
* Clears the collection without firing the CollectionChange event.
*
* @memberof ItemsCollectionModel
*/
clearWithoutReset() {
super.clear();
this.syncItems?.();
}
/**
* Clears the collection
*
* @memberof ItemsCollectionModel
*/
clear(): void {
const currentValues = this.internalArray.map((e) => e);
super.clear();
const info = new CollectionChangeInfo(CollectionChangeAction.Reset);
info.OldItems = new SimpleList(currentValues);
this.#CollectionChanged.fire([this, info]);
this.syncItems?.();
}
/**
* Fire event to external handler
*
* @param {CollectionChangeInfo} info
* @memberof ItemsCollectionModel
*/
fire(info: CollectionChangeInfo): void {
this.#CollectionChanged.fire([this, info]);
}
/**
* Removes the first element from the collection which match with the value
*
* @param {*} value
* @returns {boolean}
* @memberof ItemsCollectionModel
*/
remove(value: any): boolean {
const removeItemIndex = super.indexOf(value);
if (removeItemIndex > -1) {
super.removeAt(removeItemIndex);
const info = new CollectionChangeInfo(CollectionChangeAction.Remove);
const oldItems = new SimpleList();
oldItems.add(value);
info.OldItems = oldItems;
info.OldStartingIndex = removeItemIndex;
this.#CollectionChanged.fire([this, info]);
this.syncItems?.();
return true;
}
return false;
}
@asExplicitImplementation(
'System.Collections.Specialized.INotifyCollectionChanged'
)
asINotifyCollectionChanged(): INotifyCollectionChanged {
return new ItemsCollectionModel_INotifyCollectionChangedWrapper(this);
}
}
class ItemsCollectionModel_INotifyCollectionChangedWrapper
implements INotifyCollectionChanged
{
/**
* Collection changed subsccription event
*
* @memberof ItemsCollectionModel
*/
get CollectionChanged(): SubscriptionEvent<
(e: any, args: CollectionChangeInfo) => void
> {
return this.instance.CollectionChanged_INotifyCollectionChanged;
}
/**
* Used to recognize if the class is an explicit implementation
*
* @memberof ItemsCollectionModel_INotifyCollectionChangedWrapper
*/
isExplicitInterfaceImplementationWrapper = true;
/**
*Creates an instance of ItemsCollectionModel_INotifyCollectionChangedWrapper.
*
* @param {ItemsCollectionModel} instance
* @memberof ItemsCollectionModel_INotifyCollectionChangedWrapper
*/
constructor(public instance: ItemsCollectionModel) {}
}