Permalink
Browse files

RF-14279: update JSDoc

  • Loading branch information...
1 parent 73ae28c commit dfe4d0cabb92884f8954cb202f5ec2c02b118036 @michpetrov michpetrov committed Jun 20, 2016
Showing with 1,674 additions and 274 deletions.
  1. +23 −0 components/a4j/src/main/resources/META-INF/resources/org.richfaces/poll.js
  2. +29 −0 components/a4j/src/main/resources/META-INF/resources/org.richfaces/popup.js
  3. +30 −2 components/a4j/src/main/resources/META-INF/resources/org.richfaces/status.js
  4. +11 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/Autocomplete.js
  5. +42 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/AutocompleteBase.js
  6. +7 −5 components/rich/src/main/resources/META-INF/resources/org.richfaces/accordion.js
  7. +12 −8 components/rich/src/main/resources/META-INF/resources/org.richfaces/accordionItem.js
  8. +114 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/calendar.js
  9. +40 −18 components/rich/src/main/resources/META-INF/resources/org.richfaces/chart.js
  10. +9 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/collapsible-subtable-toggler.js
  11. +61 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/collapsible-subtable.js
  12. +36 −8 components/rich/src/main/resources/META-INF/resources/org.richfaces/collapsiblePanel.js
  13. +10 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/collapsiblePanelItem.js
  14. +14 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/component-control.js
  15. +18 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/contextmenu.js
  16. +54 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/datascroller.js
  17. +60 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/datatable.js
  18. +10 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/dnd-draggable.js
  19. +10 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/dnd-droppable.js
  20. +10 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/dnd-indicator.js
  21. +81 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/editor.js
  22. +57 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/extendedDataTable.js
  23. +10 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/fileupload.js
  24. +10 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/focus.js
  25. +10 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/hotkey.js
  26. +35 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/inplaceBase.js
  27. +24 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/inplaceInput.js
  28. +23 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/inplaceSelect.js
  29. +30 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/inputBase.js
  30. +43 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/inputNumberSlider.js
  31. +42 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/inputNumberSpinner.js
  32. +8 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/list.js
  33. +23 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/listMulti.js
  34. +10 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/menu-base.js
  35. +10 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/menu.js
  36. +10 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/menugroup.js
  37. +10 −1 components/rich/src/main/resources/META-INF/resources/org.richfaces/menuitem.js
  38. +10 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/message.js
  39. +8 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/notify.js
  40. +11 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/notifyMessage.js
  41. +10 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/notifyStack.js
  42. +53 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/orderingList.js
  43. +31 −41 components/rich/src/main/resources/META-INF/resources/org.richfaces/panelMenu.js
  44. +31 −12 components/rich/src/main/resources/META-INF/resources/org.richfaces/panelMenuGroup.js
  45. +14 −14 components/rich/src/main/resources/META-INF/resources/org.richfaces/panelMenuItem.js
  46. +61 −1 components/rich/src/main/resources/META-INF/resources/org.richfaces/pickList.js
  47. +10 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/placeholder.js
  48. +9 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/popupList.js
  49. +54 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/popupPanel.js
  50. +57 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/progressBar.js
  51. +42 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/select.js
  52. +16 −11 components/rich/src/main/resources/META-INF/resources/org.richfaces/tab.js
  53. +8 −6 components/rich/src/main/resources/META-INF/resources/org.richfaces/tabPanel.js
  54. +58 −40 components/rich/src/main/resources/META-INF/resources/org.richfaces/togglePanel.js
  55. +11 −1 components/rich/src/main/resources/META-INF/resources/org.richfaces/togglePanelItem.js
  56. +17 −17 components/rich/src/main/resources/META-INF/resources/org.richfaces/tooltip.js
  57. +20 −0 components/rich/src/main/resources/META-INF/resources/org.richfaces/tree.js
  58. +5 −5 core/src/main/resources/META-INF/resources/org.richfaces/jquery.position.js
  59. +67 −64 core/src/main/resources/META-INF/resources/org.richfaces/richfaces-base-component.js
  60. +3 −3 core/src/main/resources/META-INF/resources/org.richfaces/richfaces-event.js
  61. +8 −8 core/src/main/resources/META-INF/resources/org.richfaces/richfaces-queue.js
  62. +23 −8 core/src/main/resources/META-INF/resources/org.richfaces/richfaces.js
  63. +1 −1 dist/pom.xml
