/*
- * Copyright(c) 2020 Samsung Electronics Co., Ltd.
+ * Copyright(c) 2021 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
using System;
using System.Collections.Generic;
using System.ComponentModel;
-using System.Diagnostics.CodeAnalysis;
-using System.Threading.Tasks;
using Tizen.NUI.BaseComponents;
using Tizen.NUI.Binding;
namespace Tizen.NUI.Components
{
/// <summary>
- /// The Navigator is a class which navigates pages with stack methods such
- /// as Push and Pop.
+ /// PoppedEventArgs is a class to record <see cref="Navigator.Popped"/> event arguments which will be sent to user.
/// </summary>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
+ public class PoppedEventArgs : EventArgs
+ {
+ /// <summary>
+ /// Page popped by Navigator.
+ /// </summary>
+ /// <since_tizen> 9 </since_tizen>
+ public Page Page { get; internal set; }
+ }
+
+ /// <summary>
+ /// The Navigator is a class which navigates pages with stack methods such as Push and Pop.
+ /// </summary>
+ /// <remarks>
+ /// With Transition class, Navigator supports smooth transition of View pair between two Pages
+ /// by using <see cref="PushWithTransition(Page)"/> and <see cref="PopWithTransition()"/> methods.
+ /// If current top Page and next top Page have <see cref="View"/>s those have same TransitionTag,
+ /// Navigator creates smooth transition motion for them.
+ /// Navigator.Transition property can be used to set properties of the Transition such as TimePeriod and AlphaFunction.
+ /// When all transitions are finished, Navigator calls a callback methods those connected on the "TransitionFinished" event.
+ /// </remarks>
+ /// <example>
+ /// <code>
+ /// Navigator navigator = new Navigator()
+ /// {
+ /// TimePeriod = new TimePeriod(500),
+ /// AlphaFunction = new AlphaFunction(AlphaFunction.BuiltinFunctions.EaseInOutSine)
+ /// };
+ ///
+ /// View view = new View()
+ /// {
+ /// TransitionOptions = new TransitionOptions()
+ /// {
+ /// /* Set properties for the transition of this View */
+ /// }
+ /// };
+ ///
+ /// ContentPage newPage = new ContentPage()
+ /// {
+ /// Content = view,
+ /// };
+ ///
+ /// Navigator.PushWithTransition(newPage);
+ /// </code>
+ /// </example>
+ /// <since_tizen> 9 </since_tizen>
public class Navigator : Control
{
+ /// <summary>
+ /// TransitionProperty
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static readonly BindableProperty TransitionProperty = BindableProperty.Create(nameof(Transition), typeof(Transition), typeof(Navigator), null, propertyChanged: (bindable, oldValue, newValue) =>
+ {
+ var instance = (Navigator)bindable;
+ if (newValue != null)
+ {
+ instance.InternalTransition = newValue as Transition;
+ }
+ },
+ defaultValueCreator: (bindable) =>
+ {
+ var instance = (Navigator)bindable;
+ return instance.InternalTransition;
+ });
+
+ /// <summary>
+ /// EnableBackNavigationProperty
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static readonly BindableProperty EnableBackNavigationProperty = BindableProperty.Create(nameof(EnableBackNavigation), typeof(bool), typeof(Navigator), default(bool), propertyChanged: (bindable, oldValue, newValue) =>
+ {
+ var instance = (Navigator)bindable;
+ if (newValue != null)
+ {
+ instance.InternalEnableBackNavigation = (bool)newValue;
+ }
+ },
+ defaultValueCreator: (bindable) =>
+ {
+ var instance = (Navigator)bindable;
+ return instance.InternalEnableBackNavigation;
+ });
+
+ private const int DefaultTransitionDuration = 300;
+
//This will be replaced with view transition class instance.
- private Animation _curAnimation = null;
+ private Animation curAnimation = null;
//This will be replaced with view transition class instance.
- private Animation _newAnimation = null;
+ private Animation newAnimation = null;
+
+ private TransitionSet transitionSet = null;
+
+ private Transition transition = new Transition()
+ {
+ TimePeriod = new TimePeriod(DefaultTransitionDuration),
+ AlphaFunction = new AlphaFunction(AlphaFunction.BuiltinFunctions.Default),
+ };
+
+ private bool transitionFinished = true;
//TODO: Needs to consider how to remove disposed window from dictionary.
//Two dictionaries are required to remove disposed navigator from dictionary.
private static Dictionary<Window, Navigator> windowNavigator = new Dictionary<Window, Navigator>();
private static Dictionary<Navigator, Window> navigatorWindow = new Dictionary<Navigator, Window>();
+ private List<Page> navigationPages = new List<Page>();
+
+ private bool enableBackNavigation = true;
+
+ private Window parentWindow;
+
+ private void OnWindowKeyEvent(object sender, Window.KeyEventArgs e)
+ {
+ if (!EnableBackNavigation)
+ {
+ return;
+ }
+
+ if ((e.Key.State == Key.StateType.Up) && ((e.Key.KeyPressedName == "Escape") || (e.Key.KeyPressedName == "BackSpace") || (e.Key.KeyPressedName == "XF86Back")))
+ {
+ OnBackNavigation(new BackNavigationEventArgs());
+ }
+ }
+
+ private void OnAddedToWindow(object sender, EventArgs e)
+ {
+ parentWindow = Window.Get(this);
+ if (null != parentWindow)
+ {
+ parentWindow.KeyEvent += OnWindowKeyEvent;
+ }
+ }
+
+ private void OnRemovedFromWindow(object sender, EventArgs e)
+ {
+ if (null != parentWindow)
+ {
+ parentWindow.KeyEvent -= OnWindowKeyEvent;
+ parentWindow = null;
+ }
+ }
+
+ private void Initialize()
+ {
+ Layout = new AbsoluteLayout();
+
+ AddedToWindow += OnAddedToWindow;
+ RemovedFromWindow += OnRemovedFromWindow;
+ }
+
/// <summary>
/// Creates a new instance of a Navigator.
/// </summary>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
public Navigator() : base()
{
+ Initialize();
+ }
+
+ /// <summary>
+ /// Creates a new instance of Navigator with style.
+ /// </summary>
+ /// <param name="style">Creates Navigator by special style defined in UX.</param>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public Navigator(string style) : base(style)
+ {
+ Initialize();
}
/// <summary>
- /// List of pages of Navigator.
+ /// Creates a new instance of a Navigator with style.
/// </summary>
+ /// <param name="style">A style applied to the newly created Navigator.</param>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public Navigator(ControlStyle style) : base(style)
+ {
+ Initialize();
+ }
+
+ /// <inheritdoc/>
[EditorBrowsable(EditorBrowsableState.Never)]
- public List<Page> NavigationPages { get; } = new List<Page>();
+ public override void OnInitialize()
+ {
+ base.OnInitialize();
+
+ AccessibilityRole = Role.PageTabList;
+ }
+
+ /// <summary>
+ /// An event fired when Transition has been finished.
+ /// </summary>
+ /// <since_tizen> 9 </since_tizen>
+ public event EventHandler<EventArgs> TransitionFinished;
+
+ /// <summary>
+ /// An event fired when Pop of a page has been finished.
+ /// </summary>
+ /// <remarks>
+ /// When you free resources in the Popped event handler, please make sure if the popped page is the page you find.
+ /// </remarks>
+ /// <since_tizen> 9 </since_tizen>
+ public event EventHandler<PoppedEventArgs> Popped;
+
+ /// <summary>
+ /// Returns the count of pages in Navigator.
+ /// </summary>
+ /// <since_tizen> 9 </since_tizen>
+ public int PageCount => navigationPages.Count;
+
+ /// <summary>
+ /// Transition properties for the transition of View pair having same transition tag.
+ /// </summary>
+ /// <since_tizen> 9 </since_tizen>
+ public Transition Transition
+ {
+ get
+ {
+ return GetValue(TransitionProperty) as Transition;
+ }
+ set
+ {
+ SetValue(TransitionProperty, value);
+ NotifyPropertyChanged();
+ }
+ }
+ private Transition InternalTransition
+ {
+ set
+ {
+ transition = value;
+ }
+ get
+ {
+ return transition;
+ }
+ }
/// <summary>
/// Pushes a page to Navigator.
/// </summary>
/// <param name="page">The page to push to Navigator.</param>
/// <exception cref="ArgumentNullException">Thrown when the argument page is null.</exception>
- [EditorBrowsable(EditorBrowsableState.Never)]
- public void Push(Page page)
+ /// <since_tizen> 9 </since_tizen>
+ public void PushWithTransition(Page page)
{
+ if (!transitionFinished)
+ {
+ Tizen.Log.Error("NUI", "Transition is still not finished.\n");
+ return;
+ }
+
if (page == null)
{
throw new ArgumentNullException(nameof(page), "page should not be null.");
}
//Duplicate page is not pushed.
- if (NavigationPages.Contains(page)) return;
+ if (navigationPages.Contains(page)) return;
- var curTop = Peek();
+ var topPage = Peek();
- if (!curTop)
+ if (!topPage)
{
Insert(0, page);
return;
}
- NavigationPages.Add(page);
+ navigationPages.Add(page);
Add(page);
+ page.Navigator = this;
//Invoke Page events
page.InvokeAppearing();
- curTop.InvokeDisappearing();
+ topPage.InvokeDisappearing();
+ topPage.SaveKeyFocus();
- //TODO: The following transition codes will be replaced with view transition.
- if (_curAnimation)
+ transitionSet = CreateTransitions(topPage, page, true);
+ transitionSet.Finished += (object sender, EventArgs e) =>
+ {
+ if (page is DialogPage == false)
+ {
+ topPage.SetVisible(false);
+ }
+
+ // Need to update Content of the new page
+ ShowContentOfPage(page);
+
+ //Invoke Page events
+ page.InvokeAppeared();
+ page.RestoreKeyFocus();
+
+ topPage.InvokeDisappeared();
+ NotifyAccessibilityStatesChangeOfPages(topPage, page);
+ };
+ transitionFinished = false;
+ }
+
+ /// <summary>
+ /// Pops the top page from Navigator.
+ /// </summary>
+ /// <returns>The popped page.</returns>
+ /// <exception cref="InvalidOperationException">Thrown when there is no page in Navigator.</exception>
+ /// <since_tizen> 9 </since_tizen>
+ public Page PopWithTransition()
+ {
+ if (!transitionFinished)
{
- _curAnimation.Stop();
- _curAnimation.Clear();
+ Tizen.Log.Error("NUI", "Transition is still not finished.\n");
+ return null;
}
- if (_newAnimation)
+ if (navigationPages.Count == 0)
{
- _newAnimation.Stop();
- _newAnimation.Clear();
+ throw new InvalidOperationException("There is no page in Navigator.");
}
- _curAnimation = new Animation(1000);
- using (var scaleVec = new Vector3(0.0f, 0.0f, 1.0f))
+ var topPage = Peek();
+
+ if (navigationPages.Count == 1)
{
- _curAnimation.AnimateTo(curTop, "Scale", scaleVec, 0, 1000);
+ Remove(topPage);
+
+ //Invoke Popped event
+ Popped?.Invoke(this, new PoppedEventArgs() { Page = topPage });
+
+ return topPage;
}
- _curAnimation.AnimateTo(curTop, "Opacity", 0.0f, 0, 1000);
- _curAnimation.EndAction = Animation.EndActions.Discard;
- _curAnimation.Play();
+ var newTopPage = navigationPages[navigationPages.Count - 2];
- using (var scaleVec = new Vector3(0.0f, 0.0f, 1.0f))
+ //Invoke Page events
+ newTopPage.InvokeAppearing();
+ topPage.InvokeDisappearing();
+ topPage.SaveKeyFocus();
+
+ transitionSet = CreateTransitions(topPage, newTopPage, false);
+ transitionSet.Finished += (object sender, EventArgs e) =>
{
- using (var scaleProp = new Tizen.NUI.PropertyValue(scaleVec))
- {
- Tizen.NUI.Object.SetProperty(page.SwigCPtr, Page.Property.SCALE, scaleProp);
- }
+ Remove(topPage);
+ topPage.SetVisible(true);
+
+ // Need to update Content of the new page
+ ShowContentOfPage(newTopPage);
+
+ //Invoke Page events
+ newTopPage.InvokeAppeared();
+ newTopPage.RestoreKeyFocus();
+
+ topPage.InvokeDisappeared();
+
+ //Invoke Popped event
+ Popped?.Invoke(this, new PoppedEventArgs() { Page = topPage });
+ };
+ transitionFinished = false;
+
+ return topPage;
+ }
+
+ /// <summary>
+ /// Pushes a page to Navigator.
+ /// If the page is already in Navigator, then it is not pushed.
+ /// </summary>
+ /// <param name="page">The page to push to Navigator.</param>
+ /// <exception cref="ArgumentNullException">Thrown when the argument page is null.</exception>
+ /// <since_tizen> 9 </since_tizen>
+ public void Push(Page page)
+ {
+ if (!transitionFinished)
+ {
+ Tizen.Log.Error("NUI", "Transition is still not finished.\n");
+ return;
+ }
+
+ if (page == null)
+ {
+ throw new ArgumentNullException(nameof(page), "page should not be null.");
+ }
+
+ //Duplicate page is not pushed.
+ if (navigationPages.Contains(page)) return;
+
+ //TODO: The following transition codes will be replaced with view transition.
+ InitializeAnimation();
+
+ var curTop = Peek();
+
+ if (!curTop)
+ {
+ Insert(0, page);
+ return;
}
- using (var scaleProp = new Tizen.NUI.PropertyValue(0.0f))
+
+ navigationPages.Add(page);
+ Add(page);
+ page.Navigator = this;
+
+ //Invoke Page events
+ page.InvokeAppearing();
+ curTop.InvokeDisappearing();
+
+ curTop.SaveKeyFocus();
+
+ if (page is DialogPage == false)
{
- Tizen.NUI.Object.SetProperty(page.SwigCPtr, Page.Property.OPACITY, scaleProp);
+ curAnimation = new Animation(DefaultTransitionDuration);
+ curAnimation.AnimateTo(curTop, "PositionX", 0.0f, 0, DefaultTransitionDuration);
+ curAnimation.EndAction = Animation.EndActions.StopFinal;
+ curAnimation.Finished += (object sender, EventArgs args) =>
+ {
+ curTop.SetVisible(false);
+
+ //Invoke Page events
+ curTop.InvokeDisappeared();
+ };
+ curAnimation.Play();
+
+ page.PositionX = SizeWidth;
+ page.SetVisible(true);
+ // Set Content visible because it was hidden by HideContentOfPage.
+ (page as ContentPage)?.Content?.SetVisible(true);
+
+ newAnimation = new Animation(DefaultTransitionDuration);
+ newAnimation.AnimateTo(page, "PositionX", 0.0f, 0, DefaultTransitionDuration);
+ newAnimation.EndAction = Animation.EndActions.StopFinal;
+ newAnimation.Finished += (object sender, EventArgs e) =>
+ {
+ // Need to update Content of the new page
+ ShowContentOfPage(page);
+
+ //Invoke Page events
+ page.InvokeAppeared();
+ NotifyAccessibilityStatesChangeOfPages(curTop, page);
+
+ page.RestoreKeyFocus();
+ };
+ newAnimation.Play();
}
- _newAnimation = new Animation(1000);
- using (var scaleVec = new Vector3(1.0f, 1.0f, 1.0f))
+ else
{
- _newAnimation.AnimateTo(page, "Scale", scaleVec, 0, 1000);
+ ShowContentOfPage(page);
+ page.RestoreKeyFocus();
}
- _newAnimation.AnimateTo(page, "Opacity", 1.0f, 0, 1000);
- _newAnimation.Play();
}
/// <summary>
/// </summary>
/// <returns>The popped page.</returns>
/// <exception cref="InvalidOperationException">Thrown when there is no page in Navigator.</exception>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
public Page Pop()
{
- if (NavigationPages.Count == 0)
+ if (!transitionFinished)
+ {
+ Tizen.Log.Error("NUI", "Transition is still not finished.\n");
+ return null;
+ }
+
+ if (navigationPages.Count == 0)
{
throw new InvalidOperationException("There is no page in Navigator.");
}
+ //TODO: The following transition codes will be replaced with view transition.
+ InitializeAnimation();
+
var curTop = Peek();
- if (NavigationPages.Count == 1)
+ if (navigationPages.Count == 1)
{
Remove(curTop);
+
+ //Invoke Popped event
+ Popped?.Invoke(this, new PoppedEventArgs() { Page = curTop });
+
return curTop;
}
- var newTop = NavigationPages[NavigationPages.Count - 2];
+ var newTop = navigationPages[navigationPages.Count - 2];
//Invoke Page events
newTop.InvokeAppearing();
curTop.InvokeDisappearing();
+ curTop.SaveKeyFocus();
- //TODO: The following transition codes will be replaced with view transition.
- if (_curAnimation)
+ if (curTop is DialogPage == false)
{
- _curAnimation.Stop();
- _curAnimation.Clear();
- }
+ curAnimation = new Animation(DefaultTransitionDuration);
+ curAnimation.AnimateTo(curTop, "PositionX", SizeWidth, 0, DefaultTransitionDuration);
+ curAnimation.EndAction = Animation.EndActions.StopFinal;
+ curAnimation.Finished += (object sender, EventArgs e) =>
+ {
+ //Removes the current top page after transition is finished.
+ Remove(curTop);
- if (_newAnimation)
- {
- _newAnimation.Stop();
- _newAnimation.Clear();
- }
+ curTop.PositionX = 0.0f;
- _curAnimation = new Animation(1000);
- using (var scaleVec = new Vector3(0.0f, 0.0f, 1.0f))
- {
- _curAnimation.AnimateTo(curTop, "Scale", scaleVec, 0, 1000);
+ //Invoke Page events
+ curTop.InvokeDisappeared();
+
+ //Invoke Popped event
+ Popped?.Invoke(this, new PoppedEventArgs() { Page = curTop });
+ };
+ curAnimation.Play();
+
+ newTop.SetVisible(true);
+ // Set Content visible because it was hidden by HideContentOfPage.
+ (newTop as ContentPage)?.Content?.SetVisible(true);
+
+ newAnimation = new Animation(DefaultTransitionDuration);
+ newAnimation.AnimateTo(newTop, "PositionX", 0.0f, 0, DefaultTransitionDuration);
+ newAnimation.EndAction = Animation.EndActions.StopFinal;
+ newAnimation.Finished += (object sender, EventArgs e) =>
+ {
+ // Need to update Content of the new page
+ ShowContentOfPage(newTop);
+
+ //Invoke Page events
+ newTop.InvokeAppeared();
+
+ newTop.RestoreKeyFocus();
+ };
+ newAnimation.Play();
}
- _curAnimation.AnimateTo(curTop, "Opacity", 0.0f, 0, 1000);
- _curAnimation.Play();
- _curAnimation.Finished += (object sender, EventArgs e) =>
+ else
{
- //Removes the current top page after transition is finished.
Remove(curTop);
- };
+ newTop.RestoreKeyFocus();
+ }
+
+ return curTop;
+ }
- using (var scaleVec = new Vector3(0.0f, 0.0f, 1.0f))
+ /// <summary>
+ /// Returns the page of the given index in Navigator.
+ /// The indices of pages in Navigator are basically the order of pushing or inserting to Navigator.
+ /// So a page's index in Navigator can be changed whenever push/insert or pop/remove occurs.
+ /// </summary>
+ /// <param name="index">The index of a page in Navigator.</param>
+ /// <returns>The page of the given index in Navigator.</returns>
+ /// <exception cref="ArgumentOutOfRangeException">Thrown when the argument index is less than 0, or greater than the number of pages.</exception>
+ public Page GetPage(int index)
+ {
+ if ((index < 0) || (index > navigationPages.Count))
{
- using (var scaleProp = new Tizen.NUI.PropertyValue(scaleVec))
- {
- Tizen.NUI.Object.SetProperty(newTop.SwigCPtr, Page.Property.SCALE, scaleProp);
- }
+ throw new ArgumentOutOfRangeException(nameof(index), "index should be greater than or equal to 0, and less than or equal to the number of pages.");
}
- using (var opacityProp = new Tizen.NUI.PropertyValue(0.0f))
+
+ return navigationPages[index];
+ }
+
+ /// <summary>
+ /// Returns the current index of the given page in Navigator.
+ /// The indices of pages in Navigator are basically the order of pushing or inserting to Navigator.
+ /// So a page's index in Navigator can be changed whenever push/insert or pop/remove occurs.
+ /// </summary>
+ /// <param name="page">The page in Navigator.</param>
+ /// <returns>The index of the given page in Navigator. If the given page is not in the Navigator, then -1 is returned.</returns>
+ /// <exception cref="ArgumentNullException">Thrown when the argument page is null.</exception>
+ /// <since_tizen> 9 </since_tizen>
+ public int IndexOf(Page page)
+ {
+ if (page == null)
{
- Tizen.NUI.Object.SetProperty(newTop.SwigCPtr, Page.Property.OPACITY, opacityProp);
+ throw new ArgumentNullException(nameof(page), "page should not be null.");
}
- _newAnimation = new Animation(1000);
- using (var scaleVec = new Vector3(1.0f, 1.0f, 1.0f))
+
+ for (int i = 0; i < navigationPages.Count; i++)
{
- _newAnimation.AnimateTo(newTop, "Scale", scaleVec, 0, 1000);
+ if (navigationPages[i] == page)
+ {
+ return i;
+ }
}
- _newAnimation.AnimateTo(newTop, "Opacity", 1.0f, 0, 1000);
- _newAnimation.Play();
- return curTop;
+ return -1;
}
/// <summary>
/// Inserts a page at the specified index of Navigator.
+ /// The indices of pages in Navigator are basically the order of pushing or inserting to Navigator.
+ /// So a page's index in Navigator can be changed whenever push/insert or pop/remove occurs.
+ /// To find the current index of a page in Navigator, please use IndexOf(page).
/// If the page is already in Navigator, then it is not inserted.
/// </summary>
- /// <param name="index">The index of Navigator where a page will be inserted.</param>
+ /// <param name="index">The index of a page in Navigator where the page will be inserted.</param>
/// <param name="page">The page to insert to Navigator.</param>
/// <exception cref="ArgumentOutOfRangeException">Thrown when the argument index is less than 0, or greater than the number of pages.</exception>
/// <exception cref="ArgumentNullException">Thrown when the argument page is null.</exception>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
public void Insert(int index, Page page)
{
- if ((index < 0) || (index > NavigationPages.Count))
+ if ((index < 0) || (index > navigationPages.Count))
{
throw new ArgumentOutOfRangeException(nameof(index), "index should be greater than or equal to 0, and less than or equal to the number of pages.");
}
}
//Duplicate page is not pushed.
- if (NavigationPages.Contains(page)) return;
+ if (navigationPages.Contains(page)) return;
- NavigationPages.Insert(index, page);
+ //TODO: The following transition codes will be replaced with view transition.
+ InitializeAnimation();
+
+ ShowContentOfPage(page);
+
+ if (index == PageCount)
+ {
+ page.SetVisible(true);
+ }
+ else
+ {
+ page.SetVisible(false);
+ }
+
+ navigationPages.Insert(index, page);
Add(page);
+ page.SiblingOrder = index;
+ page.Navigator = this;
+ if (index == PageCount - 1)
+ {
+ if (PageCount > 1)
+ {
+ NotifyAccessibilityStatesChangeOfPages(navigationPages[PageCount - 2], page);
+ }
+ else
+ {
+ NotifyAccessibilityStatesChangeOfPages(null, page);
+ }
+ }
}
/// <summary>
/// <exception cref="ArgumentNullException">Thrown when the argument before is null.</exception>
/// <exception cref="ArgumentNullException">Thrown when the argument page is null.</exception>
/// <exception cref="ArgumentException">Thrown when the argument before does not exist in Navigator.</exception>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
public void InsertBefore(Page before, Page page)
{
if (before == null)
}
//Find the index of before page.
- int beforeIndex = NavigationPages.FindIndex(x => x == before);
+ int beforeIndex = navigationPages.FindIndex(x => x == before);
//before does not exist in Navigator.
if (beforeIndex == -1)
/// </summary>
/// <param name="page">The page to remove from Navigator.</param>
/// <exception cref="ArgumentNullException">Thrown when the argument page is null.</exception>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
public void Remove(Page page)
{
if (page == null)
throw new ArgumentNullException(nameof(page), "page should not be null.");
}
- NavigationPages.Remove(page);
+ //TODO: The following transition codes will be replaced with view transition.
+ InitializeAnimation();
+
+ HideContentOfPage(page);
+
+ if (page == Peek())
+ {
+ if (PageCount >= 2)
+ {
+ navigationPages[PageCount - 2].SetVisible(true);
+ NotifyAccessibilityStatesChangeOfPages(page, navigationPages[PageCount - 2]);
+ }
+ else if (PageCount == 1)
+ {
+ NotifyAccessibilityStatesChangeOfPages(page, null);
+ }
+ }
+ page.Navigator = null;
+ navigationPages.Remove(page);
base.Remove(page);
}
/// <summary>
/// Removes a page at the specified index of Navigator.
+ /// The indices of pages in Navigator are basically the order of pushing or inserting to Navigator.
+ /// So a page's index in Navigator can be changed whenever push/insert or pop/remove occurs.
+ /// To find the current index of a page in Navigator, please use IndexOf(page).
/// </summary>
- /// <param name="index">The index of Navigator where a page will be removed.</param>
+ /// <param name="index">The index of a page in Navigator where the page will be removed.</param>
/// <exception cref="ArgumentOutOfRangeException">Thrown when the index is less than 0, or greater than or equal to the number of pages.</exception>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
public void RemoveAt(int index)
{
- if ((index < 0) || (index >= NavigationPages.Count))
+ if ((index < 0) || (index >= navigationPages.Count))
{
throw new ArgumentOutOfRangeException(nameof(index), "index should be greater than or equal to 0, and less than the number of pages.");
}
- Remove(NavigationPages[index]);
+ Remove(navigationPages[index]);
}
/// <summary>
/// Returns the page at the top of Navigator.
/// </summary>
/// <returns>The page at the top of Navigator.</returns>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
public Page Peek()
{
- if (NavigationPages.Count == 0) return null;
+ if (navigationPages.Count == 0) return null;
+
+ return navigationPages[navigationPages.Count - 1];
+ }
+
+ /// <summary>
+ /// Gets or sets if Navigator proceeds back navigation when back button or back key is pressed and released.
+ /// Back navigation pops the peek page if Navigator has more than one page.
+ /// If Navigator has only one page, then the current program is exited.
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool EnableBackNavigation
+ {
+ get
+ {
+ return (bool)GetValue(EnableBackNavigationProperty);
+ }
+ set
+ {
+ SetValue(EnableBackNavigationProperty, value);
+ NotifyPropertyChanged();
+ }
+ }
- return NavigationPages[NavigationPages.Count - 1];
+ private bool InternalEnableBackNavigation
+ {
+ set
+ {
+ enableBackNavigation = value;
+ }
+ get
+ {
+ return enableBackNavigation;
+ }
}
/// <summary>
if (type == DisposeTypes.Explicit)
{
- foreach (Page page in NavigationPages)
+ foreach (Page page in navigationPages)
{
Utility.Dispose(page);
}
- NavigationPages.Clear();
+ navigationPages.Clear();
Window window;
navigatorWindow.Remove(this);
windowNavigator.Remove(window);
}
+
+ AddedToWindow -= OnAddedToWindow;
+ RemovedFromWindow -= OnRemovedFromWindow;
}
base.Dispose(type);
/// </summary>
/// <returns>The default navigator of the given window.</returns>
/// <exception cref="ArgumentNullException">Thrown when the argument window is null.</exception>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
public static Navigator GetDefaultNavigator(Window window)
{
if (window == null)
}
/// <summary>
- /// Shows a dialog by pushing a page containing dialog to default navigator.
+ /// Sets the default navigator of the given window.
+ /// SetDefaultNavigator does not remove the previous default navigator from the window.
+ /// Therefore, if a user does not want to show the previous default navigator, then it should be removed from the window manually.
/// </summary>
- /// <param name="content">The content of Dialog.</param>
+ /// <exception cref="ArgumentNullException">Thrown when the argument window is null.</exception>
+ /// <exception cref="ArgumentNullException">Thrown when the argument newNavigator is null.</exception>
[EditorBrowsable(EditorBrowsableState.Never)]
- [SuppressMessage("Microsoft.Reliability",
- "CA2000:DisposeObjectsBeforeLosingScope",
- Justification = "The pushed views are added to NavigationPages and are disposed in Navigator.Dispose().")]
- public static void ShowDialog(View content = null)
+ public static void SetDefaultNavigator(Window window, Navigator newNavigator)
{
- var window = NUIApplication.GetDefaultWindow();
- var defaultNavigator = window.GetDefaultNavigator();
+ if (window == null)
+ {
+ throw new ArgumentNullException(nameof(window), "window should not be null.");
+ }
+
+ if (newNavigator == null)
+ {
+ throw new ArgumentNullException(nameof(newNavigator), "newNavigator should not be null.");
+ }
- var dialog = new Dialog(content);
- SetDialogScrim(dialog);
+ if (windowNavigator.ContainsKey(window) == true)
+ {
+ var oldNavigator = windowNavigator[window];
+ if (oldNavigator == newNavigator)
+ {
+ return;
+ }
+
+ navigatorWindow.Remove(oldNavigator);
+ windowNavigator.Remove(window);
+ }
- var dialogPage = new Page(dialog);
- defaultNavigator.Push(dialogPage);
+ window.Add(newNavigator);
+ windowNavigator.Add(window, newNavigator);
+ navigatorWindow.Add(newNavigator, window);
}
/// <summary>
- /// Shows an alert dialog by pushing a page containing the alert dialog
- /// to default navigator.
+ /// Called when the back navigation is started.
+ /// Back navigation pops the peek page if Navigator has more than one page.
+ /// If Navigator has only one page, then the current program is exited.
/// </summary>
- /// <param name="titleContent">The title content of AlertDialog.</param>
- /// <param name="content">The content of AlertDialog.</param>
- /// <param name="actionContent">The action content of AlertDialog.</param>
+ /// <param name="eventArgs">The back navigation information.</param>
[EditorBrowsable(EditorBrowsableState.Never)]
- [SuppressMessage("Microsoft.Reliability",
- "CA2000:DisposeObjectsBeforeLosingScope",
- Justification = "The pushed views are added to NavigationPages and are disposed in Navigator.Dispose().")]
- public static void ShowAlertDialog(View titleContent, View content, View actionContent)
+ protected virtual void OnBackNavigation(BackNavigationEventArgs eventArgs)
{
- var window = NUIApplication.GetDefaultWindow();
- var defaultNavigator = window.GetDefaultNavigator();
-
- var dialog = new AlertDialog(titleContent, content, actionContent);
- SetDialogScrim(dialog);
+ if (PageCount >= 1)
+ {
+ if (Peek().EnableBackNavigation)
+ {
+ Peek().NavigateBack();
+ }
+ }
+ else
+ {
+ NUIApplication.Current?.Exit();
+ }
+ }
- var dialogPage = new Page(dialog);
- defaultNavigator.Push(dialogPage);
+ /// <summary>
+ /// Called when the back navigation is required outside Navigator.
+ /// </summary>
+ internal void NavigateBack()
+ {
+ OnBackNavigation(new BackNavigationEventArgs());
}
/// <summary>
- /// Shows an alert dialog by pushing a page containing the alert dialog
- /// to default navigator.
+ /// Create Transitions between currentTopPage and newTopPage
/// </summary>
- /// <param name="title">The title of AlertDialog.</param>
- /// <param name="message">The message of AlertDialog.</param>
- /// <param name="positiveButtonText">The positive button text in the action content of AlertDialog.</param>
- /// <param name="positiveButtonClickedHandler">The clicked callback of the positive button in the action content of AlertDialog.</param>
- /// <param name="negativeButtonText">The negative button text in the action content of AlertDialog.</param>
- /// <param name="negativeButtonClickedHandler">The clicked callback of the negative button in the action content of AlertDialog.</param>
- [EditorBrowsable(EditorBrowsableState.Never)]
- [SuppressMessage("Microsoft.Reliability",
- "CA2000:DisposeObjectsBeforeLosingScope",
- Justification = "The pushed views are added to NavigationPages and are disposed in Navigator.Dispose().")]
- public static void ShowAlertDialog(string title = null, string message = null, string positiveButtonText = null, EventHandler<ClickedEventArgs> positiveButtonClickedHandler = null, string negativeButtonText = null, EventHandler<ClickedEventArgs> negativeButtonClickedHandler = null)
+ /// <param name="currentTopPage">The top page of Navigator.</param>
+ /// <param name="newTopPage">The new top page after transition.</param>
+ /// <param name="pushTransition">True if this transition is for push new page</param>
+ private TransitionSet CreateTransitions(Page currentTopPage, Page newTopPage, bool pushTransition)
{
- var window = NUIApplication.GetDefaultWindow();
- var defaultNavigator = window.GetDefaultNavigator();
+ currentTopPage.SetVisible(true);
+ // Set Content visible because it was hidden by HideContentOfPage.
+ (currentTopPage as ContentPage)?.Content?.SetVisible(true);
- var dialog = new AlertDialog(title, message, positiveButtonText, positiveButtonClickedHandler, negativeButtonText, negativeButtonClickedHandler);
- SetDialogScrim(dialog);
+ newTopPage.SetVisible(true);
+ // Set Content visible because it was hidden by HideContentOfPage.
+ (newTopPage as ContentPage)?.Content?.SetVisible(true);
- var dialogPage = new Page(dialog);
- defaultNavigator.Push(dialogPage);
+ List<View> taggedViewsInNewTopPage = new List<View>();
+ RetrieveTaggedViews(taggedViewsInNewTopPage, newTopPage, true);
+ List<View> taggedViewsInCurrentTopPage = new List<View>();
+ RetrieveTaggedViews(taggedViewsInCurrentTopPage, currentTopPage, true);
+
+ List<KeyValuePair<View, View>> sameTaggedViewPair = new List<KeyValuePair<View, View>>();
+ foreach (View currentTopPageView in taggedViewsInCurrentTopPage)
+ {
+ bool findPair = false;
+ foreach (View newTopPageView in taggedViewsInNewTopPage)
+ {
+ if ((currentTopPageView.TransitionOptions != null) && (newTopPageView.TransitionOptions != null) &&
+ currentTopPageView.TransitionOptions?.TransitionTag == newTopPageView.TransitionOptions?.TransitionTag)
+ {
+ sameTaggedViewPair.Add(new KeyValuePair<View, View>(currentTopPageView, newTopPageView));
+ findPair = true;
+ break;
+ }
+ }
+ if (findPair)
+ {
+ taggedViewsInNewTopPage.Remove(sameTaggedViewPair[sameTaggedViewPair.Count - 1].Value);
+ }
+ }
+ foreach (KeyValuePair<View, View> pair in sameTaggedViewPair)
+ {
+ taggedViewsInCurrentTopPage.Remove(pair.Key);
+ }
+
+ TransitionSet newTransitionSet = new TransitionSet();
+ foreach (KeyValuePair<View, View> pair in sameTaggedViewPair)
+ {
+ TransitionItem pairTransition = transition.CreateTransition(pair.Key, pair.Value, pushTransition);
+ if (pair.Value.TransitionOptions?.TransitionWithChild ?? false)
+ {
+ pairTransition.TransitionWithChild = true;
+ }
+ newTransitionSet.AddTransition(pairTransition);
+ }
+
+ newTransitionSet.Finished += (object sender, EventArgs e) =>
+ {
+ if (newTopPage.Layout != null)
+ {
+ newTopPage.Layout.RequestLayout();
+ }
+ if (currentTopPage.Layout != null)
+ {
+ currentTopPage.Layout.RequestLayout();
+ }
+ transitionFinished = true;
+ InvokeTransitionFinished();
+ transitionSet.Dispose();
+ };
+
+ if (!pushTransition || newTopPage is DialogPage == false)
+ {
+ View transitionView = currentTopPage;
+ if (currentTopPage is ContentPage)
+ {
+ transitionView = (currentTopPage as ContentPage).Content;
+ }
+ else if (currentTopPage is DialogPage)
+ {
+ transitionView = (currentTopPage as DialogPage).Content;
+ }
+
+ if (currentTopPage.DisappearingTransition != null && transitionView != null)
+ {
+ TransitionItemBase disappearingTransition = currentTopPage.DisappearingTransition.CreateTransition(transitionView, false);
+ disappearingTransition.TransitionWithChild = true;
+ newTransitionSet.AddTransition(disappearingTransition);
+ }
+ else
+ {
+ currentTopPage.SetVisible(false);
+ }
+ }
+ if (pushTransition || currentTopPage is DialogPage == false)
+ {
+ View transitionView = newTopPage;
+ if (newTopPage is ContentPage)
+ {
+ transitionView = (newTopPage as ContentPage).Content;
+ }
+ else if (newTopPage is DialogPage)
+ {
+ transitionView = (newTopPage as DialogPage).Content;
+ }
+
+ if (newTopPage.AppearingTransition != null && transitionView != null)
+ {
+ TransitionItemBase appearingTransition = newTopPage.AppearingTransition.CreateTransition(transitionView, true);
+ appearingTransition.TransitionWithChild = true;
+ newTransitionSet.AddTransition(appearingTransition);
+ }
+ }
+
+ newTransitionSet.Play();
+
+ return newTransitionSet;
}
+ /// <summary>
+ /// Retrieve Tagged Views in the view tree.
+ /// </summary>
+ /// <param name="taggedViews">Returned tagged view list..</param>
+ /// <param name="view">Root View to get tagged child View.</param>
+ /// <param name="isRoot">Flag to check current View is page or not</param>
+ private void RetrieveTaggedViews(List<View> taggedViews, View view, bool isRoot)
+ {
+ if (!isRoot && view.TransitionOptions != null)
+ {
+ if (!string.IsNullOrEmpty(view.TransitionOptions?.TransitionTag))
+ {
+ taggedViews.Add((view as View));
+ if (view.TransitionOptions.TransitionWithChild)
+ {
+ return;
+ }
+ }
+
+ }
+
+ foreach (View child in view.Children)
+ {
+ RetrieveTaggedViews(taggedViews, child, false);
+ }
+ }
- private static void SetDialogScrim(Dialog dialog)
+ /// <summary>
+ /// Notify accessibility states change of pages.
+ /// </summary>
+ /// <param name="disappearedPage">Disappeared page</param>
+ /// <param name="appearedPage">Appeared page</param>
+ private void NotifyAccessibilityStatesChangeOfPages(Page disappearedPage, Page appearedPage)
{
- if (dialog == null)
+ if (disappearedPage != null)
{
- return;
+ disappearedPage.UnregisterDefaultLabel();
+ //We can call disappearedPage.NotifyAccessibilityStatesChange
+ //To reduce accessibility events, we are using currently highlighted view instead
+ View curHighlightedView = Accessibility.Accessibility.GetCurrentlyHighlightedView();
+ if (curHighlightedView != null)
+ {
+ curHighlightedView.NotifyAccessibilityStatesChange(new AccessibilityStates(AccessibilityState.Visible, AccessibilityState.Showing), AccessibilityStatesNotifyMode.Single);
+ }
+ }
+
+ if (appearedPage != null)
+ {
+ appearedPage.RegisterDefaultLabel();
+ appearedPage.NotifyAccessibilityStatesChange(new AccessibilityStates(AccessibilityState.Visible, AccessibilityState.Showing), AccessibilityStatesNotifyMode.Single);
}
+ }
+
+ internal void InvokeTransitionFinished()
+ {
+ TransitionFinished?.Invoke(this, new EventArgs());
+ }
- var window = NUIApplication.GetDefaultWindow();
- var defaultNavigator = window.GetDefaultNavigator();
- var defaultScrim = dialog.Scrim;
+ //TODO: The following transition codes will be replaced with view transition.
+ private void InitializeAnimation()
+ {
+ bool isCurAnimPlaying = false;
+ bool isNewAnimPlaying = false;
- //Copies default scrim's GUI properties.
- var scrim = new VisualView();
- scrim.BackgroundColor = defaultScrim.BackgroundColor;
- scrim.Size = defaultScrim.Size;
- scrim.TouchEvent += (object source, View.TouchEventArgs e) =>
+ if (curAnimation != null)
{
- if (e.Touch.GetState(0) == PointStateType.Up)
+ if (curAnimation.State == Animation.States.Playing)
{
- defaultNavigator.Pop();
+ isCurAnimPlaying = true;
+ curAnimation.Stop();
}
+ }
- return true;
- };
+ if (newAnimation != null)
+ {
+ if (newAnimation.State == Animation.States.Playing)
+ {
+ isNewAnimPlaying = true;
+ newAnimation.Stop();
+ }
+ }
+
+ if (isCurAnimPlaying)
+ {
+ // To enable multiple Pop(), animation's Finished callback is required.
+ // To call animation's Finished callback, FinishedSignal is emitted.
+ curAnimation.FinishedSignal().Emit(curAnimation);
+ curAnimation.Clear();
+
+ // InitializeAnimation() can be called by FinishedSignal().Emit().
+ // Not to cause null pointer dereference by calling InitializeAnimation() in InitializeAnimation(),
+ // animation handle is assigned to be null only if the animation is playing.
+ curAnimation = null;
+ }
+
+ if (isNewAnimPlaying)
+ {
+ // To enable multiple Pop(), animation's Finished callback is required.
+ // To call animation's Finished callback, FinishedSignal is emitted.
+ newAnimation.FinishedSignal().Emit(newAnimation);
+ newAnimation.Clear();
+
+ // InitializeAnimation() can be called by FinishedSignal().Emit().
+ // Not to cause null pointer dereference by calling InitializeAnimation() in InitializeAnimation(),
+ // animation handle is assigned to be null only if the animation is playing.
+ newAnimation = null;
+ }
+ }
+
+ // Show and Register Content of Page to Accessibility bridge
+ private void ShowContentOfPage(Page page)
+ {
+ View content = (page is DialogPage) ? (page as DialogPage)?.Content : (page as ContentPage)?.Content;
+ if (content != null)
+ {
+ content.Show(); // Calls RegisterDefaultLabel()
+ }
+ }
- dialog.Scrim = scrim;
+ // Hide and Remove Content of Page from Accessibility bridge
+ private void HideContentOfPage(Page page)
+ {
+ View content = (page is DialogPage) ? (page as DialogPage)?.Content : (page as ContentPage)?.Content;
+ if (content != null)
+ {
+ content.Hide(); // Calls UnregisterDefaultLabel()
+ }
}
}
-} //namespace Tizen.NUI
+
+ /// <summary>
+ /// BackNavigationEventArgs is a class to record back navigation event arguments which will sent to user.
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public class BackNavigationEventArgs : EventArgs
+ {
+ }
+}
projects / platform / core / csapi / tizenfx.git / blobdiff