Export 0.1.63

[platform/framework/web/web-ui-fw.git] / src / widgets / imageslider / js / jquery.mobile.tizen.imageslider.js

diff --git a/src/widgets/imageslider/js/jquery.mobile.tizen.imageslider.js b/src/widgets/imageslider/js/jquery.mobile.tizen.imageslider.js
index fc42b02..961bf88 100755 (executable)
--- a/src/widgets/imageslider/js/jquery.mobile.tizen.imageslider.js
+++ b/src/widgets/imageslider/js/jquery.mobile.tizen.imageslider.js
@@ -35,8 +35,8 @@
  * APIs
  *
  *  add(file): add the image (parameter: url of iamge)
- *  delete(index): delete the image (parameter: index of image)
- *  refresh(index): refresh the widget, should be called after add or del. (parameter: start index)
+ *  remove(index): remove the image (parameter: index of image)
+ *  refresh(index): refresh the widget, should be called after add or remove. (parameter: start index)
  *
  * Events
  *
@@ -60,11 +60,54 @@
  * });
  *
  * $('#imageslider-del').bind('vmouseup', function ( e ) {
- *     $('#imageslider').imageslider('delete');
+ *     $('#imageslider').imageslider('remove');
  * });
  *
  */
 
+ /**
+       @class ImageSlider
+       The image slider widget shows images in a gallery on the screen. <br/><br/> To add an image slider widget to the application, use the following code:
+
+               <div data-role="imageslider" id="imageslider" data-vertical-align="middle" data-index="3">
+                       <img src="01.jpg">
+                       <img src="02.jpg">
+                       <img src="03.jpg">
+                       <img src="04.jpg">
+                       <img src="05.jpg">
+               </div>
+*/
+/**
+       @property {Integer} data-index
+       Defines the index number of the first image in the gallery.
+       <br/>The default value is 0.
+*/
+/**
+       @property {String} data-vertical-align
+       Defines the image alignment. The alignment options are top, middle, and bottom.
+       <br/>The default value is top.
+*/
+/**
+       @method add
+       The add method is used to add an image to the image slider. The image_file attribute defines the image file URL.
+
+               <div id="imageslider" data-role="imageslider" data-vertical-align="middle"></div>
+               $("#imageslider").imageslider('add', [image_file]);
+*/
+/**
+       @method del
+       The del method is used to delete an image from the image slider. The image_index attribute defines the index of the image to be deleted.
+
+               <div id="imageslider" data-role="imageslider" data-vertical-align="middle"></div>
+               $("#imageslider").imageslider('del', [image_index]);
+*/
+/**
+       @method refresh
+       The refresh method is used to refresh the image slider. This method must be called after adding images to the image slider.
+
+               <div id="imageslider" data-role="imageslider" data-vertical-align="middle"></div>
+               $("#imageslider").imageslider('refresh');
+*/
 (function ( $, window, undefined ) {
        $.widget( "tizen.imageslider", $.mobile.widget, {
                options: {
@@ -517,7 +560,7 @@
                        this.images_hold.push( file );
                },
 
-               delete: function ( index ) {
+               remove: function ( index ) {
                        var temp_img;
 
                        if ( index === undefined ) {