@@ -2,6 +2,17 @@
rf.ui = rf.ui || {};
var defaultOptions = {
};
+
+ /**
+ * Backing object for a4j:poll
+ *
+ * @extends RichFaces.BaseComponent
+ * @memberOf! RichFaces.ui
+ * @constructs RichFaces.ui.Poll
+ *
+ * @param componentId
+ * @param options
+ */
rf.ui.Poll = function(componentId, options) {
$super.constructor.call(this, componentId, options);
this.id = componentId;
@@ -24,6 +35,12 @@
return {
name: "Poll",
+ /**
+ * Start the poll
+ *
+ * @method
+ * @name RichFaces.ui.Poll#startPoll
+ */
startPoll: function() {
this.stopPoll();
var poll = this;
@@ -37,6 +54,12 @@
}, poll.interval);
},
+ /**
+ * Stop the poll
+ *
+ * @method
+ * @name RichFaces.ui.Poll#stopPoll
+ */
stopPoll : function() {
if (rf.ui.pollTracker && rf.ui.pollTracker[this.id]) {
window.clearTimeout(rf.ui.pollTracker[this.id]);
@@ -24,6 +24,16 @@
rf.ui = rf.ui || {};
+ /**
+ * A simple popup
+ *
+ * @extends RichFaces.BaseComponent
+ * @memberOf! RichFaces.ui
+ * @constructs RichFaces.ui.Popup
+ *
+ * @param id
+ * @param options
+ */
rf.ui.Popup = function(id, options) {
$super.constructor.call(this, id);
this.options = $.extend({}, defaultOptions, options);
@@ -49,6 +59,12 @@
name : "popup",
+ /**
+ * Show the popup
+ *
+ * @method
+ * @name RichFaces.ui.Popup#show
+ */
show: function(event) {
if (!this.visible) {
if (this.attachToBody) {
@@ -61,6 +77,12 @@
this.popup.setPosition(event || {id: this.attachTo}, this.positionOptions).show();
},
+ /**
+ * Hide the popup
+ *
+ * @method
+ * @name RichFaces.ui.Popup#hide
+ */
hide: function() {
if (this.visible) {
this.popup.hide();
@@ -72,6 +94,13 @@
}
},
+ /**
+ * Returns true if the popup is visible
+ *
+ * @method
+ * @name RichFaces.ui.Popup#isVisible
+ * @return {boolean} true if the popup is visible
+ */
isVisible: function() {
return this.visible;
},
@@ -104,11 +104,21 @@
};
rf.ui = rf.ui || {};
-
+
rf.ui.Status = rf.BaseComponent.extendClass({
name: "Status",
-
+
+ /**
+ * Backing object for a4j:status
+ *
+ * @extends RichFaces.BaseComponent
+ * @memberOf! RichFaces.ui
+ * @constructs RichFaces.ui.Status
+ *
+ * @param id {string} component id
+ * @param [options] {Object} status options
+ */
//TODO - support for parallel requests
init: function(id, options) {
this.id = id;
@@ -143,6 +153,12 @@
statuses[this.id] = this;
},
+ /**
+ * Switches status to the stop state.
+ *
+ * @method
+ * @name RichFaces.ui.Status#start
+ */
start: function() {
if (this.options.onstart) {
this.options.onstart.apply(this, arguments);
@@ -151,6 +167,12 @@
return this.__showHide('.rf-st-start');
},
+ /**
+ * Switches status to the stop state.
+ *
+ * @method
+ * @name RichFaces.ui.Status#stop
+ */
stop: function() {
this.__stop();
return this.__showHide('.rf-st-stop');
@@ -163,6 +185,12 @@
return this.stop();
},
+ /**
+ * Switches status to the error state.
+ *
+ * @method
+ * @name RichFaces.ui.Status#error
+ */
error: function() {
if (this.options.onerror) {
this.options.onerror.apply(this, arguments);
@@ -6,6 +6,17 @@
*/
rf.ui = rf.ui || {};
+ /**
+ * Backing object for rich:autocomplete
+ *
+ * @extends RichFaces.ui.AutocompleteBase
+ * @memberOf! RichFaces.ui
+ * @constructs RichFaces.ui.Autocomplete
+ *
+ * @param componentId {string} component id
+ * @param fieldId {string} id of the input box
+ * @param options {Object} autocomplete options
+ */
// Constructor definition
rf.ui.Autocomplete = function(componentId, fieldId, options) {
this.namespace = "." + rf.Event.createNamespace(this.name, componentId);
@@ -3,6 +3,16 @@
rf.ui = rf.ui || {};
// Constructor definition
+ /**
+ * @extends RichFaces.BaseComponent
+ * @memberOf! RichFaces.ui
+ * @constructs RichFaces.ui.AutocompleteBase
+ *
+ * @param componentId
+ * @param selectId
+ * @param fieldId
+ * @param options
+ */
rf.ui.AutocompleteBase = function(componentId, selectId, fieldId, options) {
// call constructor of parent class
$super.constructor.call(this, componentId);
@@ -264,26 +274,58 @@
* public API functions
*/
name:"AutocompleteBase",
+ /**
+ * Show the popup list of completion values
+ *
+ * @method
+ * @name RichFaces.ui.AutocompleteBase#showPopup
+ */
showPopup: function (event) {
if (!this.focused) {
rf.getDomElement(this.fieldId).focus();
}
onShow.call(this, event);
},
+ /**
+ * Hide the popup list
+ *
+ * @method
+ * @name RichFaces.ui.AutocompleteBase#hidePopup
+ */
hidePopup: function (event) {
this.__hide(event)
},
getNamespace: function () {
return this.namespace;
},
+ /**
+ * Get the current value
+ *
+ * @method
+ * @name RichFaces.ui.AutocompleteBase#getValue
+ * @return {string} current value
+ */
getValue: function () {
return this.fieldId ? rf.getDomElement(this.fieldId).value : "";
},
+ /**
+ * Set the value
+ *
+ * @method
+ * @name RichFaces.ui.AutocompleteBase#setValue
+ * @param {string} new value
+ */
setValue: function (value) {
if (value == this.currentValue) return;
updateInputValue.call(this, value);
this.isChanged = true;
},
+ /**
+ * Focus the input element
+ *
+ * @method
+ * @name RichFaces.ui.AutocompleteBase#focus
+ */
focus: function () {
rf.getDomElement(this.fieldId).focus();
},
@@ -29,12 +29,14 @@
name:"Accordion",
/**
- * @class Accordion
- * @name Accordion
+ * Backing object for rich:accordion
+ *
+ * @extends RichFaces.ui.TogglePanel
+ * @memberOf! RichFaces.ui
*
- * @constructor
- * @param {String} componentId - component id
- * @param {Hash} options - params
+ * @constructs RichFaces.ui.Accordion
+ * @param {string} componentId - component id
+ * @param {Object} options - params
* */
init : function (componentId, options) {
$super.constructor.call(this, componentId, options);
@@ -29,12 +29,14 @@
name:"AccordionItem",
/**
- * @class AccordionItem
- * @name AccordionItem
- *
- * @constructor
- * @param {String} componentId - component id
- * @param {Hash} options - params
+ * Backing object for rich:accordionItem
+ *
+ * @extends RichFaces.ui.TogglePanelItem
+ * @memberOf! RichFaces.ui
+ * @constructs RichFaces.ui.AccordionItem
+ *
+ * @param {string} componentId - component id
+ * @param {Object} options - params
* */
init : function (componentId, options) {
$super.constructor.call(this, componentId, options);
@@ -60,14 +62,16 @@
},
/**
- * @return {jQuery Object}
+ * @private
+ * @return {jQuery}
* */
__header : function () {
return $(rf.getDomElement(this.id + ":header"));
},
/**
- * @return {jQuery Object}
+ * @private
+ * @return {jQuery}
* */
__content : function () {
if (!this.__content_) {
Oops, something went wrong.

0 comments on commit dfe4d0c

Please sign in to comment.