Permalink
Browse files

[BUG #6314] Added tags in the API-Docs how the methods get attached t…

…o q.
  • Loading branch information...
wittemann committed Apr 27, 2012
1 parent f5d7833 commit 8a37bb9a119dd637dcdfe421d1583f668a2b548d
@@ -124,6 +124,7 @@ qx.Bootstrap.define("qx.module.Animation", {
*
* *alternate* defines if every other animation should be run in reverse order.
*
+ * @attach {qx.Collection}
* @param desc {Map} The animations description.
* @param duration {Integer?} The duration in milliseconds of the animation
* which will override the duration given in the description.
@@ -153,6 +154,7 @@ qx.Bootstrap.define("qx.module.Animation", {
/**
* Starts an animation in reversed order. For further details, take a look at
* the {@link #animate} method.
+ * @attach {qx.Collection}
* @param desc {Map} The animations description.
* @param duration {Integer?} The duration in milliseconds of the animation
* which will override the duration given in the description.
@@ -183,6 +185,7 @@ qx.Bootstrap.define("qx.module.Animation", {
/**
* Manipulates the play state of the animation.
* This can be used to continue an animation when paused.
+ * @attach {qx.Collection}
* @return {qx.Collection} The collection for chaining.
*/
play : function() {
@@ -196,6 +199,7 @@ qx.Bootstrap.define("qx.module.Animation", {
/**
* Manipulates the play state of the animation.
* This can be used to paused an animation when running.
+ * @attach {qx.Collection}
* @return {qx.Collection} The collection for chaining.
*/
pause : function() {
@@ -208,6 +212,7 @@ qx.Bootstrap.define("qx.module.Animation", {
/**
* Stops a running animation.
+ * @attach {qx.Collection}
* @return {qx.Collection} The collection for chaining.
*/
stop : function() {
@@ -221,6 +226,7 @@ qx.Bootstrap.define("qx.module.Animation", {
/**
* Returns weather an animation is running or not.
+ * @attach {qx.Collection}
* @return {Boolean} <code>true</code>, if an animation is running.
*/
isPlaying : function() {
@@ -235,6 +241,7 @@ qx.Bootstrap.define("qx.module.Animation", {
/**
* Returns weather an animation has ended or not.
+ * @attach {qx.Collection}
* @return {Boolean} <code>true</code>, if an animation has ended.
*/
isEnded : function() {
@@ -249,6 +256,7 @@ qx.Bootstrap.define("qx.module.Animation", {
/**
* Fades in all elements in the collection.
+ * @attach {qx.Collection}
* @param duration {Number?} The duration in milliseconds.
* @return {qx.Collection} The collection for chaining.
*/
@@ -259,6 +267,7 @@ qx.Bootstrap.define("qx.module.Animation", {
/**
* Fades out all elements in the collection.
+ * @attach {qx.Collection}
* @param duration {Number?} The duration in milliseconds.
* @return {qx.Collection} The collection for chaining.
*/
@@ -26,6 +26,7 @@ qx.Bootstrap.define("qx.module.Attribute", {
{
/**
* Returns the HTML content of the first item in the collection
+ * @attach {qx.Collection}
* @return {String|null} HTML content or null if the collection is empty
*/
getHtml : function() {
@@ -38,7 +39,8 @@ qx.Bootstrap.define("qx.module.Attribute", {
/**
* Sets the HTML content of each item in the collection
- *
+ *
+ * @attach {qx.Collection}
* @param html {String} HTML string
* @return {qx.Collection} The collection for chaining
*/
@@ -52,7 +54,8 @@ qx.Bootstrap.define("qx.module.Attribute", {
/**
* Sets an HTML attribute on each item in the collection
- *
+ *
+ * @attach {qx.Collection}
* @param name {String} Attribute name
* @param value {var} Attribute value
* @return {qx.Collection} The collection for chaining
@@ -68,7 +71,8 @@ qx.Bootstrap.define("qx.module.Attribute", {
/**
* Returns the value of the given attribute for the first item in the
* collection.
- *
+ *
+ * @attach {qx.Collection}
* @param name {String} Attribute name
* @return {var} Attribute value
*/
@@ -82,7 +86,8 @@ qx.Bootstrap.define("qx.module.Attribute", {
/**
* Removes the given attribute from all elements in the collection
- *
+ *
+ * @attach {qx.Collection}
* @param name {String} Attribute name
* @return {qx.Collection} The collection for chaining
*/
@@ -96,7 +101,8 @@ qx.Bootstrap.define("qx.module.Attribute", {
/**
* Sets multiple attributes for each item in the collection.
- *
+ *
+ * @attach {qx.Collection}
* @param attributes {Map} A map of attribute name/value pairs
* @return {qx.Collection} The collection for chaining
*/
@@ -110,7 +116,8 @@ qx.Bootstrap.define("qx.module.Attribute", {
/**
* Returns the values of multiple attributes for each item in the collection
- *
+ *
+ * @attach {qx.Collection}
* @param names {String[]} List of attribute names
* @return {Map} Map of attribute name/value pairs
*/
@@ -122,10 +129,11 @@ qx.Bootstrap.define("qx.module.Attribute", {
return attributes;
},
-
+
/**
* Removes multiple attributes from each item in the collection.
- *
+ *
+ * @attach {qx.Collection}
* @param attributes {String[]} List of attribute names
* @return {qx.Collection} The collection for chaining
*/
@@ -135,11 +143,12 @@ qx.Bootstrap.define("qx.module.Attribute", {
}
return this;
},
-
+
/**
* Sets a property on each item in the collection
- *
+ *
+ * @attach {qx.Collection}
* @param name {String} Property name
* @param value {var} Property value
* @return {qx.Collection} The collection for chaining
@@ -155,7 +164,8 @@ qx.Bootstrap.define("qx.module.Attribute", {
/**
* Returns the value of the given property for the first item in the
* collection
- *
+ *
+ * @attach {qx.Collection}
* @param name {String} Property name
* @return {var} Property value
*/
@@ -169,7 +179,8 @@ qx.Bootstrap.define("qx.module.Attribute", {
/**
* Sets multiple properties for each item in the collection.
- *
+ *
+ * @attach {qx.Collection}
* @param properties {Map} A map of property name/value pairs
* @return {qx.Collection} The collection for chaining
*/
@@ -183,7 +194,8 @@ qx.Bootstrap.define("qx.module.Attribute", {
/**
* Returns the values of multiple properties for each item in the collection
- *
+ *
+ * @attach {qx.Collection}
* @param names {String[]} List of property names
* @return {Map} Map of property name/value pairs
*/
@@ -201,7 +213,8 @@ qx.Bootstrap.define("qx.module.Attribute", {
* Works with simple input fields as well as with select boxes or option
* elements. Returns an array for select boxes with multi selection In all
* other cases a string is returned.
- *
+ *
+ * @attach {qx.Collection}
* @return {String|Array}
*/
getValue : function() {
@@ -221,7 +234,8 @@ qx.Bootstrap.define("qx.module.Attribute", {
* or radiobuttons (for convenience).
* Please note: To modify the value attribute of a checkbox or radiobutton
* use @link{#set} instead.
- *
+ *
+ * @attach {qx.Collection}
* @param value {String|Number|Array} The value to apply
* @return {qx.Collection} The collection for chaining
*/
@@ -30,7 +30,7 @@
* events by overlaying them with a div.
* For Internet Explorer, an additional Iframe element will be overlayed since
* native form controls cannot be blocked otherwise.
- *
+ *
* The blocker can also be applied to the entire document, e.g.:
* <br/><code>q.wrap(document).block()</code>
*/
@@ -40,7 +40,7 @@ q.define("qx.module.Blocker", {
/**
* Attaches a blocker div (and additionally a blocker Iframe for IE) to the
* given element.
- *
+ *
* @param item {DOMElement|DOMDocument} The element to be overlaid with the blocker
* @param color {String} The color for the blocker element (any CSS color value)
* @param opacity {Number} The CSS opacity value for the blocker
@@ -50,7 +50,7 @@ q.define("qx.module.Blocker", {
{
var win = q.getWindow(item);
var isDocument = q.isDocument(item);
-
+
if (!item.__blocker) {
item.__blocker = {
div : q.create("<div/>")
@@ -59,20 +59,20 @@ q.define("qx.module.Blocker", {
item.__blocker.iframe = qx.module.Blocker.__getIframeElement(win)
}
}
-
+
qx.module.Blocker.__styleBlocker(item, color, opacity, zIndex, isDocument);
-
+
item.__blocker.div.appendTo(win.document.body);
if (item.__blocker.iframe) {
item.__blocker.iframe.appendTo(win.document.body);
}
-
+
if (isDocument) {
q.wrap(win).on("resize", qx.module.Blocker.__onWindowResize);
}
},
-
-
+
+
/**
* Styles the blocker element(s)
*
@@ -85,7 +85,7 @@ q.define("qx.module.Blocker", {
__styleBlocker : function(item, color, opacity, zIndex, isDocument)
{
var qItem = q.wrap(item);
-
+
var styles = {
"zIndex" : zIndex,
"display" : "block",
@@ -95,7 +95,7 @@ q.define("qx.module.Blocker", {
"width" : qItem.getWidth() + "px",
"height" : qItem.getHeight() + "px"
};
-
+
if (isDocument) {
styles.top = 0 + "px";
styles.left = 0 + "px";
@@ -106,7 +106,7 @@ q.define("qx.module.Blocker", {
styles.left = pos.left + "px";
}
item.__blocker.div.setStyles(styles);
-
+
if (item.__blocker.iframe) {
styles.zIndex = styles.zIndex - 1;
styles.backgroundColor = "transparent";
@@ -118,7 +118,7 @@ q.define("qx.module.Blocker", {
/**
* Creates an iframe element used as a blocker in IE
- *
+ *
* @param win {Window} The parent window of the item to be blocked
* @return {Iframe} Iframe blocker
*/
@@ -136,15 +136,15 @@ q.define("qx.module.Blocker", {
allowTransparency: false,
src : "javascript:false"
});
-
+
return iframe;
},
/**
* Callback for the Window's resize event. Applies the window's new sizes
* to the blocker element(s).
- *
+ *
* @param ev {Event} resize event
*/
__onWindowResize : function(ev) {
@@ -162,7 +162,7 @@ q.define("qx.module.Blocker", {
/**
* Removes the given item's blocker element(s) from the DOM
- *
+ *
* @param item {DOMElement} Blocked element
* @param index {Integer} index of the item in the collection
*/
@@ -183,9 +183,10 @@ q.define("qx.module.Blocker", {
/**
- * Adds an overlay to all items in the collection that intercepts mouse
- * events
- *
+ * Adds an overlay to all items in the collection that intercepts mouse
+ * events.
+ *
+ * @attach {qx.Collection}
* @param color {String ? transparent} The color for the blocker element (any CSS color value)
* @param opacity {Float ? 0} The CSS opacity value for the blocker
* @param zIndex {Integer ? 10000} The zIndex value for the blocker
@@ -196,32 +197,33 @@ q.define("qx.module.Blocker", {
if (!this[0]) {
return this;
}
-
+
color = color || "transparent";
opacity = opacity || 0;
zIndex = zIndex || 10000;
-
+
this.forEach(function(item, index) {
qx.module.Blocker.__attachBlocker(item, color, opacity, zIndex);
});
-
+
return this;
},
/**
* Removes the blockers from all items in the collection
- *
+ *
+ * @attach {qx.Collection}
* @return {qx.Collection} The collection for chaining
*/
unblock : function()
{
if (!this[0]) {
return this;
}
-
+
this.forEach(qx.module.Blocker.__detachBlocker);
-
+
return this;
}
},
Oops, something went wrong.

0 comments on commit 8a37bb9

Please sign in to comment.