/api/blackberry_ui_menu_item.js

https://github.com/jasondscott/WebWorks-API-Docs · JavaScript · 80 lines · 5 code · 7 blank · 68 comment · 0 complexity · 8470ee8b12526c2d830f52d5fe274a2a MD5 · raw file 

    

  1. /*

    2. 

  2. * Copyright 2010-2011 Research In Motion Limited.

    3. 

  3. *

    4. 

  4. * Licensed under the Apache License, Version 2.0 (the "License");

    5. 

  5. * you may not use this file except in compliance with the License.

    6. 

  6. * You may obtain a copy of the License at

    7. 

  7. *

    8. 

  8. * http://www.apache.org/licenses/LICENSE-2.0

    9. 

  9. *

    10. 

  10. * Unless required by applicable law or agreed to in writing, software

    11. 

  11. * distributed under the License is distributed on an "AS IS" BASIS,

    12. 

  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    13. 

  13. * See the License for the specific language governing permissions and

    14. 

  14. * limitations under the License.

    15. 

  15. */

    16. 

  16. 

    17. 

  17. /**

    18. 

  18. * @description The MenuItem object is an instance object, where if a new instance is desired, it must be created using the new keyword.

    19. 

  19. * @featureID blackberry.ui.menu

    20. 

  20. * @toc {User Interface} MenuItem 

    21. 

  21. * @BB50+

    22. 

  22. * @RIPPLE

    23. 

  23. * @class The MenuItem object represents a menu item for the screen.

    24. 

  24. * @constructs  

    25. 

  25. * @param {Boolean} isSeparator If set to true the MenuItem will be created as a separator.

    26. 

  26. * @param {Number} ordinal The ordinal of this MenuItem. Ordinal has to be greater than or equal to zero. Exception will be thrown if it is less than zero.

    27. 

  27. * @param {String} [caption] The text to display on the menu item.  This must be supplied if isSeparator is false.

    28. 

  28. * @callback {function} [onClick] A parameter to specify the function to call when the user clicks the menu item.  

    29. 

  29. * @throws {Exception} If the onClick callback is supplied when isSeparator is true, an exception will be thrown.

    30. 

  30. * @learns {Sample - Menu Items} http://supportforums.blackberry.com/t5/Web-and-WebWorks-Development/Adding-Menu-Items-using-the-BlackBerry-WebWorks-SDK/ta-p/516885 Example that demonstrates how to use the Menu API to 

    31. 

  31. * create a custom application menu in a BlackBerry WebWorks application [BlackBerry Developer Resource Center].

    32. 

  32. * @example

    33. 

  33. * <script type="text/javascript">

    34. 

  34. *   

    35. 

  35. *   function clickMe() {

    36. 

  36. *      alert("user just clicked me");

    37. 

  37. *   }

    38. 

  38. *   

    39. 

  39. *   var item = new blackberry.ui.menu.MenuItem(false, 1, "Hello World", clickMe);

    40. 

  40. *   blackberry.ui.menu.addMenuItem(item);

    41. 

  41. *   

    42. 

  42. * </script>

    43. 

  43. */

    44. 

  44. blackberry.ui.menu.MenuItem = function(isSeparator,ordinal,caption,onClick) { };

    45. 

  45. 

    46. 

  46. /**

    47. 

  47. * Contains the caption for the menu item. 

    48. 

  48. * @type String

    49. 

  49. * @BB50+

    50. 

  50. * @RIPPLE

    51. 

  51. */

    52. 

  52. blackberry.ui.menu.MenuItem.prototype.caption = { };

    53. 

  53. 

    54. 

  54. /**

    55. 

  55. * Each MenuItem has an ordinal specifying the sort order within the menu. MenuItems with a lower ordinal will have higher positions on the menu than the MenuItems with higher ordinal. A separator will be automatically inserted between adjacent items whose ordinals differ by at least 0x00010000. 

    56. 

  56. * @type Number

    57. 

  57. * @BB50+

    58. 

  58. * @RIPPLE

    59. 

  59. */

    60. 

  60. blackberry.ui.menu.MenuItem.prototype.ordinal = { };

    61. 

  61. 

    62. 

  62. /**

    63. 

  63. * Value is true if the menu item is a separator. 

    64. 

  64. * @type Boolean

    65. 

  65. * @readOnly

    66. 

  66. * @BB50+

    67. 

  67. * @RIPPLE

    68. 

  68. */

    69. 

  69. blackberry.ui.menu.MenuItem.prototype.isSeparator = { };

    70. 

  70. 

    71. 

  71. /**

    72. 

  72. * Value is true if the menu item is marked as the default item to be selected in the menu. 

    73. 

  73. * @type Boolean

    74. 

  74. * @readOnly

    75. 

  75. * @BB50+

    76. 

  76. * @RIPPLE

    77. 

  77. */

    78. 

  78. blackberry.ui.menu.MenuItem.prototype.isDefault = { };
    79.