2 * Copyright(c) 2019 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 using System.ComponentModel;
19 using Tizen.NUI.BaseComponents;
20 using Tizen.NUI.Components.Extension;
22 namespace Tizen.NUI.Components
25 /// Switch is one kind of common component, it can be used as selector.
26 /// User can handle Navigation by adding/inserting/deleting NavigationItem.
28 /// <since_tizen> 6 </since_tizen>
29 public class Switch : Button
31 private ImageView track = null;
32 private ImageView thumb = null;
37 /// Creates a new instance of a Switch.
39 /// <since_tizen> 6 </since_tizen>
40 public Switch() : base()
46 /// Creates a new instance of a Switch with style.
48 /// <param name="style">Create Switch by special style defined in UX.</param>
49 /// <since_tizen> 8 </since_tizen>
50 public Switch(string style) : base(style)
56 /// Creates a new instance of a Switch with style.
58 /// <param name="switchStyle">Create Switch by style customized by user.</param>
59 /// <since_tizen> 8 </since_tizen>
60 public Switch(SwitchStyle switchStyle) : base(switchStyle)
66 /// An event for the item selected signal which can be used to subscribe or unsubscribe the event handler provided by the user.<br />
68 /// <since_tizen> 6 </since_tizen>
69 public event EventHandler<SelectEventArgs> SelectedEvent;
72 /// Get style of switch.
74 /// <since_tizen> 8 </since_tizen>
75 public new SwitchStyle Style => ViewStyle as SwitchStyle;
78 /// Apply style to switch.
80 /// <param name="viewStyle">The style to apply.</param>
81 [EditorBrowsable(EditorBrowsableState.Never)]
82 public override void ApplyStyle(ViewStyle viewStyle)
84 base.ApplyStyle(viewStyle);
86 SwitchStyle swStyle = viewStyle as SwitchStyle;
90 if (swStyle.Track != null)
92 Track.ApplyStyle(swStyle.Track);
95 if (swStyle.Thumb != null)
97 Thumb.ApplyStyle(swStyle.Thumb);
103 /// Switch's track part.
105 /// <since_tizen> 8 </since_tizen>
106 public ImageView Track
112 track = new ImageView()
114 PositionUsesPivotPoint = true,
115 ParentOrigin = Tizen.NUI.ParentOrigin.CenterLeft,
116 PivotPoint = Tizen.NUI.PivotPoint.CenterLeft,
117 WidthResizePolicy = ResizePolicyType.FillToParent,
118 HeightResizePolicy = ResizePolicyType.FillToParent
121 var extension = (SwitchExtension)Extension;
122 if (extension != null)
124 track = extension.OnCreateTrack(this, track);
137 /// Switch's thumb part.
139 /// <since_tizen> 8 </since_tizen>
140 public ImageView Thumb
146 thumb = new ImageView()
148 PositionUsesPivotPoint = true,
149 ParentOrigin = Tizen.NUI.ParentOrigin.CenterLeft,
150 PivotPoint = Tizen.NUI.PivotPoint.CenterLeft,
151 WidthResizePolicy = ResizePolicyType.Fixed,
152 HeightResizePolicy = ResizePolicyType.Fixed
155 var extension = (SwitchExtension)Extension;
156 if (extension != null)
158 thumb = extension.OnCreateThumb(this, thumb);
171 /// Background image's resource url selector in Switch.
173 /// <since_tizen> 6 </since_tizen>
174 public StringSelector SwitchBackgroundImageURLSelector
178 StringSelector strSl = new StringSelector();
179 strSl.Clone(Style?.Track?.ResourceUrl);
184 if (null != value && null != Style?.Track)
186 Style.Track.ResourceUrl = value;
192 /// Handler image's resource url in Switch.
194 /// <since_tizen> 6 </since_tizen>
195 public string SwitchHandlerImageURL
199 return Style?.Thumb?.ResourceUrl?.All;
203 if (null != value && null != Style?.Thumb)
205 Style.Thumb.ResourceUrl = value;
211 /// Handler image's resource url selector in Switch.
213 /// <since_tizen> 6 </since_tizen>
214 public StringSelector SwitchHandlerImageURLSelector
218 StringSelector strSl = new StringSelector();
219 strSl.Clone(Style?.Thumb?.ResourceUrl);
224 if (null != value && null != Style?.Thumb)
226 Style.Thumb.ResourceUrl = value;
232 /// Handler image's size in Switch.
234 /// <since_tizen> 6 </since_tizen>
235 public Size SwitchHandlerImageSize
239 return Style?.Thumb?.Size;
243 if (null != Style?.Thumb)
245 Style.Thumb.Size = value;
251 /// Dispose Switch and all children on it.
253 /// <param name="type">Dispose type.</param>
254 /// <since_tizen> 6 </since_tizen>
255 protected override void Dispose(DisposeTypes type)
257 if (disposed) return;
259 if (type == DisposeTypes.Explicit)
261 Utility.Dispose(Thumb);
262 Utility.Dispose(Track);
269 /// Called after a key event is received by the view that has had its focus set.
271 /// <param name="key">The key event.</param>
272 /// <returns>True if the key event should be consumed.</returns>
273 /// <since_tizen> 8 </since_tizen>
274 public override bool OnKey(Key key)
276 if (!IsEnabled || null == key) return false;
278 bool ret = base.OnKey(key);
279 if (key.State == Key.StateType.Up)
281 if (key.KeyPressedName == "Return")
291 /// Called after a touch event is received by the owning view.<br />
292 /// CustomViewBehaviour.REQUIRES_TOUCH_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour).<br />
294 /// <param name="touch">The touch event.</param>
295 /// <returns>True if the event should be consumed.</returns>
296 /// <since_tizen> 8 </since_tizen>
297 public override bool OnTouch(Touch touch)
299 if(!IsEnabled || null == touch) return false;
301 PointStateType state = touch.GetState(0);
302 bool ret = base.OnTouch(touch);
305 case PointStateType.Up:
315 /// Get Switch style.
317 /// <returns>The default switch style.</returns>
318 /// <since_tizen> 8 </since_tizen>
319 protected override ViewStyle CreateViewStyle()
321 return new SwitchStyle();
324 private void Initialize()
326 Style.IsSelectable = true;
330 /// Theme change callback when theme is changed, this callback will be trigger.
332 /// <param name="sender">The sender</param>
333 /// <param name="e">The event data</param>
334 [EditorBrowsable(EditorBrowsableState.Never)]
335 protected override void OnThemeChangedEvent(object sender, StyleManager.ThemeChangeEventArgs e)
337 SwitchStyle switchStyle = StyleManager.Instance.GetViewStyle(StyleName) as SwitchStyle;
338 if (null != switchStyle)
340 Style.CopyFrom(switchStyle);
344 private void OnSelect()
346 if (SelectedEvent != null)
348 SelectEventArgs eventArgs = new SelectEventArgs();
349 eventArgs.IsSelected = IsSelected;
350 SelectedEvent(this, eventArgs);
355 /// SelectEventArgs is a class to record item selected arguments which will sent to user.
357 /// <since_tizen> 6 </since_tizen>
358 public class SelectEventArgs : EventArgs
360 /// <summary> Select state of Switch </summary>
361 /// <since_tizen> 6 </since_tizen>
362 public bool IsSelected;
366 /// Get current track part to the attached SwitchExtension.
369 /// It returns null if the passed extension is invaild.
371 /// <param name="extension">The extension instance that is currently attached to this Switch.</param>
372 /// <return>The switch's track part.</return>
373 [EditorBrowsable(EditorBrowsableState.Never)]
374 public ImageView GetCurrentTrack(SwitchExtension extension)
376 return (extension == Extension) ? Track : null;
380 /// Get current thumb part to the attached SwitchExtension.
383 /// It returns null if the passed extension is invaild.
385 /// <param name="extension">The extension instance that is currently attached to this Switch.</param>
386 /// <return>The switch's thumb part.</return>
387 [EditorBrowsable(EditorBrowsableState.Never)]
388 public ImageView GetCurrentThumb(SwitchExtension extension)
390 return (extension == Extension) ? Thumb : null;