/lib/titanium/mobile/ui/DashboardItem.hx

http://github.com/visup/haxe-titanium-api · Haxe · 101 lines · 33 code · 7 blank · 61 comment · 0 complexity · 45f50578d67c393df3baa90eac64c5ad MD5 · raw file 

    

  1. package titanium.mobile.ui;
    2. 

  2. import titanium.mobile.core.BaseView;
    3. 

  3. import titanium.mobile.core.Dispatcher;
    4. 

  4. import titanium.mobile.core.Point;
    5. 

  5. 

  6. /**
    7. 

  7. DashboardItem class
    8. 

    9. 

  9. Documentation available at:
    10. 

  10. http://developer.appcelerator.com/apidoc/mobile/latest/Titanium.UI.DashboardItem-object.html
    11. 

    12. 

  12. - namespace
    13. 

    14. 

  14. Titanium.UI.DashboardItem
    15. 

    16. 

  16. - type
    17. 

    18. 

  18. object
    19. 

    20. 

  20. - subtype
    21. 

    22. 

  22. proxy
    23. 

    24. 

  24. - description
    25. 

    26. 

  26. An item that represents a visual icon in the [[Titanium.UI.DashboardView]]. The Dashboard Item is created by the method `Titanium.UI.createDashboardItem`.
    27. 

    28. 

  28. - since
    29. 

    30. 

  30. 1.2
    31. 

    32. 

  32. - platforms
    33. 

    34. 

  34. iphone, ipad
    35. 

    36. 

  36. - properties
    37. 

    38. 

  38. badge[int]: the badge value or `0` to remove the badge
    39. 

  39. image[string]: the URL to the image
    40. 

  40. selectedImage[string]: the URL to the image to display when the item is depressed (clicked)
    41. 

  41. canDelete[boolean]: a boolean to indicate if this item can be deleted when it edit mode
    42. 

    43. 

  43. - events
    44. 

    45. 

  45. click: fired when a [[Titanium.UI.DashboardItem]] is clicked
    46. 

  46. move: fired when a  [[Titanium.UI.DashboardItem]] is moved during editing
    47. 

  47. delete: fired when a  [[Titanium.UI.DashboardItem]] is deleted during editings
    48. 

    49. 

  49. - event : click
    50. 

    51. 

  51. item: the [[Titanium.UI.DashboardItem]] that was clicked
    52. 

  52. location: the location object with the properties `x` and `y` of where in the parent view the click was
    53. 

    54. 

  54. - event : move
    55. 

    56. 

  56. item: the [[Titanium.UI.DashboardItem]] that was moved
    57. 

  57. items: the pending data array in the new order (uncommitted)
    58. 

    59. 

  59. - event : delete
    60. 

    61. 

  61. item: the [[Titanium.UI.DashboardItem]] that was deleted
    62. 

    63. 

  63. **/
    64. 

  64. #if iphoneos
    65. 

  65. 

  66. typedef DashboardItemClickEvent = 
    67. 

  67. { > Event,
    68. 

  68. 	item:DashboardItem,
    69. 

  69. 	location:Point
    70. 

  70. }
    71. 

  71. 

  72. typedef DashboardItemDeleteEvent = 
    73. 

  73. { > Event,
    74. 

  74. 	item:DashboardItem
    75. 

  75. }
    76. 

  76. 

  77. typedef DashboardItemMoveEvent = 
    78. 

  78. { > Event,
    79. 

  79. 	item:DashboardItem,
    80. 

  80. 	items:Array<DashboardItem>
    81. 

  81. }
    82. 

  82. 

  83. @:native("Titanium.UI.DashboardItem")
    84. 

  84. extern class DashboardItem extends Dispatcher
    85. 

  85. {
    86. 

  86. 	// static constructor
    87. 

  87. 	public inline static function create(?params:Dynamic):DashboardItem
    88. 

  88. 		return titanium.mobile.UI.createDashboardItem(params)
    89. 

  89. 		
    90. 

  90. 	// events
    91. 

  91. 	public inline static var CLICK_EVENT = "click";
    92. 

  92. 	public inline static var DELETE_EVENT = "delete";
    93. 

  93. 	public inline static var MOVE_EVENT = "move";
    94. 

  94. 	
    95. 

  95. 	// properties
    96. 

  96. 	public var badge:Int;
    97. 

  97. 	public var canDelete:Bool;
    98. 

  98. 	public var image:String;
    99. 

  99. 	public var selectedImage:String;
    100. 

  100. }
    101. 

  101. #end
    102.