src/Tizen.NUI/src/public/BaseComponents/ImageView.cs

   1 /*
   2  * Copyright(c) 2017 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.Runtime.InteropServices;
  19 using System.ComponentModel;
  20
  21 namespace Tizen.NUI.BaseComponents
  22 {
  23
  24     /// <summary>
  25     /// ImageView is a class for displaying an image resource.<br />
  26     /// An instance of ImageView can be created using a URL or an image instance.<br />
  27     /// </summary>
  28     /// <since_tizen> 3 </since_tizen>
  29     public class ImageView : View
  30     {
  31         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
  32
  33         internal ImageView(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.ImageView_SWIGUpcast(cPtr), cMemoryOwn)
  34         {
  35             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
  36         }
  37
  38         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(ImageView obj)
  39         {
  40             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
  41         }
  42
  43
  44         /// <summary>
  45         /// Event arguments of resource ready.
  46         /// </summary>
  47         /// <since_tizen> 3 </since_tizen>
  48         public class ResourceReadyEventArgs : EventArgs
  49         {
  50             private View _view;
  51
  52             /// <summary>
  53             /// The view whose resource is ready.
  54             /// </summary>
  55             /// <since_tizen> 3 </since_tizen>
  56             public View View
  57             {
  58                 get
  59                 {
  60                     return _view;
  61                 }
  62                 set
  63                 {
  64                     _view = value;
  65                 }
  66             }
  67         }
  68
  69         private EventHandler<ResourceReadyEventArgs> _resourceReadyEventHandler;
  70         [UnmanagedFunctionPointer(CallingConvention.StdCall)]
  71         private delegate void ResourceReadyEventCallbackType(IntPtr data);
  72         private ResourceReadyEventCallbackType _resourceReadyEventCallback;
  73
  74         /// <summary>
  75         /// An event for ResourceReady signal which can be used to subscribe or unsubscribe the event handler.<br />
  76         /// This signal is emitted after all resources required by a control are loaded and ready.<br />
  77         /// Most resources are only loaded when the control is placed on the stage.<br />
  78         /// </summary>
  79         /// <since_tizen> 3 </since_tizen>
  80         public event EventHandler<ResourceReadyEventArgs> ResourceReady
  81         {
  82             add
  83             {
  84                 if (_resourceReadyEventHandler == null)
  85                 {
  86                     _resourceReadyEventCallback = OnResourceReady;
  87                     ResourceReadySignal(this).Connect(_resourceReadyEventCallback);
  88                 }
  89
  90                 _resourceReadyEventHandler += value;
  91             }
  92
  93             remove
  94             {
  95                 _resourceReadyEventHandler -= value;
  96
  97                 if (_resourceReadyEventHandler == null && ResourceReadySignal(this).Empty() == false)
  98                 {
  99                     ResourceReadySignal(this).Disconnect(_resourceReadyEventCallback);
 100                 }
 101             }
 102         }
 103
 104         // Callback for View ResourceReady signal
 105         private void OnResourceReady(IntPtr data)
 106         {
 107             ResourceReadyEventArgs e = new ResourceReadyEventArgs();
 108             if (data != null)
 109             {
 110                 e.View = Registry.GetManagedBaseHandleFromNativePtr(data) as View;
 111             }
 112
 113             if (_resourceReadyEventHandler != null)
 114             {
 115                 _resourceReadyEventHandler(this, e);
 116             }
 117         }
 118
 119         /// <summary>
 120         /// you can override it to clean-up your own resources.
 121         /// </summary>
 122         /// <param name="type">DisposeTypes</param>
 123         /// <since_tizen> 3 </since_tizen>
 124         protected override void Dispose(DisposeTypes type)
 125         {
 126             if (disposed)
 127             {
 128                 return;
 129             }
 130
 131             if (type == DisposeTypes.Explicit)
 132             {
 133                 //Called by User
 134                 //Release your own managed resources here.
 135                 //You should release all of your own disposable objects here.
 136                 _border?.Dispose();
 137                 _border = null;
 138                 _nPatchMap?.Dispose();
 139                 _nPatchMap = null;
 140             }
 141
 142             //Release your own unmanaged resources here.
 143             //You should not access any managed member here except static instance.
 144             //because the execution order of Finalizes is non-deterministic.
 145
 146             if (swigCPtr.Handle != global::System.IntPtr.Zero)
 147             {
 148                 if (swigCMemOwn)
 149                 {
 150                     swigCMemOwn = false;
 151                     NDalicPINVOKE.delete_ImageView(swigCPtr);
 152                 }
 153                 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
 154             }
 155
 156             base.Dispose(type);
 157         }
 158
 159         internal new class Property
 160         {
 161             internal static readonly int RESOURCE_URL = NDalicPINVOKE.ImageView_Property_RESOURCE_URL_get();
 162             internal static readonly int IMAGE = NDalicPINVOKE.ImageView_Property_IMAGE_get();
 163             internal static readonly int PRE_MULTIPLIED_ALPHA = NDalicPINVOKE.ImageView_Property_PRE_MULTIPLIED_ALPHA_get();
 164             internal static readonly int PIXEL_AREA = NDalicPINVOKE.ImageView_Property_PIXEL_AREA_get();
 165         }
 166
 167         /// <summary>
 168         /// Creates an initialized ImageView.
 169         /// </summary>
 170         /// <since_tizen> 3 </since_tizen>
 171         public ImageView() : this(NDalicPINVOKE.ImageView_New__SWIG_0(), true)
 172         {
 173             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 174
 175         }
 176         /// <summary>
 177         /// Creates an initialized ImageView from a URL to an image resource.<br />
 178         /// If the string is empty, ImageView will not display anything.<br />
 179         /// </summary>
 180         /// <param name="url">The URL of the image resource to display.</param>
 181         /// <since_tizen> 3 </since_tizen>
 182         public ImageView(string url) : this(NDalicPINVOKE.ImageView_New__SWIG_2(url), true)
 183         {
 184             _url = url;
 185             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 186
 187         }
 188         internal ImageView(string url, Uint16Pair size) : this(NDalicPINVOKE.ImageView_New__SWIG_3(url, Uint16Pair.getCPtr(size)), true)
 189         {
 190             _url = url;
 191             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 192
 193         }
 194
 195         /// <summary>
 196         /// Downcasts a handle to imageView handle.
 197         /// </summary>
 198         /// Please do not use! this will be deprecated!
 199         /// Instead please use as keyword.
 200         /// <since_tizen> 3 </since_tizen>
 201         [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead! " +
 202             "Like: " +
 203             "BaseHandle handle = new ImageView(imagePath); " +
 204             "ImageView image = handle as ImageView")]
 205         [EditorBrowsable(EditorBrowsableState.Never)]
 206         public new static ImageView DownCast(BaseHandle handle)
 207         {
 208             ImageView ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as ImageView;
 209             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 210             return ret;
 211         }
 212
 213         /// <summary>
 214         /// Sets this ImageView from the given URL.<br />
 215         /// If the URL is empty, ImageView will not display anything.<br />
 216         /// </summary>
 217         /// <param name="url">The URL to the image resource to display.</param>
 218         /// <since_tizen> 3 </since_tizen>
 219         public void SetImage(string url)
 220         {
 221             _url = url;
 222             NDalicPINVOKE.ImageView_SetImage__SWIG_1(swigCPtr, url);
 223             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 224         }
 225         internal void SetImage(string url, Uint16Pair size)
 226         {
 227             _url = url;
 228             NDalicPINVOKE.ImageView_SetImage__SWIG_2(swigCPtr, url, Uint16Pair.getCPtr(size));
 229             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 230         }
 231
 232         internal ViewResourceReadySignal ResourceReadySignal(View view)
 233         {
 234             ViewResourceReadySignal ret = new ViewResourceReadySignal(NDalicPINVOKE.ResourceReadySignal(View.getCPtr(view)), false);
 235             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 236             return ret;
 237         }
 238
 239         /// <summary>
 240         /// Queries if all resources required by a control are loaded and ready.<br />
 241         /// Most resources are only loaded when the control is placed on the stage.<br />
 242         /// True if the resources are loaded and ready, false otherwise.<br />
 243         /// </summary>
 244         /// <since_tizen> 3 </since_tizen>
 245         public new bool IsResourceReady()
 246         {
 247             bool ret = NDalicPINVOKE.IsResourceReady(swigCPtr);
 248             if (NDalicPINVOKE.SWIGPendingException.Pending)
 249                 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 250             return ret;
 251         }
 252
 253         /// <summary>
 254         /// ImageView ResourceUrl, type string.
 255         /// </summary>
 256         /// <since_tizen> 3 </since_tizen>
 257         public string ResourceUrl
 258         {
 259             get
 260             {
 261                 GetProperty(ImageView.Property.IMAGE).Get(out _url);
 262                 return _url;
 263             }
 264             set
 265             {
 266                 _url = (value == null? "" : value);
 267                 UpdateImage();
 268             }
 269         }
 270
 271         /// <summary>
 272         /// This will be deprecated, please use Image instead. <br />
 273         /// ImageView ImageMap, type PropertyMap: string if it is a URL, map otherwise.
 274         /// </summary>
 275         /// <since_tizen> 3 </since_tizen>
 276         [Obsolete("Please do not use! This will be deprecated! Please use Image property instead!")]
 277         [EditorBrowsable(EditorBrowsableState.Never)]
 278         public PropertyMap ImageMap
 279         {
 280             get
 281             {
 282                 if (_border == null)
 283                 {
 284                     PropertyMap temp = new PropertyMap();
 285                     GetProperty(ImageView.Property.IMAGE).Get(temp);
 286                     return temp;
 287                 }
 288                 else
 289                 {
 290                     return null;
 291                 }
 292             }
 293             set
 294             {
 295                 if (_border == null)
 296                 {
 297                     SetProperty(ImageView.Property.IMAGE, new Tizen.NUI.PropertyValue(value));
 298                 }
 299             }
 300         }
 301
 302         /// <summary>
 303         /// ImageView Image, type PropertyMap
 304         /// </summary>
 305         /// <since_tizen> 4 </since_tizen>
 306         public PropertyMap Image
 307         {
 308             get
 309             {
 310                 if (_border == null)
 311                 {
 312                     PropertyMap temp = new PropertyMap();
 313                     GetProperty(ImageView.Property.IMAGE).Get(temp);
 314                     return temp;
 315                 }
 316                 else
 317                 {
 318                     return null;
 319                 }
 320             }
 321             set
 322             {
 323                 if (_border == null)
 324                 {
 325                     SetProperty(ImageView.Property.IMAGE, new Tizen.NUI.PropertyValue(value));
 326                 }
 327             }
 328         }
 329
 330         /// <summary>
 331         /// ImageView PreMultipliedAlpha, type Boolean.<br />
 332         /// Image must be initialized.<br />
 333         /// </summary>
 334         /// <since_tizen> 3 </since_tizen>
 335         public bool PreMultipliedAlpha
 336         {
 337             get
 338             {
 339                 bool temp = false;
 340                 GetProperty(ImageView.Property.PRE_MULTIPLIED_ALPHA).Get(out temp);
 341                 return temp;
 342             }
 343             set
 344             {
 345                 SetProperty(ImageView.Property.PRE_MULTIPLIED_ALPHA, new Tizen.NUI.PropertyValue(value));
 346             }
 347         }
 348
 349         /// <summary>
 350         /// ImageView PixelArea, type Vector4 (Animatable property).<br />
 351         /// Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].<br />
 352         /// </summary>
 353         /// <since_tizen> 3 </since_tizen>
 354         public RelativeVector4 PixelArea
 355         {
 356             get
 357             {
 358                 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
 359                 GetProperty(ImageView.Property.PIXEL_AREA).Get(temp);
 360                 return temp;
 361             }
 362             set
 363             {
 364                 SetProperty(ImageView.Property.PIXEL_AREA, new Tizen.NUI.PropertyValue(value));
 365             }
 366         }
 367
 368         /// <summary>
 369         /// The border of the image in the order: left, right, bottom, top.<br />
 370         /// If set, ImageMap will be ignored.<br />
 371         /// For N-Patch images only.<br />
 372         /// Optional.
 373         /// </summary>
 374         /// <since_tizen> 3 </since_tizen>
 375         public Rectangle Border
 376         {
 377             get
 378             {
 379                 return _border;
 380             }
 381             set
 382             {
 383                 _border = value;
 384                 UpdateImage();
 385             }
 386         }
 387
 388         /// <summary>
 389         /// Gets or sets whether to draw the borders only (if true).<br />
 390         /// If not specified, the default is false.<br />
 391         /// For N-Patch images only.<br />
 392         /// Optional.
 393         /// </summary>
 394         /// <since_tizen> 3 </since_tizen>
 395         public bool BorderOnly
 396         {
 397             get
 398             {
 399                 return _borderOnly ?? false;
 400             }
 401             set
 402             {
 403                 _borderOnly = value;
 404                 UpdateImage();
 405             }
 406         }
 407
 408         /// <summary>
 409         /// Gets or sets whether to synchronos loading the resourceurl of image.<br />
 410         /// </summary>
 411         /// <since_tizen> 3 </since_tizen>
 412         public bool SynchronosLoading
 413         {
 414             get
 415             {
 416                 return _synchronousLoading ?? false;
 417             }
 418             set
 419             {
 420                 _synchronousLoading = value;
 421                 UpdateImage();
 422             }
 423         }
 424
 425         /// <summary>
 426         /// Gets or sets whether to correct orientation of image automatically.<br />
 427         /// </summary>
 428         /// <since_tizen> 5 </since_tizen>
 429         /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
 430         [EditorBrowsable(EditorBrowsableState.Never)]
 431         public bool OrientationCorrection
 432         {
 433             get
 434             {
 435                 return _orientationCorrection ?? false;
 436             }
 437             set
 438             {
 439                 _orientationCorrection = value;
 440                 UpdateImage();
 441             }
 442         }
 443
 444
 445         /// <summary>
 446         /// Get the loading state of the visual resource.
 447         /// </summary>
 448         /// <since_tizen> 5 </since_tizen>
 449         /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
 450         [EditorBrowsable(EditorBrowsableState.Never)]
 451         public ImageView.LoadingStatusType LoadingStatus
 452         {
 453             get
 454             {
 455                 return (ImageView.LoadingStatusType)NDalicManualPINVOKE.View_GetVisualResourceStatus(swigCPtr, (int)Property.IMAGE);
 456             }
 457         }
 458
 459         /// <summary>
 460         /// Enumeration for LoadingStatus of image.
 461         /// </summary>
 462         /// <since_tizen> 5 </since_tizen>
 463         /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
 464         [EditorBrowsable(EditorBrowsableState.Never)]
 465         public enum LoadingStatusType
 466         {
 467             /// <summary>
 468             /// Loading preparing status.
 469             /// </summary>
 470             /// <since_tizen> 5 </since_tizen>
 471             /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
 472             [EditorBrowsable(EditorBrowsableState.Never)]
 473             Preparing,
 474             /// <summary>
 475             /// Loading ready status.
 476             /// </summary>
 477             /// <since_tizen> 5 </since_tizen>
 478             /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
 479             [EditorBrowsable(EditorBrowsableState.Never)]
 480             Ready,
 481             /// <summary>
 482             /// Loading failed status.
 483             /// </summary>
 484             /// <since_tizen> 5 </since_tizen>
 485             /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
 486             [EditorBrowsable(EditorBrowsableState.Never)]
 487             Failed
 488         }
 489
 490
 491         private void UpdateImage()
 492         {
 493             if (_url != null)
 494             {
 495                 if (_border != null)
 496                 { // for nine-patch image
 497                     _nPatchMap = new PropertyMap();
 498                     _nPatchMap.Add(Visual.Property.Type, new PropertyValue((int)Visual.Type.NPatch));
 499                     _nPatchMap.Add(NpatchImageVisualProperty.URL, new PropertyValue(_url));
 500                     _nPatchMap.Add(NpatchImageVisualProperty.Border, new PropertyValue(_border));
 501                     if (_borderOnly != null) { _nPatchMap.Add(NpatchImageVisualProperty.BorderOnly, new PropertyValue((bool)_borderOnly)); }
 502                     if (_synchronousLoading != null) { _nPatchMap.Add(NpatchImageVisualProperty.SynchronousLoading, new PropertyValue((bool)_synchronousLoading)); }
 503                     if (_orientationCorrection != null) { _nPatchMap.Add(ImageVisualProperty.OrientationCorrection, new PropertyValue((bool)_orientationCorrection)); }
 504                     SetProperty(ImageView.Property.IMAGE, new PropertyValue(_nPatchMap));
 505                 }
 506                 else if (_synchronousLoading != null || _orientationCorrection != null)
 507                 { // for normal image, with synchronous loading property
 508                     PropertyMap imageMap = new PropertyMap();
 509                     imageMap.Add(Visual.Property.Type, new PropertyValue((int)Visual.Type.Image));
 510                     imageMap.Add(ImageVisualProperty.URL, new PropertyValue(_url));
 511                     if (_synchronousLoading != null) { imageMap.Add(ImageVisualProperty.SynchronousLoading, new PropertyValue((bool)_synchronousLoading)); }
 512                     if (_orientationCorrection != null) { imageMap.Add(ImageVisualProperty.OrientationCorrection, new PropertyValue((bool)_orientationCorrection)); }
 513                     SetProperty(ImageView.Property.IMAGE, new PropertyValue(imageMap));
 514                 }
 515                 else
 516                 { // just for normal image
 517                     SetProperty(ImageView.Property.IMAGE, new PropertyValue(_url));
 518                 }
 519             }
 520         }
 521
 522         private Rectangle _border = null;
 523         private PropertyMap _nPatchMap = null;
 524         private bool? _synchronousLoading = null;
 525         private bool? _borderOnly = null;
 526         private string _url = null;
 527         private bool? _orientationCorrection = null;
 528     }
 529
 530 }