/lib/titanium/mobile/ui/Button.hx

http://github.com/visup/haxe-titanium-api · Haxe · 97 lines · 20 code · 3 blank · 74 comment · 0 complexity · 95ccb5ef3adbceb685707fe93f5e13b4 MD5 · raw file 

    

  1. package titanium.mobile.ui;
    2. 

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

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

  4. 

  5. /**
    6. 

  6. Button class
    7. 

    8. 

  8. Documentation available at:
    9. 

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

    11. 

  11. - namespace
    12. 

    13. 

  13. Titanium.UI.Button
    14. 

    15. 

  15. - type
    16. 

    17. 

  17. object
    18. 

    19. 

  19. - subtype
    20. 

    21. 

  21. view
    22. 

    23. 

  23. - description
    24. 

    25. 

  25. A Button is created by the method `Titanium.UI.createButton`.
    26. 

    27. 

  27. - since
    28. 

    29. 

  29. 0.8
    30. 

    31. 

  31. - platforms
    32. 

    33. 

  33. android, iphone, ipad
    34. 

    35. 

  35. - properties
    36. 

    37. 

  37. title[string]: button title
    38. 

  38. enabled[boolean]: boolean that indicates if the button is enabled or not
    39. 

  39. backgroundColor[string]: the buttons background color
    40. 

  40. color[string]: the foreground color of the button text
    41. 

  41. selectedColor[string]: the selected color of the button text when the button is in the selected state
    42. 

  42. font[object]: the font properties of the button
    43. 

  43. backgroundImage[string]: url to a button image that is drawn as the background of the button
    44. 

  44. backgroundSelectedImage[string]: url to a button image that is drawn as the background of the button when the button is in the selected state
    45. 

  45. backgroundDisabledImage[string]: url to a button image that is drawn as the background of the button when the button is in the disabled state
    46. 

  46. style[int]: style constant for the type of button
    47. 

  47. image[string]: the image to display on the button to the left of the title
    48. 

    49. 

  49. # 1.5
    50. 

  50. titleid[string]: the key in the locale file to use for the title property
    51. 

    52. 

  52. #
    53. 

  53. systemButton[int]: style costants to use sytem button style (0 -> done, 1 -> cancel, 2 -> edit, 3 -> save, 4 -> +, 5 -> space, 17 -> play) http://developer.appcelerator.com/apidoc/mobile/latest/Titanium.UI.iPhone.SystemButton-object
    54. 

    55. 

    56. 

  56. - methods
    57. 

    58. 

  58. - events
    59. 

    60. 

  60. click: fired when the user presses the button
    61. 

    62. 

  62. - example : Simple Button Example
    63. 

    64. 

  64. ~~~
    65. 

  65. var button = Titanium.UI.createButton({
    66. 

  66.    title: 'Hello'
    67. 

  67. });
    68. 

  68. button.addEventListener('click',function(e)
    69. 

  69. {
    70. 

  70.    Titanium.API.info("You clicked the button");
    71. 

  71. });
    72. 

  72. ~~~
    73. 

    74. 

  74. - notes
    75. 

    76. 

  76. **/
    77. 

  77. 

  78. @:native("Titanium.UI.Button")
    79. 

  79. extern class Button extends BaseView
    80. 

  80. {
    81. 

  81. 	// static constructor
    82. 

  82. 	public inline static function create(?params:Dynamic):Button
    83. 

  83. 		return titanium.mobile.UI.createButton(params)
    84. 

  84. 		
    85. 

  85. 	// properties
    86. 

  86. 	public var backgroundDisabledImage:String;
    87. 

  87. 	public var enabled:Bool;
    88. 

  88. 	public var font:Dynamic;
    89. 

  89. 	public var image:String;
    90. 

  90. 	public var selectedColor:String;
    91. 

  91. 	public var style:Int;
    92. 

  92. 	public var title:String;
    93. 

  93. 	public var titleid:String;
    94. 

  94. 	public var color:String;
    95. 

  95. 	public var value:Dynamic;
    96. 

  96. 	public var systemButton:Int;
    97. 

  97. }
    98.