src/Tizen.NUI/src/public/BaseComponents/Style/Selector.cs

   1 /*
   2  * Copyright(c) 2019 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17 using System;
  18 using System.ComponentModel;
  19 using Tizen.NUI.Binding;
  20 using Tizen.NUI.Components;
  21
  22 namespace Tizen.NUI.BaseComponents
  23 {
  24     /// <summary>
  25     /// Selector class, which is related by Control State, it is base class for other Selector.
  26     /// </summary>
  27     /// <since_tizen> 6 </since_tizen>
  28     /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
  29     [EditorBrowsable(EditorBrowsableState.Never)]
  30     public class Selector<T> : BindableObject
  31     {
  32         /// <since_tizen> 6 </since_tizen>
  33         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
  34         public static implicit operator Selector<T>(T value)
  35         {
  36             Selector<T> selector = new Selector<T>();
  37             selector.All = value;
  38             return selector;
  39         }
  40
  41         /// Default Contructor
  42         [EditorBrowsable(EditorBrowsableState.Never)]
  43         public Selector()
  44         {
  45         }
  46
  47         /// Contructor with T
  48         [EditorBrowsable(EditorBrowsableState.Never)]
  49         public Selector(T value) : this()
  50         {
  51             All = value;
  52         }
  53
  54         /// <summary>
  55         /// All State.
  56         /// </summary>
  57         /// <since_tizen> 6 </since_tizen>
  58         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
  59         [EditorBrowsable(EditorBrowsableState.Never)]
  60         public T All
  61         {
  62             get;
  63             set;
  64         }
  65         /// <summary>
  66         /// Normal State.
  67         /// </summary>
  68         /// <since_tizen> 6 </since_tizen>
  69         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
  70         [EditorBrowsable(EditorBrowsableState.Never)]
  71         public T Normal
  72         {
  73             get;
  74             set;
  75         }
  76         /// <summary>
  77         /// Pressed State.
  78         /// </summary>
  79         /// <since_tizen> 6 </since_tizen>
  80         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
  81         [EditorBrowsable(EditorBrowsableState.Never)]
  82         public T Pressed
  83         {
  84             get;
  85             set;
  86         }
  87         /// <summary>
  88         /// Focused State.
  89         /// </summary>
  90         /// <since_tizen> 6 </since_tizen>
  91         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
  92         [EditorBrowsable(EditorBrowsableState.Never)]
  93         public T Focused
  94         {
  95             get;
  96             set;
  97         }
  98         /// <summary>
  99         /// Selected State.
 100         /// </summary>
 101         /// <since_tizen> 6 </since_tizen>
 102         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 103         [EditorBrowsable(EditorBrowsableState.Never)]
 104         public T Selected
 105         {
 106             get;
 107             set;
 108         }
 109         /// <summary>
 110         /// Disabled State.
 111         /// </summary>
 112         /// <since_tizen> 6 </since_tizen>
 113         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 114         [EditorBrowsable(EditorBrowsableState.Never)]
 115         public T Disabled
 116         {
 117             get;
 118             set;
 119         }
 120         /// <summary>
 121         /// DisabledFocused State.
 122         /// </summary>
 123         /// <since_tizen> 6 </since_tizen>
 124         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 125         [EditorBrowsable(EditorBrowsableState.Never)]
 126         public T DisabledFocused
 127         {
 128             get;
 129             set;
 130         }
 131         /// <summary>
 132         /// SelectedFocused State.
 133         /// </summary>
 134         /// <since_tizen> 6 </since_tizen>
 135         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 136         public T SelectedFocused
 137         {
 138             get;
 139             set;
 140         }
 141         /// <summary>
 142         /// DisabledSelected State.
 143         /// </summary>
 144         /// <since_tizen> 6 </since_tizen>
 145         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 146         [EditorBrowsable(EditorBrowsableState.Never)]
 147         public T DisabledSelected
 148         {
 149             get;
 150             set;
 151         }
 152
 153         /// <summary>
 154         /// PressedSelected State.
 155         /// </summary>
 156         [EditorBrowsable(EditorBrowsableState.Never)]
 157         public T PressedSelected
 158         {
 159             get;
 160             set;
 161         }
 162
 163         /// <summary>
 164         /// Other State.
 165         /// </summary>
 166         /// <since_tizen> 6 </since_tizen>
 167         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 168         [EditorBrowsable(EditorBrowsableState.Never)]
 169         public T Other
 170         {
 171             get;
 172             set;
 173         }
 174         /// <summary>
 175         /// Get value by State.
 176         /// </summary>
 177         /// <since_tizen> 6 </since_tizen>
 178         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 179         [EditorBrowsable(EditorBrowsableState.Never)]
 180         public T GetValue(ControlStates state)
 181         {
 182             if(All != null)
 183             {
 184                 return All;
 185             }
 186             switch(state)
 187             {
 188                 case ControlStates.Normal:
 189                     return Normal != null? Normal : Other;
 190                 case ControlStates.Focused:
 191                     return Focused != null? Focused : Other;
 192                 case ControlStates.Pressed:
 193                     return Pressed != null? Pressed : Other;
 194                 case ControlStates.Disabled:
 195                     return Disabled != null? Disabled : Other;
 196                 case ControlStates.Selected:
 197                     return Selected != null? Selected : Other;
 198                 case ControlStates.DisabledFocused:
 199                     return DisabledFocused != null? DisabledFocused : (Disabled != null ? Disabled : Other);
 200                 case ControlStates.DisabledSelected:
 201                     return DisabledSelected != null ? DisabledSelected : (Disabled != null ? Disabled : Other);
 202                 case ControlStates.SelectedFocused:
 203                     return SelectedFocused != null ? SelectedFocused : (Selected != null ? Selected : Other);
 204                 case ControlStates.PressedSelected:
 205                     return PressedSelected != null ? PressedSelected : (Selected != null ? Selected : Other);
 206                 default:
 207                     return Other;
 208             }
 209         }
 210         /// <summary>
 211         /// Clone function.
 212         /// </summary>
 213         /// <since_tizen> 6 </since_tizen>
 214         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 215         [EditorBrowsable(EditorBrowsableState.Never)]
 216         public void Clone(Selector<T> selector)
 217         {
 218             All = selector.All;
 219             Normal = selector.Normal;
 220             Focused = selector.Focused;
 221             Pressed = selector.Pressed;
 222             Disabled = selector.Disabled;
 223             Selected = selector.Selected;
 224             DisabledSelected = selector.DisabledSelected;
 225             DisabledFocused = selector.DisabledFocused;
 226             SelectedFocused = selector.SelectedFocused;
 227             PressedSelected = selector.PressedSelected;
 228             Other = selector.Other;
 229         }
 230
 231         internal void Clone<U>(Selector<U> other) where U : T, Tizen.NUI.Internal.ICloneable
 232         {
 233             // TODO Apply constraint to the Selector (not to Clone method)
 234
 235             All = (T)(other.All)?.Clone();
 236             Normal = (T)(other.Normal)?.Clone();
 237             Focused = (T)(other.Focused)?.Clone();
 238             Pressed = (T)(other.Pressed)?.Clone();
 239             Disabled = (T)(other.Disabled)?.Clone();
 240             Selected = (T)(other.Selected)?.Clone();
 241             DisabledSelected = (T)(other.DisabledSelected)?.Clone();
 242             DisabledFocused = (T)(other.DisabledFocused)?.Clone();
 243             SelectedFocused = (T)(other.SelectedFocused)?.Clone();
 244             PressedSelected = (T)(other.PressedSelected)?.Clone();
 245             Other = (T)(other.Other)?.Clone();
 246         }
 247     }
 248
 249     /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 250     [EditorBrowsable(EditorBrowsableState.Never)]
 251     public class TriggerableSelector<T> : Selector<T>
 252     {
 253         public TriggerableSelector(View view, BindableProperty bindableProperty)
 254         {
 255             targetView = view;
 256             targetBindableProperty = bindableProperty;
 257             view.ControlStateChangeEvent += OnViewControlState;
 258         }
 259
 260         /// <summary>
 261         /// Clone function.
 262         /// </summary>
 263         /// <since_tizen> 6 </since_tizen>
 264         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 265         [EditorBrowsable(EditorBrowsableState.Never)]
 266         public new void Clone(Selector<T> selector)
 267         {
 268             base.Clone(selector);
 269
 270             if (null != targetView && null != GetValue(targetView.ControlState))
 271             {
 272                 targetView.SetValue(targetBindableProperty, GetValue(targetView.ControlState));
 273             }
 274         }
 275
 276         private void OnViewControlState(View obj, ControlStates state)
 277         {
 278             if (null != obj && null != GetValue(state))
 279             {
 280                 obj.SetValue(targetBindableProperty, GetValue(state));
 281             }
 282         }
 283
 284         private View targetView;
 285         private BindableProperty targetBindableProperty;
 286     }
 287
 288     /// <summary>
 289     /// A class that helps binding a non-selector property in View to selector property in ViewStyle.
 290     /// </summary>
 291     internal class ViewSelector<T>
 292     {
 293         protected Selector<T> selector;
 294         protected View view;
 295         protected View.ControlStateChangesDelegate controlStateChanged;
 296
 297         internal ViewSelector(View view, View.ControlStateChangesDelegate controlStateChanged)
 298         {
 299             if (view == null || controlStateChanged == null)
 300             {
 301                 throw new global::System.ArgumentNullException();
 302             }
 303             this.view = view;
 304             this.controlStateChanged = controlStateChanged;
 305             this.selector = null;
 306         }
 307
 308         internal T GetValue()
 309         {
 310             return selector == null ? default(T) : selector.GetValue(view.ControlState);
 311         }
 312
 313         internal void Set(object value)
 314         {
 315             bool hadMultiValue = HasMultiValue();
 316             var type = value?.GetType();
 317
 318             if (type == typeof(T))
 319             {
 320                 CopyValueToSelector((T)value);
 321             }
 322             else if (type == typeof(Selector<T>))
 323             {
 324                 CopySelectorToSelector((Selector<T>)value);
 325             }
 326             else if (type == Nullable.GetUnderlyingType(typeof(T)))
 327             {
 328                 CopyValueToSelector((T)value);
 329             }
 330             else
 331             {
 332                 selector = null;
 333             }
 334
 335             if (hadMultiValue != HasMultiValue())
 336             {
 337                 if (hadMultiValue) view.ControlStateChangeEvent -= controlStateChanged;
 338                 else view.ControlStateChangeEvent += controlStateChanged;
 339             }
 340         }
 341
 342         protected virtual void CopyValueToSelector(T value)
 343         {
 344             selector = new Selector<T>();
 345             selector.All = value;
 346         }
 347
 348         protected virtual void CopySelectorToSelector(Selector<T> value)
 349         {
 350             selector = new Selector<T>();
 351             selector.Clone(value);
 352         }
 353
 354         internal void Clear()
 355         {
 356             if (HasMultiValue())
 357             {
 358                 view.ControlStateChangeEvent -= controlStateChanged;
 359             }
 360             selector = null;
 361         }
 362
 363         internal bool IsEmpty()
 364         {
 365             return selector == null;
 366         }
 367
 368         protected bool HasMultiValue()
 369         {
 370             return (selector != null && selector.All == null);
 371         }
 372     }
 373
 374     /// <summary>
 375     /// ViewSelector class for ICloneable type
 376     /// </summary>
 377     internal class CloneableViewSelector<T> : ViewSelector<T> where T : Tizen.NUI.Internal.ICloneable
 378     {
 379         internal CloneableViewSelector(View view, View.ControlStateChangesDelegate controlStateChanged) : base(view, controlStateChanged)
 380         {
 381         }
 382
 383         protected override void CopyValueToSelector(T value)
 384         {
 385             selector = new Selector<T>();
 386             selector.All = (T)((T)value).Clone();
 387         }
 388
 389         protected override void CopySelectorToSelector(Selector<T> value)
 390         {
 391             selector = new Selector<T>();
 392             selector.Clone<T>((Selector<T>)value);
 393         }
 394     }
 395
 396     internal static class SelectorHelper
 397     {
 398         /// <summary>
 399         /// For the object type of T or Selector T, convert it to Selector T and return the cloned one.
 400         /// Otherwise, return null. <br/>
 401         /// </summary>
 402         static internal Selector<T> CopyCloneable<T>(object value) where T : class, Tizen.NUI.Internal.ICloneable
 403         {
 404             var type = value?.GetType();
 405
 406             if (type == typeof(Selector<T>))
 407             {
 408                 var result = new Selector<T>();
 409                 result.Clone<T>((Selector<T>)value);
 410                 return result;
 411             }
 412
 413             if (type == typeof(T))
 414             {
 415                 return new Selector<T>((T)((T)value).Clone());
 416             }
 417
 418             return null;
 419         }
 420
 421         /// <summary>
 422         /// For the value type of T or Selector T, convert it to Selector T and return the cloned one.
 423         /// Otherwise, return null. <br/>
 424         /// </summary>
 425         static internal Selector<T> CopyValue<T>(object value)
 426         {
 427             var type = value?.GetType();
 428
 429             if (type == typeof(Selector<T>))
 430             {
 431                 var result = new Selector<T>();
 432                 result.Clone((Selector<T>)value);
 433                 return result;
 434             }
 435
 436             if (type == typeof(T))
 437             {
 438                 return new Selector<T>((T)value);
 439             }
 440
 441             return null;
 442         }
 443     }
 444 }