2 * Copyright(c) 2021 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.
19 using System.Collections.Generic;
20 using System.ComponentModel;
21 using Tizen.NUI.BaseComponents;
22 using Tizen.NUI.Binding;
24 namespace Tizen.NUI.Components
27 /// PoppedEventArgs is a class to record <see cref="Navigator.Popped"/> event arguments which will be sent to user.
29 /// <since_tizen> 9 </since_tizen>
30 public class PoppedEventArgs : EventArgs
33 /// Page popped by Navigator.
35 /// <since_tizen> 9 </since_tizen>
36 public Page Page { get; internal set; }
40 /// The Navigator is a class which navigates pages with stack methods such as Push and Pop.
43 /// With Transition class, Navigator supports smooth transition of View pair between two Pages
44 /// by using <see cref="PushWithTransition(Page)"/> and <see cref="PopWithTransition()"/> methods.
45 /// If current top Page and next top Page have <see cref="View"/>s those have same TransitionTag,
46 /// Navigator creates smooth transition motion for them.
47 /// Navigator.Transition property can be used to set properties of the Transition such as TimePeriod and AlphaFunction.
48 /// When all transitions are finished, Navigator calls a callback methods those connected on the "TransitionFinished" event.
52 /// Navigator navigator = new Navigator()
54 /// TimePeriod = new TimePeriod(500),
55 /// AlphaFunction = new AlphaFunction(AlphaFunction.BuiltinFunctions.EaseInOutSine)
58 /// View view = new View()
60 /// TransitionOptions = new TransitionOptions()
62 /// /* Set properties for the transition of this View */
66 /// ContentPage newPage = new ContentPage()
71 /// Navigator.PushWithTransition(newPage);
74 /// <since_tizen> 9 </since_tizen>
75 public class Navigator : Control
78 /// TransitionProperty
80 [EditorBrowsable(EditorBrowsableState.Never)]
81 public static readonly BindableProperty TransitionProperty = BindableProperty.Create(nameof(Transition), typeof(Transition), typeof(Navigator), null, propertyChanged: (bindable, oldValue, newValue) =>
83 var instance = (Navigator)bindable;
86 instance.InternalTransition = newValue as Transition;
89 defaultValueCreator: (bindable) =>
91 var instance = (Navigator)bindable;
92 return instance.InternalTransition;
95 private const int DefaultTransitionDuration = 500;
97 //This will be replaced with view transition class instance.
98 private Animation curAnimation = null;
100 //This will be replaced with view transition class instance.
101 private Animation newAnimation = null;
103 private TransitionSet transitionSet = null;
105 private Transition transition = new Transition()
107 TimePeriod = new TimePeriod(DefaultTransitionDuration),
108 AlphaFunction = new AlphaFunction(AlphaFunction.BuiltinFunctions.Default),
111 private bool transitionFinished = true;
113 //TODO: Needs to consider how to remove disposed window from dictionary.
114 //Two dictionaries are required to remove disposed navigator from dictionary.
115 private static Dictionary<Window, Navigator> windowNavigator = new Dictionary<Window, Navigator>();
116 private static Dictionary<Navigator, Window> navigatorWindow = new Dictionary<Navigator, Window>();
118 private List<Page> navigationPages = new List<Page>();
121 /// Creates a new instance of a Navigator.
123 /// <since_tizen> 9 </since_tizen>
124 public Navigator() : base()
126 Layout = new AbsoluteLayout();
130 [EditorBrowsable(EditorBrowsableState.Never)]
131 public override void OnInitialize()
135 SetAccessibilityConstructor(Role.PageTabList);
139 /// An event fired when Transition has been finished.
141 /// <since_tizen> 9 </since_tizen>
142 public event EventHandler<EventArgs> TransitionFinished;
145 /// An event fired when Pop of a page has been finished.
148 /// When you free resources in the Popped event handler, please make sure if the popped page is the page you find.
150 /// <since_tizen> 9 </since_tizen>
151 public event EventHandler<PoppedEventArgs> Popped;
154 /// Returns the count of pages in Navigator.
156 /// <since_tizen> 9 </since_tizen>
157 public int PageCount => navigationPages.Count;
160 /// Transition properties for the transition of View pair having same transition tag.
162 /// <since_tizen> 9 </since_tizen>
163 public Transition Transition
167 return GetValue(TransitionProperty) as Transition;
171 SetValue(TransitionProperty, value);
172 NotifyPropertyChanged();
175 private Transition InternalTransition
188 /// Pushes a page to Navigator.
189 /// If the page is already in Navigator, then it is not pushed.
191 /// <param name="page">The page to push to Navigator.</param>
192 /// <exception cref="ArgumentNullException">Thrown when the argument page is null.</exception>
193 /// <since_tizen> 9 </since_tizen>
194 public void PushWithTransition(Page page)
196 if (!transitionFinished)
198 Tizen.Log.Error("NUI", "Transition is still not finished.\n");
204 throw new ArgumentNullException(nameof(page), "page should not be null.");
207 //Duplicate page is not pushed.
208 if (navigationPages.Contains(page)) return;
210 var topPage = Peek();
218 navigationPages.Add(page);
220 page.Navigator = this;
223 page.InvokeAppearing();
224 topPage.InvokeDisappearing();
226 transitionSet = CreateTransitions(topPage, page, true);
227 transitionSet.Finished += (object sender, EventArgs e) =>
229 if (page is DialogPage == false)
231 topPage.SetVisible(false);
234 // Need to update Content of the new page
235 ShowContentOfPage(page);
238 page.InvokeAppeared();
239 topPage.InvokeDisappeared();
240 NotifyAccessibilityStatesChangeOfPages(topPage, page);
242 transitionFinished = false;
246 /// Pops the top page from Navigator.
248 /// <returns>The popped page.</returns>
249 /// <exception cref="InvalidOperationException">Thrown when there is no page in Navigator.</exception>
250 /// <since_tizen> 9 </since_tizen>
251 public Page PopWithTransition()
253 if (!transitionFinished)
255 Tizen.Log.Error("NUI", "Transition is still not finished.\n");
259 if (navigationPages.Count == 0)
261 throw new InvalidOperationException("There is no page in Navigator.");
264 var topPage = Peek();
266 if (navigationPages.Count == 1)
270 //Invoke Popped event
271 Popped?.Invoke(this, new PoppedEventArgs() { Page = topPage });
275 var newTopPage = navigationPages[navigationPages.Count - 2];
278 newTopPage.InvokeAppearing();
279 topPage.InvokeDisappearing();
281 transitionSet = CreateTransitions(topPage, newTopPage, false);
282 transitionSet.Finished += (object sender, EventArgs e) =>
285 topPage.SetVisible(true);
287 // Need to update Content of the new page
288 ShowContentOfPage(newTopPage);
291 newTopPage.InvokeAppeared();
292 topPage.InvokeDisappeared();
293 NotifyAccessibilityStatesChangeOfPages(topPage, newTopPage);
295 //Invoke Popped event
296 Popped?.Invoke(this, new PoppedEventArgs() { Page = topPage });
298 transitionFinished = false;
304 /// Pushes a page to Navigator.
305 /// If the page is already in Navigator, then it is not pushed.
307 /// <param name="page">The page to push to Navigator.</param>
308 /// <exception cref="ArgumentNullException">Thrown when the argument page is null.</exception>
309 /// <since_tizen> 9 </since_tizen>
310 public void Push(Page page)
312 if (!transitionFinished)
314 Tizen.Log.Error("NUI", "Transition is still not finished.\n");
320 throw new ArgumentNullException(nameof(page), "page should not be null.");
323 //Duplicate page is not pushed.
324 if (navigationPages.Contains(page)) return;
334 navigationPages.Add(page);
336 page.Navigator = this;
339 page.InvokeAppearing();
340 curTop.InvokeDisappearing();
342 //TODO: The following transition codes will be replaced with view transition.
343 InitializeAnimation();
345 if (page is DialogPage == false)
347 curAnimation = new Animation(1000);
348 curAnimation.AnimateTo(curTop, "Opacity", 1.0f, 0, 1000);
349 curAnimation.EndAction = Animation.EndActions.StopFinal;
350 curAnimation.Finished += (object sender, EventArgs args) =>
352 curTop.SetVisible(false);
355 curTop.InvokeDisappeared();
360 page.SetVisible(true);
361 newAnimation = new Animation(1000);
362 newAnimation.AnimateTo(page, "Opacity", 1.0f, 0, 1000);
363 newAnimation.EndAction = Animation.EndActions.StopFinal;
364 newAnimation.Finished += (object sender, EventArgs e) =>
366 // Need to update Content of the new page
367 ShowContentOfPage(page);
370 page.InvokeAppeared();
371 NotifyAccessibilityStatesChangeOfPages(curTop, page);
377 ShowContentOfPage(page);
382 /// Pops the top page from Navigator.
384 /// <returns>The popped page.</returns>
385 /// <exception cref="InvalidOperationException">Thrown when there is no page in Navigator.</exception>
386 /// <since_tizen> 9 </since_tizen>
389 if (!transitionFinished)
391 Tizen.Log.Error("NUI", "Transition is still not finished.\n");
395 if (navigationPages.Count == 0)
397 throw new InvalidOperationException("There is no page in Navigator.");
402 if (navigationPages.Count == 1)
406 //Invoke Popped event
407 Popped?.Invoke(this, new PoppedEventArgs() { Page = curTop });
412 var newTop = navigationPages[navigationPages.Count - 2];
415 newTop.InvokeAppearing();
416 curTop.InvokeDisappearing();
418 //TODO: The following transition codes will be replaced with view transition.
419 InitializeAnimation();
421 if (curTop is DialogPage == false)
423 curAnimation = new Animation(1000);
424 curAnimation.AnimateTo(curTop, "Opacity", 0.0f, 0, 1000);
425 curAnimation.EndAction = Animation.EndActions.StopFinal;
426 curAnimation.Finished += (object sender, EventArgs e) =>
428 //Removes the current top page after transition is finished.
430 curTop.Opacity = 1.0f;
433 curTop.InvokeDisappeared();
435 //Invoke Popped event
436 Popped?.Invoke(this, new PoppedEventArgs() { Page = curTop });
440 newTop.Opacity = 1.0f;
441 newTop.SetVisible(true);
442 newAnimation = new Animation(1000);
443 newAnimation.AnimateTo(newTop, "Opacity", 1.0f, 0, 1000);
444 newAnimation.EndAction = Animation.EndActions.StopFinal;
445 newAnimation.Finished += (object sender, EventArgs e) =>
447 // Need to update Content of the new page
448 ShowContentOfPage(newTop);
451 newTop.InvokeAppeared();
452 NotifyAccessibilityStatesChangeOfPages(curTop, newTop);
465 /// Returns the page of the given index in Navigator.
466 /// The indices of pages in Navigator are basically the order of pushing or inserting to Navigator.
467 /// So a page's index in Navigator can be changed whenever push/insert or pop/remove occurs.
469 /// <param name="index">The index of a page in Navigator.</param>
470 /// <returns>The page of the given index in Navigator.</returns>
471 /// <exception cref="ArgumentOutOfRangeException">Thrown when the argument index is less than 0, or greater than the number of pages.</exception>
472 public Page GetPage(int index)
474 if ((index < 0) || (index > navigationPages.Count))
476 throw new ArgumentOutOfRangeException(nameof(index), "index should be greater than or equal to 0, and less than or equal to the number of pages.");
479 return navigationPages[index];
483 /// Returns the current index of the given page in Navigator.
484 /// The indices of pages in Navigator are basically the order of pushing or inserting to Navigator.
485 /// So a page's index in Navigator can be changed whenever push/insert or pop/remove occurs.
487 /// <param name="page">The page in Navigator.</param>
488 /// <returns>The index of the given page in Navigator. If the given page is not in the Navigator, then -1 is returned.</returns>
489 /// <exception cref="ArgumentNullException">Thrown when the argument page is null.</exception>
490 /// <since_tizen> 9 </since_tizen>
491 public int IndexOf(Page page)
495 throw new ArgumentNullException(nameof(page), "page should not be null.");
498 for (int i = 0; i < navigationPages.Count; i++)
500 if (navigationPages[i] == page)
510 /// Inserts a page at the specified index of Navigator.
511 /// The indices of pages in Navigator are basically the order of pushing or inserting to Navigator.
512 /// So a page's index in Navigator can be changed whenever push/insert or pop/remove occurs.
513 /// To find the current index of a page in Navigator, please use IndexOf(page).
514 /// If the page is already in Navigator, then it is not inserted.
516 /// <param name="index">The index of a page in Navigator where the page will be inserted.</param>
517 /// <param name="page">The page to insert to Navigator.</param>
518 /// <exception cref="ArgumentOutOfRangeException">Thrown when the argument index is less than 0, or greater than the number of pages.</exception>
519 /// <exception cref="ArgumentNullException">Thrown when the argument page is null.</exception>
520 /// <since_tizen> 9 </since_tizen>
521 public void Insert(int index, Page page)
523 if ((index < 0) || (index > navigationPages.Count))
525 throw new ArgumentOutOfRangeException(nameof(index), "index should be greater than or equal to 0, and less than or equal to the number of pages.");
530 throw new ArgumentNullException(nameof(page), "page should not be null.");
533 //Duplicate page is not pushed.
534 if (navigationPages.Contains(page)) return;
536 //TODO: The following transition codes will be replaced with view transition.
537 InitializeAnimation();
539 ShowContentOfPage(page);
541 if (index == PageCount)
544 page.SetVisible(true);
548 page.SetVisible(false);
552 navigationPages.Insert(index, page);
554 page.Navigator = this;
558 /// Inserts a page to Navigator before an existing page.
559 /// If the page is already in Navigator, then it is not inserted.
561 /// <param name="before">The existing page, before which a page will be inserted.</param>
562 /// <param name="page">The page to insert to Navigator.</param>
563 /// <exception cref="ArgumentNullException">Thrown when the argument before is null.</exception>
564 /// <exception cref="ArgumentNullException">Thrown when the argument page is null.</exception>
565 /// <exception cref="ArgumentException">Thrown when the argument before does not exist in Navigator.</exception>
566 /// <since_tizen> 9 </since_tizen>
567 public void InsertBefore(Page before, Page page)
571 throw new ArgumentNullException(nameof(before), "before should not be null.");
576 throw new ArgumentNullException(nameof(page), "page should not be null.");
579 //Find the index of before page.
580 int beforeIndex = navigationPages.FindIndex(x => x == before);
582 //before does not exist in Navigator.
583 if (beforeIndex == -1)
585 throw new ArgumentException("before does not exist in Navigator.", nameof(before));
588 Insert(beforeIndex, page);
592 /// Removes a page from Navigator.
594 /// <param name="page">The page to remove from Navigator.</param>
595 /// <exception cref="ArgumentNullException">Thrown when the argument page is null.</exception>
596 /// <since_tizen> 9 </since_tizen>
597 public void Remove(Page page)
601 throw new ArgumentNullException(nameof(page), "page should not be null.");
604 //TODO: The following transition codes will be replaced with view transition.
605 InitializeAnimation();
607 HideContentOfPage(page);
609 if ((page == Peek()) && (PageCount >= 2))
611 navigationPages[PageCount - 2].Opacity = 1.0f;
612 navigationPages[PageCount - 2].SetVisible(true);
615 page.Navigator = null;
616 navigationPages.Remove(page);
621 /// Removes a page at the specified index of Navigator.
622 /// The indices of pages in Navigator are basically the order of pushing or inserting to Navigator.
623 /// So a page's index in Navigator can be changed whenever push/insert or pop/remove occurs.
624 /// To find the current index of a page in Navigator, please use IndexOf(page).
626 /// <param name="index">The index of a page in Navigator where the page will be removed.</param>
627 /// <exception cref="ArgumentOutOfRangeException">Thrown when the index is less than 0, or greater than or equal to the number of pages.</exception>
628 /// <since_tizen> 9 </since_tizen>
629 public void RemoveAt(int index)
631 if ((index < 0) || (index >= navigationPages.Count))
633 throw new ArgumentOutOfRangeException(nameof(index), "index should be greater than or equal to 0, and less than the number of pages.");
636 Remove(navigationPages[index]);
640 /// Returns the page at the top of Navigator.
642 /// <returns>The page at the top of Navigator.</returns>
643 /// <since_tizen> 9 </since_tizen>
646 if (navigationPages.Count == 0) return null;
648 return navigationPages[navigationPages.Count - 1];
652 /// Disposes Navigator and all children on it.
654 /// <param name="type">Dispose type.</param>
655 [EditorBrowsable(EditorBrowsableState.Never)]
656 protected override void Dispose(DisposeTypes type)
663 if (type == DisposeTypes.Explicit)
665 foreach (Page page in navigationPages)
667 Utility.Dispose(page);
669 navigationPages.Clear();
673 if (navigatorWindow.TryGetValue(this, out window) == true)
675 navigatorWindow.Remove(this);
676 windowNavigator.Remove(window);
684 /// Returns the default navigator of the given window.
686 /// <returns>The default navigator of the given window.</returns>
687 /// <exception cref="ArgumentNullException">Thrown when the argument window is null.</exception>
688 /// <since_tizen> 9 </since_tizen>
689 public static Navigator GetDefaultNavigator(Window window)
693 throw new ArgumentNullException(nameof(window), "window should not be null.");
696 if (windowNavigator.ContainsKey(window) == true)
698 return windowNavigator[window];
701 var defaultNavigator = new Navigator();
702 defaultNavigator.WidthResizePolicy = ResizePolicyType.FillToParent;
703 defaultNavigator.HeightResizePolicy = ResizePolicyType.FillToParent;
704 window.Add(defaultNavigator);
705 windowNavigator.Add(window, defaultNavigator);
706 navigatorWindow.Add(defaultNavigator, window);
708 return defaultNavigator;
712 /// Create Transitions between currentTopPage and newTopPage
714 /// <param name="currentTopPage">The top page of Navigator.</param>
715 /// <param name="newTopPage">The new top page after transition.</param>
716 /// <param name="pushTransition">True if this transition is for push new page</param>
717 private TransitionSet CreateTransitions(Page currentTopPage, Page newTopPage, bool pushTransition)
719 currentTopPage.SetVisible(true);
720 newTopPage.SetVisible(true);
722 List<View> taggedViewsInNewTopPage = new List<View>();
723 RetrieveTaggedViews(taggedViewsInNewTopPage, newTopPage, true);
724 List<View> taggedViewsInCurrentTopPage = new List<View>();
725 RetrieveTaggedViews(taggedViewsInCurrentTopPage, currentTopPage, true);
727 List<KeyValuePair<View, View>> sameTaggedViewPair = new List<KeyValuePair<View, View>>();
728 foreach(View currentTopPageView in taggedViewsInCurrentTopPage)
730 bool findPair = false;
731 foreach(View newTopPageView in taggedViewsInNewTopPage)
733 if((currentTopPageView.TransitionOptions != null) && (newTopPageView.TransitionOptions != null) &&
734 currentTopPageView.TransitionOptions?.TransitionTag == newTopPageView.TransitionOptions?.TransitionTag)
736 sameTaggedViewPair.Add(new KeyValuePair<View, View>(currentTopPageView, newTopPageView));
743 taggedViewsInNewTopPage.Remove(sameTaggedViewPair[sameTaggedViewPair.Count - 1].Value);
746 foreach(KeyValuePair<View, View> pair in sameTaggedViewPair)
748 taggedViewsInCurrentTopPage.Remove(pair.Key);
751 TransitionSet newTransitionSet = new TransitionSet();
752 foreach(KeyValuePair<View, View> pair in sameTaggedViewPair)
754 TransitionItem pairTransition = transition.CreateTransition(pair.Key, pair.Value, pushTransition);
755 if(pair.Value.TransitionOptions?.TransitionWithChild ?? false)
757 pairTransition.TransitionWithChild = true;
759 newTransitionSet.AddTransition(pairTransition);
762 newTransitionSet.Finished += (object sender, EventArgs e) =>
764 if(newTopPage.Layout != null)
766 newTopPage.Layout.RequestLayout();
768 if(currentTopPage.Layout != null)
770 currentTopPage.Layout.RequestLayout();
772 transitionFinished = true;
773 InvokeTransitionFinished();
774 transitionSet.Dispose();
775 currentTopPage.Opacity = 1.0f;
778 if (!pushTransition || newTopPage is DialogPage == false)
780 View transitionView = (currentTopPage is ContentPage) ? (currentTopPage as ContentPage).Content : (currentTopPage as DialogPage).Content;
781 if (currentTopPage.DisappearingTransition != null && transitionView != null)
783 TransitionItemBase disappearingTransition = currentTopPage.DisappearingTransition.CreateTransition(transitionView, false);
784 disappearingTransition.TransitionWithChild = true;
785 newTransitionSet.AddTransition(disappearingTransition);
789 currentTopPage.SetVisible(false);
792 if (pushTransition || currentTopPage is DialogPage == false)
794 View transitionView = (newTopPage is ContentPage) ? (newTopPage as ContentPage).Content : (newTopPage as DialogPage).Content;
795 if (newTopPage.AppearingTransition != null && transitionView != null)
797 TransitionItemBase appearingTransition = newTopPage.AppearingTransition.CreateTransition(transitionView, true);
798 appearingTransition.TransitionWithChild = true;
799 newTransitionSet.AddTransition(appearingTransition);
803 newTransitionSet.Play();
805 return newTransitionSet;
809 /// Retrieve Tagged Views in the view tree.
811 /// <param name="taggedViews">Returned tagged view list..</param>
812 /// <param name="view">Root View to get tagged child View.</param>
813 /// <param name="isRoot">Flag to check current View is page or not</param>
814 private void RetrieveTaggedViews(List<View> taggedViews, View view, bool isRoot)
816 if (!isRoot && view.TransitionOptions != null)
818 if (!string.IsNullOrEmpty(view.TransitionOptions?.TransitionTag))
820 taggedViews.Add((view as View));
821 if (view.TransitionOptions.TransitionWithChild)
829 foreach (View child in view.Children)
831 RetrieveTaggedViews(taggedViews, child, false);
836 /// Notify accessibility states change of pages.
838 /// <param name="disappearedPage">Disappeared page</param>
839 /// <param name="appearedPage">Appeared page</param>
840 private void NotifyAccessibilityStatesChangeOfPages(Page disappearedPage, Page appearedPage)
842 if (disappearedPage != null)
844 disappearedPage.UnregisterDefaultLabel();
845 //We can call disappearedPage.NotifyAccessibilityStatesChange
846 //To reduce accessibility events, we are using currently highlighted view instead
847 View curHighlightedView = Accessibility.Accessibility.Instance.GetCurrentlyHighlightedView();
848 if (curHighlightedView != null)
850 curHighlightedView.NotifyAccessibilityStatesChange(AccessibilityStates.Visible | AccessibilityStates.Showing, AccessibilityStatesNotifyMode.Single);
854 if (appearedPage != null)
856 appearedPage.RegisterDefaultLabel();
857 appearedPage.NotifyAccessibilityStatesChange(AccessibilityStates.Visible | AccessibilityStates.Showing, AccessibilityStatesNotifyMode.Single);
861 internal void InvokeTransitionFinished()
863 TransitionFinished?.Invoke(this, new EventArgs());
866 //TODO: The following transition codes will be replaced with view transition.
867 private void InitializeAnimation()
869 if (curAnimation != null)
872 curAnimation.Clear();
876 if (newAnimation != null)
879 newAnimation.Clear();
884 // Show and Register Content of Page to Accessibility bridge
885 private void ShowContentOfPage(Page page)
887 View content = (page is DialogPage) ? (page as DialogPage)?.Content : (page as ContentPage)?.Content;
890 content.Show(); // Calls RegisterDefaultLabel()
894 // Hide and Remove Content of Page from Accessibility bridge
895 private void HideContentOfPage(Page page)
897 View content = (page is DialogPage) ? (page as DialogPage)?.Content : (page as ContentPage)?.Content;
900 content.Hide(); // Calls UnregisterDefaultLabel()