Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIvan Furnadjiev2017-06-09 11:44:30 +0000
committerIvan Furnadjiev2017-06-09 11:44:30 +0000
commited6c6588d1c0dd7490969537f447721258b93b2d (patch)
tree073ebd6c87062a47c47ad3bcf03998c02fa5e507 /bundles
parente4dbd1e02ead9bfca3d8b366105cdc2bb29ba647 (diff)
downloadorg.eclipse.rap-ed6c6588d1c0dd7490969537f447721258b93b2d.tar.gz
org.eclipse.rap-ed6c6588d1c0dd7490969537f447721258b93b2d.tar.xz
org.eclipse.rap-ed6c6588d1c0dd7490969537f447721258b93b2d.zip
Add JsDoc for Client, Slider and ScrolledComposite scripting
Diffstat (limited to 'bundles')
-rw-r--r--bundles/org.eclipse.rap.rwt/js/rwt/client/Client.js10
-rw-r--r--bundles/org.eclipse.rap.rwt/js/rwt/remote/handler/ScrolledCompositeHandler.js19
-rw-r--r--bundles/org.eclipse.rap.rwt/js/rwt/remote/handler/SliderHandler.js7
3 files changed, 30 insertions, 6 deletions
diff --git a/bundles/org.eclipse.rap.rwt/js/rwt/client/Client.js b/bundles/org.eclipse.rap.rwt/js/rwt/client/Client.js
index 4e9e2f4176..4f009a9579 100644
--- a/bundles/org.eclipse.rap.rwt/js/rwt/client/Client.js
+++ b/bundles/org.eclipse.rap.rwt/js/rwt/client/Client.js
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright: 2004, 2015 1&1 Internet AG, Germany, http://www.1und1.de,
+ * Copyright: 2004, 2017 1&1 Internet AG, Germany, http://www.1und1.de,
* and EclipseSource
*
* This program and the accompanying materials are made available under the
@@ -14,13 +14,13 @@
namespace( "rwt.client" );
/**
- * Basic client detection implementation.
- *
- * Version names follow the wikipedia scheme: major.minor[.revision[.build]] at
+ * @class Basic client detection implementation.
+ * @description Version names follow the wikipedia scheme: major.minor[.revision[.build]] at
* http://en.wikipedia.org/wiki/Software_version
- *
+ * Object can be obtained from {@link rap.getClient}.
* @public
* @since 3.2
+ * @exports rwt.client.Client as Client
*/
rwt.client.Client = {
diff --git a/bundles/org.eclipse.rap.rwt/js/rwt/remote/handler/ScrolledCompositeHandler.js b/bundles/org.eclipse.rap.rwt/js/rwt/remote/handler/ScrolledCompositeHandler.js
index b29db1eb30..36f61d47a4 100644
--- a/bundles/org.eclipse.rap.rwt/js/rwt/remote/handler/ScrolledCompositeHandler.js
+++ b/bundles/org.eclipse.rap.rwt/js/rwt/remote/handler/ScrolledCompositeHandler.js
@@ -55,11 +55,28 @@ rwt.remote.HandlerRegistry.add( "rwt.widgets.ScrolledComposite", {
listenerHandler : rwt.remote.HandlerUtil.extendControlListenerHandler( {} ),
- scriptingMethods : rwt.remote.HandlerUtil.extendControlScriptingMethods( {
+ /**
+ * @class RWT Scripting analoge to org.eclipse.swt.custom.ScrolledComposite
+ * @name ScrolledComposite
+ * @extends Control
+ * @description The constructor is not public.
+ * @since 3.2
+ */
+ scriptingMethods : rwt.remote.HandlerUtil.extendControlScriptingMethods(
+ /** @lends ScrolledComposite.prototype */
+ {
+ /**
+ * @description Sets the 'origin', which is the receiver's scroll position.
+ * @return {int, int} the origin
+ */
setOrigin : function(x, y) {
this.setHBarSelection( x );
this.setVBarSelection( y );
},
+ /**
+ * @description Returns the 'origin', which is the receiver's scroll position.
+ * @return {[int, int]} the origin
+ */
getOrigin : function() {
return [ this.getHorizontalBar().getValue(), this.getVerticalBar().getValue()];
}
diff --git a/bundles/org.eclipse.rap.rwt/js/rwt/remote/handler/SliderHandler.js b/bundles/org.eclipse.rap.rwt/js/rwt/remote/handler/SliderHandler.js
index 5476b5c578..1ebe16fc95 100644
--- a/bundles/org.eclipse.rap.rwt/js/rwt/remote/handler/SliderHandler.js
+++ b/bundles/org.eclipse.rap.rwt/js/rwt/remote/handler/SliderHandler.js
@@ -25,6 +25,13 @@ rwt.remote.HandlerRegistry.add( "rwt.widgets.Slider", {
properties : rwt.remote.HandlerUtil.extendControlProperties( [
"minimum",
"maximum",
+ /**
+ * @name setSelection
+ * @methodOf Slider#
+ * @description Sets the 'selection', which is the receiver's value, to the argument which
+ * must be greater than or equal to zero.
+ * @param {int} selection the new selection (must be zero or greater)
+ */
"selection",
"increment",
"pageIncrement",

Back to the top