2 * Copyright(c) 2020 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 using System.Collections.Generic;
19 using System.ComponentModel;
20 using System.Runtime.InteropServices;
21 using Tizen.NUI.Binding;
22 using Tizen.NUI.Components;
24 namespace Tizen.NUI.BaseComponents
27 /// View is the base class for all views.
29 /// <since_tizen> 3 </since_tizen>
30 public partial class View : Container, IResourcesProvider
33 /// Flag to indicate if layout set explicitly via API call or View was automatically given a Layout.
35 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
36 [EditorBrowsable(EditorBrowsableState.Never)]
37 public bool layoutSet = false;
40 /// Flag to allow Layouting to be disabled for Views.
41 /// Once a View has a Layout set then any children added to Views from then on will receive
42 /// automatic Layouts.
44 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
45 [EditorBrowsable(EditorBrowsableState.Never)]
46 public static bool layoutingDisabled { get; set; } = true;
48 private LayoutItem _layout; // Exclusive layout assigned to this View.
50 // List of transitions paired with the condition that uses the transition.
51 private Dictionary<TransitionCondition, TransitionList> _layoutTransitions;
52 private int _widthPolicy = LayoutParamPolicies.WrapContent; // Layout width policy
53 private int _heightPolicy = LayoutParamPolicies.WrapContent; // Layout height policy
54 private int _oldWidthPolicy = LayoutParamPolicies.MatchParent; // // Store Layout width to compare against later
55 private int _oldHeightPolicy = LayoutParamPolicies.MatchParent; // Store Layout height to compare against later
56 private float _weight = 0.0f; // Weighting of child View in a Layout
57 private MeasureSpecification _measureSpecificationWidth; // Layout width and internal Mode
58 private MeasureSpecification _measureSpecificationHeight; // Layout height and internal Mode
59 private bool _backgroundImageSynchronosLoading = false;
60 private Dictionary<string, Transition> transDictionary = new Dictionary<string, Transition>();
61 private string[] transitionNames;
62 private bool controlStatePropagation = false;
63 private ViewStyle viewStyle;
64 private bool themeChangeSensitive = false;
65 private bool excludeLayouting = false;
67 internal Size2D sizeSetExplicitly = new Size2D(); // Store size set by API, will be used in place of NaturalSize if not set.
68 internal BackgroundExtraData backgroundExtraData;
72 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
73 [EditorBrowsable(EditorBrowsableState.Never)]
74 public ViewStyle ViewStyle
78 if (null == viewStyle)
80 ApplyStyle(GetViewStyle());
88 /// Creates a new instance of a view.
90 /// <since_tizen> 3 </since_tizen>
91 public View() : this(Interop.View.View_New(), true)
93 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
96 /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI).
97 [EditorBrowsable(EditorBrowsableState.Never)]
98 public View(ViewStyle viewStyle) : this(Interop.View.View_New(), true, viewStyle)
103 /// Create a new instance of a View with setting the status of shown or hidden.
105 /// <param name="shown">false : Not displayed (hidden), true : displayed (shown)</param>
106 /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI).
107 [EditorBrowsable(EditorBrowsableState.Never)]
108 public View(bool shown) : this(Interop.View.View_New(), true)
110 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
114 internal View(View uiControl, bool shown = true) : this(Interop.View.new_View__SWIG_1(View.getCPtr(uiControl)), true)
116 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
122 backgroundExtraData = uiControl.backgroundExtraData == null ? null : new BackgroundExtraData(uiControl.backgroundExtraData);
125 internal View(global::System.IntPtr cPtr, bool cMemoryOwn, ViewStyle viewStyle, bool shown = true) : this(cPtr, cMemoryOwn, shown)
127 if (!ThemeManager.ThemeApplied) return;
129 if (viewStyle == null) UpdateStyle(); // Use style in the current theme
130 else ApplyStyle(viewStyle.Clone()); // Use given style
133 internal View(global::System.IntPtr cPtr, bool cMemoryOwn, bool shown = true) : base(Interop.View.View_SWIGUpcast(cPtr), cMemoryOwn)
137 PositionUsesPivotPoint = false;
140 //ToDo: this has memory leak and this is not used currently. will be fixed soon by using Event subscribing pattern.
141 //_onWindowSendEventCallback = SendViewAddedEventToWindow;
142 //this.OnWindowSignal().Connect(_onWindowSendEventCallback);
150 internal View(ViewImpl implementation, bool shown = true) : this(Interop.View.new_View__SWIG_2(ViewImpl.getCPtr(implementation)), true)
152 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
161 /// The event that is triggered when the View's ControlState is changed.
163 [EditorBrowsable(EditorBrowsableState.Never)]
164 public event EventHandler<ControlStateChangedEventArgs> ControlStateChangedEvent;
166 internal event EventHandler<ControlStateChangedEventArgs> ControlStateChangeEventInternal;
168 private ControlState controlStates = ControlState.Normal;
170 /// Get/Set the control state.
172 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
173 [EditorBrowsable(EditorBrowsableState.Never)]
174 public ControlState ControlState
178 return controlStates;
182 if (controlStates == value)
187 var prevState = controlStates;
189 controlStates = value;
191 var changeInfo = new ControlStateChangedEventArgs(prevState, value);
193 ControlStateChangeEventInternal?.Invoke(this, changeInfo);
195 if (controlStatePropagation)
197 foreach (View child in Children)
199 child.ControlState = value;
203 OnControlStateChanged(changeInfo);
205 ControlStateChangedEvent?.Invoke(this, changeInfo);
209 /// This will be public opened in tizen_6.5 after ACR done. Before ACR, need to be hidden as inhouse API.
210 [EditorBrowsable(EditorBrowsableState.Never)]
211 public bool ExcludeLayouting
215 return excludeLayouting;
219 excludeLayouting = value;
220 if (Layout != null && Layout.SetPositionByLayout == value)
222 Layout.SetPositionByLayout = !value;
223 Layout.RequestLayout();
228 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
229 [EditorBrowsable(EditorBrowsableState.Never)]
230 public bool IsResourcesCreated
234 return Application.Current.IsResourcesCreated;
238 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
239 [EditorBrowsable(EditorBrowsableState.Never)]
240 public ResourceDictionary XamlResources
244 return Application.Current.XamlResources;
248 Application.Current.XamlResources = value;
253 /// The StyleName, type string.
254 /// The value indicates DALi style name defined in json theme file.
256 /// <since_tizen> 3 </since_tizen>
257 public string StyleName
261 return (string)GetValue(StyleNameProperty);
265 SetValue(StyleNameProperty, value);
266 NotifyPropertyChanged();
271 /// The KeyInputFocus, type bool.
273 [EditorBrowsable(EditorBrowsableState.Never)]
274 public bool KeyInputFocus
278 return (bool)GetValue(KeyInputFocusProperty);
282 SetValue(KeyInputFocusProperty, value);
283 NotifyPropertyChanged();
288 /// The mutually exclusive with "backgroundImage" and "background" type Vector4.
291 /// The property cascade chaining set is possible. For example, this (view.BackgroundColor.X = 0.1f;) is possible.
293 /// <since_tizen> 3 </since_tizen>
294 public Color BackgroundColor
298 Color temp = (Color)GetValue(BackgroundColorProperty);
299 return new Color(OnBackgroundColorChanged, temp.R, temp.G, temp.B, temp.A);
303 SetValue(BackgroundColorProperty, value);
304 if (selectorData != null)
306 selectorData.BackgroundImage.Reset(this);
307 selectorData.BackgroundColor.UpdateIfNeeds(this, value);
309 NotifyPropertyChanged();
314 /// The mutually exclusive with "backgroundColor" and "background" type Map.
316 /// <since_tizen> 3 </since_tizen>
317 public string BackgroundImage
321 return (string)GetValue(BackgroundImageProperty);
325 SetValue(BackgroundImageProperty, value);
326 if (selectorData != null)
328 selectorData.BackgroundColor.Reset(this);
329 selectorData.BackgroundImage.UpdateIfNeeds(this, value);
331 NotifyPropertyChanged();
336 /// Get or set the border of background image.
338 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
339 [EditorBrowsable(EditorBrowsableState.Never)]
340 public Rectangle BackgroundImageBorder
344 return (Rectangle)GetValue(BackgroundImageBorderProperty);
348 SetValue(BackgroundImageBorderProperty, value);
349 selectorData?.BackgroundImageBorder.UpdateIfNeeds(this, value);
350 NotifyPropertyChanged();
355 /// The background of view.
357 /// <since_tizen> 3 </since_tizen>
358 public Tizen.NUI.PropertyMap Background
362 return (PropertyMap)GetValue(BackgroundProperty);
366 SetValue(BackgroundProperty, value);
367 NotifyPropertyChanged();
372 /// Describes a shadow as an image for a View.
373 /// It is null by default.
376 /// Getter returns copied instance of current shadow.
379 /// The mutually exclusive with "BoxShadow".
381 [EditorBrowsable(EditorBrowsableState.Never)]
382 public ImageShadow ImageShadow
386 return (ImageShadow)GetValue(ImageShadowProperty);
390 SetValue(ImageShadowProperty, value);
391 if (selectorData != null)
393 selectorData.BoxShadow.Reset(this);
394 selectorData.ImageShadow.UpdateIfNeeds(this, value);
396 NotifyPropertyChanged();
401 /// Describes a box shaped shadow drawing for a View.
402 /// It is null by default.
405 /// Gettter returns copied instance of current shadow.
408 /// The mutually exclusive with "ImageShadow".
410 [EditorBrowsable(EditorBrowsableState.Never)]
411 public Shadow BoxShadow
415 return (Shadow)GetValue(BoxShadowProperty);
419 SetValue(BoxShadowProperty, value);
420 if (selectorData != null)
422 selectorData.ImageShadow.Reset(this);
423 selectorData.BoxShadow.UpdateIfNeeds(this, value);
425 NotifyPropertyChanged();
430 /// The radius for the rounded corners of the View.
431 /// This will rounds background and shadow edges.
432 /// Note that, an image background (or shadow) may not have rounded corners if it uses a Border property.
434 [EditorBrowsable(EditorBrowsableState.Never)]
435 public float CornerRadius
439 return (float)GetValue(CornerRadiusProperty);
443 SetValue(CornerRadiusProperty, value);
444 selectorData?.CornerRadius.UpdateIfNeeds(this, value);
445 NotifyPropertyChanged();
450 /// The current state of the view.
452 /// <since_tizen> 3 </since_tizen>
457 return (States)GetValue(StateProperty);
461 SetValue(StateProperty, value);
462 NotifyPropertyChanged();
467 /// The current sub state of the view.
469 /// <since_tizen> 3 </since_tizen>
470 public States SubState
474 return (States)GetValue(SubStateProperty);
478 SetValue(SubStateProperty, value);
479 NotifyPropertyChanged();
484 /// Displays a tooltip
486 /// <since_tizen> 3 </since_tizen>
487 public Tizen.NUI.PropertyMap Tooltip
491 return (PropertyMap)GetValue(TooltipProperty);
495 SetValue(TooltipProperty, value);
496 NotifyPropertyChanged();
501 /// Displays a tooltip as a text.
503 /// <since_tizen> 3 </since_tizen>
504 public string TooltipText
508 SetProperty(View.Property.TOOLTIP, new Tizen.NUI.PropertyValue(value));
509 NotifyPropertyChanged();
514 /// The Child property of FlexContainer.<br />
515 /// The proportion of the free space in the container, the flex item will receive.<br />
516 /// If all items in the container set this property, their sizes will be proportional to the specified flex factor.<br />
518 /// <since_tizen> 3 </since_tizen>
519 [Obsolete("Deprecated in API8, will be removed in API10.")]
524 return (float)GetValue(FlexProperty);
528 SetValue(FlexProperty, value);
529 NotifyPropertyChanged();
534 /// The Child property of FlexContainer.<br />
535 /// The alignment of the flex item along the cross axis, which, if set, overides the default alignment for all items in the container.<br />
537 /// <since_tizen> 3 </since_tizen>
538 [Obsolete("Deprecated in API8, will be removed in API10.")]
543 return (int)GetValue(AlignSelfProperty);
547 SetValue(AlignSelfProperty, value);
548 NotifyPropertyChanged();
553 /// The Child property of FlexContainer.<br />
554 /// The space around the flex item.<br />
557 /// The property cascade chaining set is possible. For example, this (view.FlexMargin.X = 0.1f;) is possible.
559 /// <since_tizen> 3 </since_tizen>
560 [Obsolete("Deprecated in API8, will be removed in API10.")]
561 public Vector4 FlexMargin
565 Vector4 temp = (Vector4)GetValue(FlexMarginProperty);
566 return new Vector4(OnFlexMarginChanged, temp.X, temp.Y, temp.Z, temp.W);
570 SetValue(FlexMarginProperty, value);
571 NotifyPropertyChanged();
576 /// The top-left cell this child occupies, if not set, the first available cell is used.
579 /// The property cascade chaining set is possible. For example, this (view.CellIndex.X = 0.1f;) is possible.
581 /// <since_tizen> 3 </since_tizen>
582 public Vector2 CellIndex
586 Vector2 temp = (Vector2)GetValue(CellIndexProperty);
587 return new Vector2(OnCellIndexChanged, temp.X, temp.Y);
591 SetValue(CellIndexProperty, value);
592 NotifyPropertyChanged();
597 /// The number of rows this child occupies, if not set, the default value is 1.
599 /// <since_tizen> 3 </since_tizen>
604 return (float)GetValue(RowSpanProperty);
608 SetValue(RowSpanProperty, value);
609 NotifyPropertyChanged();
614 /// The number of columns this child occupies, if not set, the default value is 1.
616 /// <since_tizen> 3 </since_tizen>
617 public float ColumnSpan
621 return (float)GetValue(ColumnSpanProperty);
625 SetValue(ColumnSpanProperty, value);
626 NotifyPropertyChanged();
631 /// The horizontal alignment of this child inside the cells, if not set, the default value is 'left'.
633 /// <since_tizen> 3 </since_tizen>
634 public Tizen.NUI.HorizontalAlignmentType CellHorizontalAlignment
638 return (HorizontalAlignmentType)GetValue(CellHorizontalAlignmentProperty);
642 SetValue(CellHorizontalAlignmentProperty, value);
643 NotifyPropertyChanged();
648 /// The vertical alignment of this child inside the cells, if not set, the default value is 'top'.
650 /// <since_tizen> 3 </since_tizen>
651 public Tizen.NUI.VerticalAlignmentType CellVerticalAlignment
655 return (VerticalAlignmentType)GetValue(CellVerticalAlignmentProperty);
659 SetValue(CellVerticalAlignmentProperty, value);
660 NotifyPropertyChanged();
665 /// The left focusable view.<br />
666 /// This will return null if not set.<br />
667 /// This will also return null if the specified left focusable view is not on a window.<br />
669 /// <since_tizen> 3 </since_tizen>
670 public View LeftFocusableView
672 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
675 return (View)GetValue(LeftFocusableViewProperty);
679 SetValue(LeftFocusableViewProperty, value);
680 NotifyPropertyChanged();
685 /// The right focusable view.<br />
686 /// This will return null if not set.<br />
687 /// This will also return null if the specified right focusable view is not on a window.<br />
689 /// <since_tizen> 3 </since_tizen>
690 public View RightFocusableView
692 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
695 return (View)GetValue(RightFocusableViewProperty);
699 SetValue(RightFocusableViewProperty, value);
700 NotifyPropertyChanged();
705 /// The up focusable view.<br />
706 /// This will return null if not set.<br />
707 /// This will also return null if the specified up focusable view is not on a window.<br />
709 /// <since_tizen> 3 </since_tizen>
710 public View UpFocusableView
712 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
715 return (View)GetValue(UpFocusableViewProperty);
719 SetValue(UpFocusableViewProperty, value);
720 NotifyPropertyChanged();
725 /// The down focusable view.<br />
726 /// This will return null if not set.<br />
727 /// This will also return null if the specified down focusable view is not on a window.<br />
729 /// <since_tizen> 3 </since_tizen>
730 public View DownFocusableView
732 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
735 return (View)GetValue(DownFocusableViewProperty);
739 SetValue(DownFocusableViewProperty, value);
740 NotifyPropertyChanged();
745 /// Whether the view should be focusable by keyboard navigation.
747 /// <since_tizen> 3 </since_tizen>
748 public bool Focusable
752 SetValue(FocusableProperty, value);
753 NotifyPropertyChanged();
757 return (bool)GetValue(FocusableProperty);
762 /// Retrieves the position of the view.<br />
763 /// The coordinates are relative to the view's parent.<br />
765 /// <since_tizen> 3 </since_tizen>
766 public Position CurrentPosition
770 return GetCurrentPosition();
775 /// Sets the size of a view for the width and the height.<br />
776 /// Geometry can be scaled to fit within this area.<br />
777 /// This does not interfere with the view's scale factor.<br />
778 /// The views default depth is the minimum of width and height.<br />
781 /// This NUI object (Size2D) typed property can be configured by multiple cascade setting. <br />
782 /// For example, this code ( view.Size2D.Width = 100; view.Size2D.Height = 100; ) is equivalent to this ( view.Size2D = new Size2D(100, 100); ). <br />
784 /// <since_tizen> 3 </since_tizen>
789 Size2D temp = (Size2D)GetValue(Size2DProperty);
791 if (this.Layout == null)
793 if (temp.Width < 0) { temp.Width = 0; }
794 if (temp.Height < 0) { temp.Height = 0; }
797 return new Size2D(OnSize2DChanged, temp.Width, temp.Height);
801 sizeSetExplicitly = value; // Store size set by API, will be used in place of NaturalSize if not set.
802 SetValue(Size2DProperty, value);
803 // Set Specification so when layouts measure this View it matches the value set here.
804 // All Views are currently Layouts.
805 MeasureSpecificationWidth = new MeasureSpecification(new LayoutLength(value.Width), MeasureSpecification.ModeType.Exactly);
806 MeasureSpecificationHeight = new MeasureSpecification(new LayoutLength(value.Height), MeasureSpecification.ModeType.Exactly);
807 _widthPolicy = value.Width;
808 _heightPolicy = value.Height;
810 _layout?.RequestLayout();
811 NotifyPropertyChanged();
816 /// Retrieves the size of the view.<br />
817 /// The coordinates are relative to the view's parent.<br />
819 /// <since_tizen> 3 </since_tizen>
820 public Size2D CurrentSize
824 return GetCurrentSize();
829 /// Retrieves and sets the view's opacity.<br />
831 /// <since_tizen> 3 </since_tizen>
836 return (float)GetValue(OpacityProperty);
840 SetValue(OpacityProperty, value);
841 selectorData?.Opacity.UpdateIfNeeds(this, value);
842 NotifyPropertyChanged();
847 /// Sets the position of the view for X and Y.<br />
848 /// By default, sets the position vector between the parent origin and the pivot point (default).<br />
849 /// If the position inheritance is disabled, sets the world position.<br />
852 /// This NUI object (Position2D) typed property can be configured by multiple cascade setting. <br />
853 /// For example, this code ( view.Position2D.X = 100; view.Position2D.Y = 100; ) is equivalent to this ( view.Position2D = new Position2D(100, 100); ). <br />
855 /// <since_tizen> 3 </since_tizen>
856 public Position2D Position2D
860 Position2D temp = (Position2D)GetValue(Position2DProperty);
861 return new Position2D(OnPosition2DChanged, temp.X, temp.Y);
865 SetValue(Position2DProperty, value);
866 NotifyPropertyChanged();
871 /// Retrieves the screen postion of the view.<br />
873 /// <since_tizen> 3 </since_tizen>
874 public Vector2 ScreenPosition
878 Vector2 temp = new Vector2(0.0f, 0.0f);
879 GetProperty(View.Property.SCREEN_POSITION).Get(temp);
885 /// Determines whether the pivot point should be used to determine the position of the view.
886 /// This is false by default.
888 /// <remarks>If false, then the top-left of the view is used for the position.
889 /// Setting this to false will allow scaling or rotation around the pivot point without affecting the view's position.
891 /// <since_tizen> 3 </since_tizen>
892 public bool PositionUsesPivotPoint
896 return (bool)GetValue(PositionUsesPivotPointProperty);
900 SetValue(PositionUsesPivotPointProperty, value);
901 NotifyPropertyChanged();
906 /// Deprecated in API5; Will be removed in API8. Please use PositionUsesPivotPoint instead!
908 /// <since_tizen> 3 </since_tizen>
909 [Obsolete("Deprecated in API5; Will be removed in API8. Please use PositionUsesPivotPoint instead! " +
911 "View view = new View(); " +
912 "view.PivotPoint = PivotPoint.Center; " +
913 "view.PositionUsesPivotPoint = true;" +
914 " Deprecated in API5: Will be removed in API8")]
915 [EditorBrowsable(EditorBrowsableState.Never)]
916 public bool PositionUsesAnchorPoint
921 GetProperty(View.Property.POSITION_USES_ANCHOR_POINT).Get(out temp);
926 SetProperty(View.Property.POSITION_USES_ANCHOR_POINT, new Tizen.NUI.PropertyValue(value));
927 NotifyPropertyChanged();
932 /// Queries whether the view is connected to the stage.<br />
933 /// When a view is connected, it will be directly or indirectly parented to the root view.<br />
935 /// <since_tizen> 3 </since_tizen>
936 public bool IsOnWindow
945 /// Gets the depth in the hierarchy for the view.
947 /// <since_tizen> 3 </since_tizen>
948 public int HierarchyDepth
952 return GetHierarchyDepth();
957 /// Sets the sibling order of the view so the depth position can be defined within the same parent.
960 /// Note the initial value is 0. SiblingOrder should be bigger than 0 or equal to 0.
961 /// Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove, and LowerBelow will override the sibling order.
962 /// The values set by this property will likely change.
964 /// <since_tizen> 3 </since_tizen>
965 public int SiblingOrder
969 return (int)GetValue(SiblingOrderProperty);
973 SetValue(SiblingOrderProperty, value);
975 LayoutGroup layout = Layout as LayoutGroup;
976 layout?.ChangeLayoutSiblingOrder(value);
978 NotifyPropertyChanged();
983 /// Returns the natural size of the view.
986 /// Deriving classes stipulate the natural size and by default a view has a zero natural size.
988 /// <since_tizen> 5 </since_tizen>
989 public Vector3 NaturalSize
993 Vector3 ret = new Vector3(Interop.Actor.Actor_GetNaturalSize(swigCPtr), true);
994 if (NDalicPINVOKE.SWIGPendingException.Pending)
995 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1001 /// Returns the natural size (Size2D) of the view.
1004 /// Deriving classes stipulate the natural size and by default a view has a zero natural size.
1006 /// <since_tizen> 4 </since_tizen>
1007 public Size2D NaturalSize2D
1011 Vector3 temp = new Vector3(Interop.Actor.Actor_GetNaturalSize(swigCPtr), true);
1012 if (NDalicPINVOKE.SWIGPendingException.Pending)
1013 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1015 return new Size2D((int)temp.Width, (int)temp.Height);
1020 /// Gets or sets the origin of a view within its parent's area.<br />
1021 /// This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent, and (1.0, 1.0, 0.5) is the bottom-right corner.<br />
1022 /// The default parent-origin is ParentOrigin.TopLeft (0.0, 0.0, 0.5).<br />
1023 /// A view's position is the distance between this origin and the view's anchor-point.<br />
1025 /// <pre>The view has been initialized.</pre>
1026 /// <since_tizen> 3 </since_tizen>
1027 public Position ParentOrigin
1031 Position tmp = (Position)GetValue(ParentOriginProperty);
1032 return new Position(OnParentOriginChanged, tmp.X, tmp.Y, tmp.Z);
1036 SetValue(ParentOriginProperty, value);
1037 NotifyPropertyChanged();
1042 /// Gets or sets the anchor-point of a view.<br />
1043 /// This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the view, and (1.0, 1.0, 0.5) is the bottom-right corner.<br />
1044 /// The default pivot point is PivotPoint.Center (0.5, 0.5, 0.5).<br />
1045 /// A view position is the distance between its parent-origin and this anchor-point.<br />
1046 /// A view's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.<br />
1047 /// <pre>The view has been initialized.</pre>
1050 /// The property cascade chaining set is possible. For example, this (view.PivotPoint.X = 0.1f;) is possible.
1052 /// <since_tizen> 3 </since_tizen>
1053 public Position PivotPoint
1057 Position tmp = (Position)GetValue(PivotPointProperty);
1058 return new Position(OnPivotPointChanged, tmp.X, tmp.Y, tmp.Z);
1062 SetValue(PivotPointProperty, value);
1063 NotifyPropertyChanged();
1068 /// Gets or sets the size width of the view.
1072 /// Animatable - This property can be animated using <c>Animation</c> class.
1075 /// <since_tizen> 3 </since_tizen>
1076 public float SizeWidth
1080 return (float)GetValue(SizeWidthProperty);
1084 SetValue(SizeWidthProperty, value);
1085 NotifyPropertyChanged();
1090 /// Gets or sets the size height of the view.
1094 /// Animatable - This property can be animated using <c>Animation</c> class.
1097 /// <since_tizen> 3 </since_tizen>
1098 public float SizeHeight
1102 return (float)GetValue(SizeHeightProperty);
1106 SetValue(SizeHeightProperty, value);
1107 NotifyPropertyChanged();
1112 /// Gets or sets the position of the view.<br />
1113 /// By default, sets the position vector between the parent origin and pivot point (default).<br />
1114 /// If the position inheritance is disabled, sets the world position.<br />
1118 /// Animatable - This property can be animated using <c>Animation</c> class.
1120 /// The property cascade chaining set is possible. For example, this (view.Position.X = 1.0f;) is possible.
1122 /// <since_tizen> 3 </since_tizen>
1123 public Position Position
1127 Position tmp = (Position)GetValue(PositionProperty);
1128 return new Position(OnPositionChanged, tmp.X, tmp.Y, tmp.Z);
1132 SetValue(PositionProperty, value);
1133 NotifyPropertyChanged();
1138 /// Gets or sets the position X of the view.
1142 /// Animatable - This property can be animated using <c>Animation</c> class.
1145 /// <since_tizen> 3 </since_tizen>
1146 public float PositionX
1150 return (float)GetValue(PositionXProperty);
1154 SetValue(PositionXProperty, value);
1155 NotifyPropertyChanged();
1160 /// Gets or sets the position Y of the view.
1164 /// Animatable - This property can be animated using <c>Animation</c> class.
1167 /// <since_tizen> 3 </since_tizen>
1168 public float PositionY
1172 return (float)GetValue(PositionYProperty);
1176 SetValue(PositionYProperty, value);
1177 NotifyPropertyChanged();
1182 /// Gets or sets the position Z of the view.
1186 /// Animatable - This property can be animated using <c>Animation</c> class.
1189 /// <since_tizen> 3 </since_tizen>
1190 public float PositionZ
1194 return (float)GetValue(PositionZProperty);
1198 SetValue(PositionZProperty, value);
1199 NotifyPropertyChanged();
1204 /// Gets or sets the world position of the view.
1206 /// <since_tizen> 3 </since_tizen>
1207 public Vector3 WorldPosition
1211 Vector3 temp = new Vector3(0.0f, 0.0f, 0.0f);
1212 GetProperty(View.Property.WORLD_POSITION).Get(temp);
1218 /// Gets or sets the orientation of the view.<br />
1219 /// The view's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.<br />
1223 /// This is an asynchronous method.
1226 /// Animatable - This property can be animated using <c>Animation</c> class.
1229 /// <since_tizen> 3 </since_tizen>
1230 public Rotation Orientation
1234 return (Rotation)GetValue(OrientationProperty);
1238 SetValue(OrientationProperty, value);
1239 NotifyPropertyChanged();
1244 /// Gets or sets the world orientation of the view.<br />
1246 /// <since_tizen> 3 </since_tizen>
1247 public Rotation WorldOrientation
1251 Rotation temp = new Rotation();
1252 GetProperty(View.Property.WORLD_ORIENTATION).Get(temp);
1258 /// Gets or sets the scale factor applied to the view.<br />
1262 /// Animatable - This property can be animated using <c>Animation</c> class.
1264 /// The property cascade chaining set is possible. For example, this (view.Scale.X = 0.1f;) is possible.
1266 /// <since_tizen> 3 </since_tizen>
1267 public Vector3 Scale
1271 Vector3 temp = (Vector3)GetValue(ScaleProperty);
1272 return new Vector3(OnScaleChanged, temp.X, temp.Y, temp.Z);
1276 SetValue(ScaleProperty, value);
1277 NotifyPropertyChanged();
1282 /// Gets or sets the scale X factor applied to the view.
1286 /// Animatable - This property can be animated using <c>Animation</c> class.
1289 /// <since_tizen> 3 </since_tizen>
1294 return (float)GetValue(ScaleXProperty);
1298 SetValue(ScaleXProperty, value);
1299 NotifyPropertyChanged();
1304 /// Gets or sets the scale Y factor applied to the view.
1308 /// Animatable - This property can be animated using <c>Animation</c> class.
1311 /// <since_tizen> 3 </since_tizen>
1316 return (float)GetValue(ScaleYProperty);
1320 SetValue(ScaleYProperty, value);
1321 NotifyPropertyChanged();
1326 /// Gets or sets the scale Z factor applied to the view.
1330 /// Animatable - This property can be animated using <c>Animation</c> class.
1333 /// <since_tizen> 3 </since_tizen>
1338 return (float)GetValue(ScaleZProperty);
1342 SetValue(ScaleZProperty, value);
1343 NotifyPropertyChanged();
1348 /// Gets the world scale of the view.
1350 /// <since_tizen> 3 </since_tizen>
1351 public Vector3 WorldScale
1355 Vector3 temp = new Vector3(0.0f, 0.0f, 0.0f);
1356 GetProperty(View.Property.WORLD_SCALE).Get(temp);
1362 /// Retrieves the visibility flag of the view.
1366 /// If the view is not visible, then the view and its children will not be rendered.
1367 /// This is regardless of the individual visibility values of the children, i.e., the view will only be rendered if all of its parents have visibility set to true.
1370 /// Animatable - This property can be animated using <c>Animation</c> class.
1373 /// <since_tizen> 3 </since_tizen>
1374 public bool Visibility
1379 GetProperty(View.Property.VISIBLE).Get(out temp);
1385 /// Gets the view's world color.
1387 /// <since_tizen> 3 </since_tizen>
1388 public Vector4 WorldColor
1392 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
1393 GetProperty(View.Property.WORLD_COLOR).Get(temp);
1399 /// Gets or sets the view's name.
1401 /// <since_tizen> 3 </since_tizen>
1406 return (string)GetValue(NameProperty);
1410 SetValue(NameProperty, value);
1411 NotifyPropertyChanged();
1416 /// Get the number of children held by the view.
1418 /// <since_tizen> 3 </since_tizen>
1419 public new uint ChildCount
1423 return GetChildCount();
1428 /// Gets the view's ID.
1431 /// <since_tizen> 3 </since_tizen>
1441 /// Gets or sets the status of whether the view should emit touch or hover signals.
1443 /// <since_tizen> 3 </since_tizen>
1444 public bool Sensitive
1448 return (bool)GetValue(SensitiveProperty);
1452 SetValue(SensitiveProperty, value);
1453 NotifyPropertyChanged();
1458 /// Gets or sets the status of whether the view should receive a notification when touch or hover motion events leave the boundary of the view.
1460 /// <since_tizen> 3 </since_tizen>
1461 public bool LeaveRequired
1465 return (bool)GetValue(LeaveRequiredProperty);
1469 SetValue(LeaveRequiredProperty, value);
1470 NotifyPropertyChanged();
1475 /// Gets or sets the status of whether a child view inherits it's parent's orientation.
1477 /// <since_tizen> 3 </since_tizen>
1478 public bool InheritOrientation
1482 return (bool)GetValue(InheritOrientationProperty);
1486 SetValue(InheritOrientationProperty, value);
1487 NotifyPropertyChanged();
1492 /// Gets or sets the status of whether a child view inherits it's parent's scale.
1494 /// <since_tizen> 3 </since_tizen>
1495 public bool InheritScale
1499 return (bool)GetValue(InheritScaleProperty);
1503 SetValue(InheritScaleProperty, value);
1504 NotifyPropertyChanged();
1509 /// Gets or sets the status of how the view and its children should be drawn.<br />
1510 /// Not all views are renderable, but DrawMode can be inherited from any view.<br />
1511 /// If an object is in a 3D layer, it will be depth-tested against other objects in the world, i.e., it may be obscured if other objects are in front.<br />
1512 /// If DrawMode.Overlay2D is used, the view and its children will be drawn as a 2D overlay.<br />
1513 /// Overlay views are drawn in a separate pass, after all non-overlay views within the layer.<br />
1514 /// For overlay views, the drawing order is with respect to tree levels of views, and depth-testing will not be used.<br />
1516 /// <since_tizen> 3 </since_tizen>
1517 public DrawModeType DrawMode
1521 return (DrawModeType)GetValue(DrawModeProperty);
1525 SetValue(DrawModeProperty, value);
1526 NotifyPropertyChanged();
1531 /// Gets or sets the relative to parent size factor of the view.<br />
1532 /// This factor is only used when ResizePolicyType is set to either: ResizePolicyType.SizeRelativeToParent or ResizePolicyType.SizeFixedOffsetFromParent.<br />
1533 /// This view's size is set to the view's size multiplied by or added to this factor, depending on ResizePolicyType.<br />
1536 /// The property cascade chaining set is possible. For example, this (view.DecorationBoundingBox.X = 0.1f;) is possible.
1538 /// <since_tizen> 3 </since_tizen>
1539 public Vector3 SizeModeFactor
1543 Vector3 temp = (Vector3)GetValue(SizeModeFactorProperty);
1544 return new Vector3(OnSizeModeFactorChanged, temp.X, temp.Y, temp.Z);
1548 SetValue(SizeModeFactorProperty, value);
1549 NotifyPropertyChanged();
1554 /// Gets or sets the width resize policy to be used.
1556 /// <since_tizen> 3 </since_tizen>
1557 public ResizePolicyType WidthResizePolicy
1561 return (ResizePolicyType)GetValue(WidthResizePolicyProperty);
1565 SetValue(WidthResizePolicyProperty, value);
1566 NotifyPropertyChanged();
1571 /// Gets or sets the height resize policy to be used.
1573 /// <since_tizen> 3 </since_tizen>
1574 public ResizePolicyType HeightResizePolicy
1578 return (ResizePolicyType)GetValue(HeightResizePolicyProperty);
1582 SetValue(HeightResizePolicyProperty, value);
1583 NotifyPropertyChanged();
1588 /// Gets or sets the policy to use when setting size with size negotiation.<br />
1589 /// Defaults to SizeScalePolicyType.UseSizeSet.<br />
1591 /// <since_tizen> 3 </since_tizen>
1592 public SizeScalePolicyType SizeScalePolicy
1596 return (SizeScalePolicyType)GetValue(SizeScalePolicyProperty);
1600 SetValue(SizeScalePolicyProperty, value);
1601 NotifyPropertyChanged();
1606 /// Gets or sets the status of whether the width size is dependent on the height size.
1608 /// <since_tizen> 3 </since_tizen>
1609 public bool WidthForHeight
1613 return (bool)GetValue(WidthForHeightProperty);
1617 SetValue(WidthForHeightProperty, value);
1618 NotifyPropertyChanged();
1623 /// Gets or sets the status of whether the height size is dependent on the width size.
1625 /// <since_tizen> 3 </since_tizen>
1626 public bool HeightForWidth
1630 return (bool)GetValue(HeightForWidthProperty);
1634 SetValue(HeightForWidthProperty, value);
1635 NotifyPropertyChanged();
1640 /// Gets or sets the padding for use in layout.
1643 /// The property cascade chaining set is possible. For example, this (view.Padding.X = 0.1f;) is possible.
1645 /// <since_tizen> 5 </since_tizen>
1646 public Extents Padding
1650 // If View has a Layout then padding in stored in the base Layout class
1653 return Layout.Padding;
1657 Extents temp = (Extents)GetValue(PaddingProperty);
1658 return new Extents(OnPaddingChanged, temp.Start, temp.End, temp.Top, temp.Bottom);
1660 // Two return points to prevent creating a zeroed Extent native object before assignment
1664 Extents padding = value;
1667 // Layout set so store Padding in LayoutItem instead of in View.
1668 // If View stores the Padding value then Legacy Size Negotiation will overwrite
1669 // the position and sizes measure in the Layouting.
1670 Layout.Padding = value;
1671 // If Layout is a LayoutItem then it could be a View that handles it's own padding.
1672 // Let the View keeps it's padding. Still store Padding in Layout to reduce code paths.
1673 if (typeof(LayoutGroup).IsAssignableFrom(Layout.GetType())) // If a Layout container of some kind.
1675 padding = new Extents(0, 0, 0, 0); // Reset value stored in View.
1679 SetValue(PaddingProperty, padding);
1680 NotifyPropertyChanged();
1685 /// Gets or sets the minimum size the view can be assigned in size negotiation.
1687 /// <exception cref="ArgumentNullException"> Thrown when value is null. </exception>
1689 /// The property cascade chaining set is possible. For example, this (view.MinimumSize.Width = 1;) is possible.
1691 /// <since_tizen> 3 </since_tizen>
1692 public Size2D MinimumSize
1696 Size2D tmp = (Size2D)GetValue(MinimumSizeProperty);
1697 return new Size2D(OnMinimumSizeChanged, tmp.Width, tmp.Height);
1703 throw new ArgumentNullException(nameof(value));
1705 if (_layout != null)
1707 // Note: it only works if minimum size is >= than natural size.
1708 // To force the size it should be done through the width&height spec or Size2D.
1709 _layout.MinimumWidth = new Tizen.NUI.LayoutLength(value.Width);
1710 _layout.MinimumHeight = new Tizen.NUI.LayoutLength(value.Height);
1711 _layout.RequestLayout();
1713 SetValue(MinimumSizeProperty, value);
1714 NotifyPropertyChanged();
1719 /// Gets or sets the maximum size the view can be assigned in size negotiation.
1722 /// The property cascade chaining set is possible. For example, this (view.MaximumSize.Width = 1;) is possible.
1724 /// <since_tizen> 3 </since_tizen>
1725 public Size2D MaximumSize
1729 Size2D tmp = (Size2D)GetValue(MaximumSizeProperty);
1730 return new Size2D(OnMaximumSizeChanged, tmp.Width, tmp.Height);
1734 // We don't have Layout.Maximum(Width|Height) so we cannot apply it to layout.
1735 // MATCH_PARENT spec + parent container size can be used to limit
1736 if (_layout != null)
1738 _layout.RequestLayout();
1740 SetValue(MaximumSizeProperty, value);
1741 NotifyPropertyChanged();
1746 /// Gets or sets whether a child view inherits it's parent's position.<br />
1747 /// Default is to inherit.<br />
1748 /// Switching this off means that using position sets the view's world position, i.e., translates from the world origin (0,0,0) to the pivot point of the view.<br />
1750 /// <since_tizen> 3 </since_tizen>
1751 public bool InheritPosition
1755 return (bool)GetValue(InheritPositionProperty);
1759 SetValue(InheritPositionProperty, value);
1760 NotifyPropertyChanged();
1765 /// Gets or sets the clipping behavior (mode) of it's children.
1767 /// <since_tizen> 3 </since_tizen>
1768 public ClippingModeType ClippingMode
1772 return (ClippingModeType)GetValue(ClippingModeProperty);
1776 SetValue(ClippingModeProperty, value);
1777 NotifyPropertyChanged();
1782 /// Gets the number of renderers held by the view.
1784 /// <since_tizen> 3 </since_tizen>
1785 public uint RendererCount
1789 return GetRendererCount();
1794 /// Deprecated in API5; Will be removed in API8. Please use PivotPoint instead!
1797 /// The property cascade chaining set is possible. For example, this (view.AnchorPoint.X = 0.1f;) is possible.
1799 /// <since_tizen> 3 </since_tizen>
1800 [Obsolete("Deprecated in API5; Will be removed in API8. Please use PivotPoint instead! " +
1802 "View view = new View(); " +
1803 "view.PivotPoint = PivotPoint.Center; " +
1804 "view.PositionUsesPivotPoint = true;")]
1805 [EditorBrowsable(EditorBrowsableState.Never)]
1806 public Position AnchorPoint
1810 Position temp = new Position(0.0f, 0.0f, 0.0f);
1811 GetProperty(View.Property.ANCHOR_POINT).Get(temp);
1812 return new Position(OnAnchorPointChanged, temp.X, temp.Y, temp.Z);
1816 SetProperty(View.Property.ANCHOR_POINT, new Tizen.NUI.PropertyValue(value));
1817 NotifyPropertyChanged();
1822 /// Sets the size of a view for the width, the height and the depth.<br />
1823 /// Geometry can be scaled to fit within this area.<br />
1824 /// This does not interfere with the view's scale factor.<br />
1825 /// The views default depth is the minimum of width and height.<br />
1829 /// Animatable - This property can be animated using <c>Animation</c> class.
1831 /// The property cascade chaining set is possible. For example, this (view.Size.Width = 1.0f;) is possible.
1833 /// <since_tizen> 5 </since_tizen>
1838 Size tmp = (Size)GetValue(SizeProperty);
1839 return new Size(OnSizeChanged, tmp.Width, tmp.Height, tmp.Depth);
1843 SetValue(SizeProperty, value);
1844 NotifyPropertyChanged();
1849 /// Deprecated in API5; Will be removed in API8. Please use 'Container GetParent() for derived class' instead!
1851 /// <since_tizen> 3 </since_tizen>
1852 [Obsolete("Deprecated in API5; Will be removed in API8. Please use 'Container GetParent() for derived class' instead! " +
1854 "Container parent = view.GetParent(); " +
1855 "View view = parent as View;")]
1856 [EditorBrowsable(EditorBrowsableState.Never)]
1857 public new View Parent
1862 IntPtr cPtr = Interop.Actor.Actor_GetParent(swigCPtr);
1863 HandleRef CPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
1864 BaseHandle basehandle = Registry.GetManagedBaseHandleFromNativePtr(CPtr.Handle);
1866 if (basehandle is Layer layer)
1868 ret = new View(Layer.getCPtr(layer).Handle, false);
1869 NUILog.Error("This Parent property is deprecated, shoud do not be used");
1873 ret = basehandle as View;
1876 Interop.BaseHandle.delete_BaseHandle(CPtr);
1877 CPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
1879 if (NDalicPINVOKE.SWIGPendingException.Pending)
1880 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1886 /// Gets/Sets whether inherit parent's the layout Direction.
1888 /// <since_tizen> 4 </since_tizen>
1889 public bool InheritLayoutDirection
1893 return (bool)GetValue(InheritLayoutDirectionProperty);
1897 SetValue(InheritLayoutDirectionProperty, value);
1898 NotifyPropertyChanged();
1903 /// Gets/Sets the layout Direction.
1905 /// <since_tizen> 4 </since_tizen>
1906 public ViewLayoutDirectionType LayoutDirection
1910 return (ViewLayoutDirectionType)GetValue(LayoutDirectionProperty);
1914 SetValue(LayoutDirectionProperty, value);
1915 NotifyPropertyChanged();
1916 _layout?.RequestLayout();
1921 /// Gets or sets the Margin for use in layout.
1924 /// Margin property is supported by Layout algorithms and containers.
1925 /// Please Set Layout if you want to use Margin property.
1926 /// The property cascade chaining set is possible. For example, this (view.Margin.X = 0.1f;) is possible.
1928 /// <since_tizen> 4 </since_tizen>
1929 public Extents Margin
1933 // If View has a Layout then margin is stored in Layout.
1936 return Layout.Margin;
1940 // If Layout not set then return margin stored in View.
1941 Extents temp = (Extents)GetValue(MarginProperty);
1942 return new Extents(OnMarginChanged, temp.Start, temp.End, temp.Top, temp.Bottom);
1944 // Two return points to prevent creating a zeroed Extent native object before assignment
1950 // Layout set so store Margin in LayoutItem instead of View.
1951 // If View stores the Margin too then the Legacy Size Negotiation will
1952 // overwrite the position and size values measured in the Layouting.
1953 Layout.Margin = value;
1954 SetValue(MarginProperty, new Extents(0, 0, 0, 0));
1955 _layout?.RequestLayout();
1959 SetValue(MarginProperty, value);
1961 NotifyPropertyChanged();
1962 _layout?.RequestLayout();
1967 /// The required policy for this dimension, LayoutParamPolicies enum or exact value.
1969 /// <since_tizen> 6 </since_tizen>
1970 public int WidthSpecification
1974 return _widthPolicy;
1978 _widthPolicy = value;
1979 if (_oldWidthPolicy != _widthPolicy)
1981 if (_widthPolicy >= 0)
1983 _measureSpecificationWidth = new MeasureSpecification(new LayoutLength(value), MeasureSpecification.ModeType.Exactly);
1985 if (_heightPolicy >= 0) // Policy an exact value
1987 // Create Size2D only both _widthPolicy and _heightPolicy are set.
1988 Size2D = new Size2D(_widthPolicy, _heightPolicy);
1991 _layout?.RequestLayout();
1992 _oldWidthPolicy = _widthPolicy;
1998 /// The required policy for this dimension, LayoutParamPolicies enum or exact value.
2000 /// <since_tizen> 6 </since_tizen>
2001 public int HeightSpecification
2005 return _heightPolicy;
2009 _heightPolicy = value;
2010 if (_oldHeightPolicy != _heightPolicy)
2012 if (_heightPolicy >= 0)
2014 _measureSpecificationHeight = new MeasureSpecification(new LayoutLength(value), MeasureSpecification.ModeType.Exactly);
2016 if (_widthPolicy >= 0) // Policy an exact value
2018 // Create Size2D only both _widthPolicy and _heightPolicy are set.
2019 Size2D = new Size2D(_widthPolicy, _heightPolicy);
2023 _layout?.RequestLayout();
2024 _oldHeightPolicy = _heightPolicy;
2030 /// Gets the List of transitions for this View.
2032 /// <since_tizen> 6 </since_tizen>
2033 public Dictionary<TransitionCondition, TransitionList> LayoutTransitions
2037 if (_layoutTransitions == null)
2039 _layoutTransitions = new Dictionary<TransitionCondition, TransitionList>();
2041 return _layoutTransitions;
2046 /// Set a layout transitions for this View.
2048 /// <exception cref="ArgumentNullException"> Thrown when value is null. </exception>
2050 /// Use LayoutTransitions to receive a collection of LayoutTransitions set on the View.
2052 /// <since_tizen> 6 </since_tizen>
2053 public LayoutTransition LayoutTransition
2059 throw new global::System.ArgumentNullException(nameof(value));
2061 if (_layoutTransitions == null)
2063 _layoutTransitions = new Dictionary<TransitionCondition, TransitionList>();
2066 LayoutTransitionsHelper.AddTransitionForCondition(_layoutTransitions, value.Condition, value, true);
2068 AttachTransitionsToChildren(value);
2073 /// Deprecated in API5; Will be removed in API8. Please use Padding instead.
2076 /// The property cascade chaining set is possible. For example, this (view.DecorationBoundingBox.X = 0.1f;) is possible.
2078 /// <since_tizen> 4 </since_tizen>
2079 [Obsolete("Deprecated in API5; Will be removed in API8. Please use Padding instead.")]
2080 [EditorBrowsable(EditorBrowsableState.Never)]
2081 public Extents PaddingEX
2085 Extents temp = new Extents(0, 0, 0, 0);
2086 GetProperty(View.Property.PADDING).Get(temp);
2087 return new Extents(OnPaddingEXChanged, temp.Start, temp.End, temp.Top, temp.Bottom);
2091 SetProperty(View.Property.PADDING, new Tizen.NUI.PropertyValue(value));
2092 NotifyPropertyChanged();
2093 _layout?.RequestLayout();
2098 /// The Color of View. This is an RGBA value.
2102 /// Animatable - This property can be animated using <c>Animation</c> class.
2104 /// The property cascade chaining set is possible. For example, this (view.Color.X = 0.1f;) is possible.
2106 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
2107 [EditorBrowsable(EditorBrowsableState.Never)]
2112 Color temp = (Color)GetValue(ColorProperty);
2113 return new Color(OnColorChanged, temp.R, temp.G, temp.B, temp.A);
2117 SetValue(ColorProperty, value);
2118 selectorData?.Color.UpdateIfNeeds(this, value);
2119 NotifyPropertyChanged();
2124 /// Set the layout on this View. Replaces any existing Layout.
2126 /// <since_tizen> 6 </since_tizen>
2127 public LayoutItem Layout
2135 // Do nothing if layout provided is already set on this View.
2136 if (value == _layout)
2141 layoutingDisabled = false;
2144 // If new layout being set already has a owner then that owner receives a replacement default layout.
2145 // First check if the layout to be set already has a owner.
2146 if (value?.Owner != null)
2148 // Previous owner of the layout gets a default layout as a replacement.
2149 value.Owner.Layout = new AbsoluteLayout();
2151 // Copy Margin and Padding to replacement LayoutGroup.
2152 if (value.Owner.Layout != null)
2154 value.Owner.Layout.Margin = value.Margin;
2155 value.Owner.Layout.Padding = value.Padding;
2159 // Copy Margin and Padding to new layout being set or restore padding and margin back to
2160 // View if no replacement. Previously margin and padding values would have been moved from
2161 // the View to the layout.
2162 if (_layout != null) // Existing layout
2166 // Existing layout being replaced so copy over margin and padding values.
2167 value.Margin = _layout.Margin;
2168 value.Padding = _layout.Padding;
2172 // Layout not being replaced so restore margin and padding to View.
2173 SetValue(MarginProperty, _layout.Margin);
2174 SetValue(PaddingProperty, _layout.Padding);
2175 NotifyPropertyChanged();
2180 // First Layout to be added to the View hence copy
2182 // Do not try to set Margins or Padding on a null Layout (when a layout is being removed from a View)
2185 if (Margin.Top != 0 || Margin.Bottom != 0 || Margin.Start != 0 || Margin.End != 0)
2187 // If View already has a margin set then store it in Layout instead.
2188 value.Margin = Margin;
2189 SetValue(MarginProperty, new Extents(0, 0, 0, 0));
2190 NotifyPropertyChanged();
2193 if (Padding.Top != 0 || Padding.Bottom != 0 || Padding.Start != 0 || Padding.End != 0)
2195 // If View already has a padding set then store it in Layout instead.
2196 value.Padding = Padding;
2197 SetValue(PaddingProperty, new Extents(0, 0, 0, 0));
2198 NotifyPropertyChanged();
2203 // Remove existing layout from it's parent layout group.
2204 _layout?.Unparent();
2206 value.SetPositionByLayout = !excludeLayouting;
2208 // Set layout to this view
2214 /// The weight of the View, used to share available space in a layout with siblings.
2216 /// <since_tizen> 6 </since_tizen>
2226 _layout?.RequestLayout();
2231 /// Whether to load the BackgroundImage synchronously.
2232 /// If not specified, the default is false, i.e. the BackgroundImage is loaded asynchronously.
2233 /// Note: For Normal Quad images only.
2235 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
2236 [EditorBrowsable(EditorBrowsableState.Never)]
2237 public bool BackgroundImageSynchronosLoading
2241 return _backgroundImageSynchronosLoading;
2245 _backgroundImageSynchronosLoading = value;
2247 string bgUrl = null;
2248 Background.Find(ImageVisualProperty.URL)?.Get(out bgUrl);
2250 if (!string.IsNullOrEmpty(bgUrl))
2252 PropertyMap bgMap = this.Background;
2253 bgMap.Add("synchronousLoading", new PropertyValue(_backgroundImageSynchronosLoading));
2259 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
2260 [EditorBrowsable(EditorBrowsableState.Never)]
2261 public Vector2 UpdateSizeHint
2265 return (Vector2)GetValue(UpdateSizeHintProperty);
2269 SetValue(UpdateSizeHintProperty, value);
2270 NotifyPropertyChanged();
2274 /// This will be public opened in tizen_next after ACR done. Before ACR, need to be hidden as inhouse API.
2275 [EditorBrowsable(EditorBrowsableState.Never)]
2276 public string[] TransitionNames
2280 return transitionNames;
2284 transitionNames = value;
2290 /// Enable/Disable ControlState propagation for children.
2291 /// It is false by default.
2292 /// If the View needs to share ControlState with descendants, please set it true.
2293 /// Please note that, changing the value will also changes children's EnableControlStatePropagation value recursively.
2295 [EditorBrowsable(EditorBrowsableState.Never)]
2296 public bool EnableControlStatePropagation
2298 get => controlStatePropagation;
2301 controlStatePropagation = value;
2303 foreach (View child in Children)
2305 child.EnableControlStatePropagation = value;
2311 /// If this property is set to true, the View can have a touch related ControlState (such as Pressed) when touch.
2312 /// By default, it is false in View, true in Control.
2313 /// Note that if the value is true, the View will be a touch receptor.
2315 [EditorBrowsable(EditorBrowsableState.Never)]
2316 public bool EnableControlState
2320 return (bool)GetValue(EnableControlStateProperty);
2324 SetValue(EnableControlStateProperty, value);
2329 /// Whether the actor grab all touches even if touch leaves its boundary.
2331 /// <returns>true, if it grab all touch after start</returns>
2332 [EditorBrowsable(EditorBrowsableState.Never)]
2333 public bool GrabTouchAfterLeave
2338 GetProperty(View.Property.CaptureAllTouchAfterStart).Get(out temp);
2343 SetProperty(View.Property.CaptureAllTouchAfterStart, new Tizen.NUI.PropertyValue(value));
2344 NotifyPropertyChanged();
2349 /// If the value is true, the View will change its style as the theme changes.
2350 /// It is false by default, but turned to true when setting StyleName (by setting property or using specified constructor).
2352 [EditorBrowsable(EditorBrowsableState.Never)]
2353 public bool ThemeChangeSensitive
2355 get => (bool)GetValue(ThemeChangeSensitiveProperty);
2356 set => SetValue(ThemeChangeSensitiveProperty, value);
2360 /// Get Style, it is abstract function and must be override.
2362 /// <since_tizen> 6 </since_tizen>
2363 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
2364 // TODO: It should be deprecated. please use CreateViewStyle instead.
2365 [EditorBrowsable(EditorBrowsableState.Never)]
2366 protected virtual ViewStyle GetViewStyle()
2368 return CreateViewStyle();
2372 /// Create Style, it is abstract function and must be override.
2374 [EditorBrowsable(EditorBrowsableState.Never)]
2375 protected virtual ViewStyle CreateViewStyle()
2377 return new ViewStyle();
2381 /// Called after the View's ControlStates changed.
2383 /// <param name="controlStateChangedInfo">The information including state changed variables.</param>
2384 [EditorBrowsable(EditorBrowsableState.Never)]
2385 protected virtual void OnControlStateChanged(ControlStateChangedEventArgs controlStateChangedInfo)
2391 [EditorBrowsable(EditorBrowsableState.Never)]
2392 protected virtual void OnThemeChanged(object sender, ThemeChangedEventArgs e)
2397 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
2398 [EditorBrowsable(EditorBrowsableState.Never)]
2399 public virtual void ApplyStyle(ViewStyle viewStyle)
2401 if (null == viewStyle || this.viewStyle == viewStyle) return;
2403 this.viewStyle = viewStyle;
2405 Dictionary<string, BindableProperty> bindablePropertyOfView;
2406 Type viewType = GetType();
2408 Dictionary<string, BindableProperty> bindablePropertyOfStyle;
2409 Type styleType = viewStyle.GetType();
2411 BindableProperty.GetBindablePropertysOfType(viewType, out bindablePropertyOfView);
2412 BindableProperty.GetBindablePropertysOfType(styleType, out bindablePropertyOfStyle);
2414 if (null != bindablePropertyOfView && null != bindablePropertyOfStyle)
2416 foreach (KeyValuePair<string, BindableProperty> keyValuePair in bindablePropertyOfStyle)
2418 BindableProperty viewProperty;
2419 bindablePropertyOfView.TryGetValue(keyValuePair.Key, out viewProperty);
2421 if (null != viewProperty && viewProperty != StyleNameProperty)
2423 object value = viewStyle.GetValue(keyValuePair.Value);
2427 SetValue(viewProperty, value);