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         /// Other State.
 155         /// </summary>
 156         /// <since_tizen> 6 </since_tizen>
 157         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 158         [EditorBrowsable(EditorBrowsableState.Never)]
 159         public T Other
 160         {
 161             get;
 162             set;
 163         }
 164         /// <summary>
 165         /// Get value by State.
 166         /// </summary>
 167         /// <since_tizen> 6 </since_tizen>
 168         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 169         [EditorBrowsable(EditorBrowsableState.Never)]
 170         public T GetValue(ControlStates state)
 171         {
 172             if(All != null)
 173             {
 174                 return All;
 175             }
 176             switch(state)
 177             {
 178                 case ControlStates.Normal:
 179                     return Normal != null? Normal : Other;
 180                 case ControlStates.Focused:
 181                     return Focused != null? Focused : Other;
 182                 case ControlStates.Pressed:
 183                     return Pressed != null? Pressed : Other;
 184                 case ControlStates.Disabled:
 185                     return Disabled != null? Disabled : Other;
 186                 case ControlStates.Selected:
 187                     return Selected != null? Selected : Other;
 188                 case ControlStates.DisabledFocused:
 189                     return DisabledFocused != null? DisabledFocused : (Disabled != null ? Disabled : Other);
 190                 case ControlStates.DisabledSelected:
 191                     return DisabledSelected != null ? DisabledSelected : (Disabled != null ? Disabled : Other);
 192                 case ControlStates.SelectedFocused:
 193                     return SelectedFocused != null ? SelectedFocused : (Selected != null ? Selected : Other);
 194                 default:
 195                 {
 196                     // Handle combined states
 197                     if ((int)(state & ControlStates.Selected) != 0 && Selected != null)
 198                     {
 199                         return Selected;
 200                     }
 201                     else if ((int)(state & ControlStates.Pressed) != 0 && Pressed != null)
 202                     {
 203                         return Pressed;
 204                     }
 205                     return Other;
 206                 }
 207             }
 208         }
 209         /// <summary>
 210         /// Clone function.
 211         /// </summary>
 212         /// <since_tizen> 6 </since_tizen>
 213         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 214         [EditorBrowsable(EditorBrowsableState.Never)]
 215         public void Clone(Selector<T> selector)
 216         {
 217             All = selector.All;
 218             Normal = selector.Normal;
 219             Focused = selector.Focused;
 220             Pressed = selector.Pressed;
 221             Disabled = selector.Disabled;
 222             Selected = selector.Selected;
 223             DisabledSelected = selector.DisabledSelected;
 224             DisabledFocused = selector.DisabledFocused;
 225             SelectedFocused = selector.SelectedFocused;
 226             Other = selector.Other;
 227         }
 228
 229         internal void Clone<U>(Selector<U> other) where U : T, Tizen.NUI.Internal.ICloneable
 230         {
 231             // TODO Apply constraint to the Selector (not to Clone method)
 232
 233             All = (T)(other.All)?.Clone();
 234             Normal = (T)(other.Normal)?.Clone();
 235             Focused = (T)(other.Focused)?.Clone();
 236             Pressed = (T)(other.Pressed)?.Clone();
 237             Disabled = (T)(other.Disabled)?.Clone();
 238             Selected = (T)(other.Selected)?.Clone();
 239             DisabledSelected = (T)(other.DisabledSelected)?.Clone();
 240             DisabledFocused = (T)(other.DisabledFocused)?.Clone();
 241             SelectedFocused = (T)(other.SelectedFocused)?.Clone();
 242             Other = (T)(other.Other)?.Clone();
 243         }
 244
 245         internal bool HasMultiValue()
 246         {
 247             return All == null;
 248         }
 249     }
 250
 251     /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 252     [EditorBrowsable(EditorBrowsableState.Never)]
 253     public class TriggerableSelector<T> : Selector<T>
 254     {
 255         public TriggerableSelector(View view, BindableProperty bindableProperty)
 256         {
 257             targetView = view;
 258             targetBindableProperty = bindableProperty;
 259             view.ControlStateChangeEvent += OnViewControlState;
 260         }
 261
 262         /// <summary>
 263         /// Clone function.
 264         /// </summary>
 265         /// <since_tizen> 6 </since_tizen>
 266         /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 267         [EditorBrowsable(EditorBrowsableState.Never)]
 268         public new void Clone(Selector<T> selector)
 269         {
 270             base.Clone(selector);
 271
 272             if (null != targetView && null != GetValue(targetView.ControlState))
 273             {
 274                 targetView.SetValue(targetBindableProperty, GetValue(targetView.ControlState));
 275             }
 276         }
 277
 278         private void OnViewControlState(View obj, View.ControlStateChagedInfo controlStateChangedInfo)
 279         {
 280             if (null != obj && null != GetValue(controlStateChangedInfo.CurrentState))
 281             {
 282                 obj.SetValue(targetBindableProperty, GetValue(controlStateChangedInfo.CurrentState));
 283             }
 284         }
 285
 286         private View targetView;
 287         private BindableProperty targetBindableProperty;
 288     }
 289
 290     /// <summary>
 291     /// A class that helps binding a non-selector property in View to selector property in ViewStyle.
 292     /// </summary>
 293     internal class ViewSelector<T>
 294     {
 295         protected Selector<T> selector;
 296         protected View view;
 297         protected View.ControlStateChangesDelegate controlStateChanged;
 298
 299         internal ViewSelector(View view, View.ControlStateChangesDelegate controlStateChanged)
 300         {
 301             if (view == null || controlStateChanged == null)
 302             {
 303                 throw new global::System.ArgumentNullException();
 304             }
 305             this.view = view;
 306             this.controlStateChanged = controlStateChanged;
 307             this.selector = null;
 308         }
 309
 310         internal T GetValue()
 311         {
 312             return selector == null ? default(T) : selector.GetValue(view.ControlState);
 313         }
 314
 315         internal void Set(object value)
 316         {
 317             bool hadMultiValue = HasMultiValue();
 318             var type = value?.GetType();
 319
 320             if (type == typeof(T))
 321             {
 322                 CopyValueToSelector((T)value);
 323             }
 324             else if (type == typeof(Selector<T>))
 325             {
 326                 CopySelectorToSelector((Selector<T>)value);
 327             }
 328             else if (type == Nullable.GetUnderlyingType(typeof(T)))
 329             {
 330                 CopyValueToSelector((T)value);
 331             }
 332             else
 333             {
 334                 selector = null;
 335             }
 336
 337             if (hadMultiValue != HasMultiValue())
 338             {
 339                 if (hadMultiValue) view.ControlStateChangeEvent -= controlStateChanged;
 340                 else view.ControlStateChangeEvent += controlStateChanged;
 341             }
 342         }
 343
 344         protected virtual void CopyValueToSelector(T value)
 345         {
 346             selector = new Selector<T>();
 347             selector.All = value;
 348         }
 349
 350         protected virtual void CopySelectorToSelector(Selector<T> value)
 351         {
 352             selector = new Selector<T>();
 353             selector.Clone(value);
 354         }
 355
 356         internal void Clear()
 357         {
 358             if (HasMultiValue())
 359             {
 360                 view.ControlStateChangeEvent -= controlStateChanged;
 361             }
 362             selector = null;
 363         }
 364
 365         internal bool IsEmpty()
 366         {
 367             return selector == null;
 368         }
 369
 370         protected bool HasMultiValue()
 371         {
 372             return (selector != null && selector.All == null);
 373         }
 374     }
 375
 376     /// <summary>
 377     /// ViewSelector class for ICloneable type
 378     /// </summary>
 379     internal class CloneableViewSelector<T> : ViewSelector<T> where T : Tizen.NUI.Internal.ICloneable
 380     {
 381         internal CloneableViewSelector(View view, View.ControlStateChangesDelegate controlStateChanged) : base(view, controlStateChanged)
 382         {
 383         }
 384
 385         protected override void CopyValueToSelector(T value)
 386         {
 387             selector = new Selector<T>();
 388             selector.All = (T)((T)value).Clone();
 389         }
 390
 391         protected override void CopySelectorToSelector(Selector<T> value)
 392         {
 393             selector = new Selector<T>();
 394             selector.Clone<T>((Selector<T>)value);
 395         }
 396     }
 397
 398     internal static class SelectorHelper
 399     {
 400         /// <summary>
 401         /// For the object type of T or Selector T, convert it to Selector T and return the cloned one.
 402         /// Otherwise, return null. <br/>
 403         /// </summary>
 404         static internal Selector<T> CopyCloneable<T>(object value) where T : class, Tizen.NUI.Internal.ICloneable
 405         {
 406             var type = value?.GetType();
 407
 408             if (type == typeof(Selector<T>))
 409             {
 410                 var result = new Selector<T>();
 411                 result.Clone<T>((Selector<T>)value);
 412                 return result;
 413             }
 414
 415             if (type == typeof(T))
 416             {
 417                 return new Selector<T>((T)((T)value).Clone());
 418             }
 419
 420             return null;
 421         }
 422
 423         /// <summary>
 424         /// For the value type of T or Selector T, convert it to Selector T and return the cloned one.
 425         /// Otherwise, return null. <br/>
 426         /// </summary>
 427         static internal Selector<T> CopyValue<T>(object value)
 428         {
 429             var type = value?.GetType();
 430
 431             if (type == typeof(Selector<T>))
 432             {
 433                 var result = new Selector<T>();
 434                 result.Clone((Selector<T>)value);
 435                 return result;
 436             }
 437
 438             if (type == typeof(T))
 439             {
 440                 return new Selector<T>((T)value);
 441             }
 442
 443             return null;
 444         }
 445     }
 446 }