You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by pe...@apache.org on 2017/10/23 16:13:23 UTC
[royale-asjs] branch develop updated: Added more ASDoc tags to
components.
This is an automated email from the ASF dual-hosted git repository.
pent pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-asjs.git
The following commit(s) were added to refs/heads/develop by this push:
new 441b1e7 Added more ASDoc tags to components.
441b1e7 is described below
commit 441b1e735e2bad848757ee09bfb63d13a18f69f8
Author: Peter Ent <pe...@apache.org>
AuthorDate: Mon Oct 23 12:13:20 2017 -0400
Added more ASDoc tags to components.
---
.../org/apache/royale/express/Application.as | 14 +++++++++--
.../royale/org/apache/royale/express/Container.as | 20 +++++++++------
.../org/apache/royale/express/ImageButton.as | 15 +++++++----
.../royale/org/apache/royale/express/TextButton.as | 29 +++++++++++++---------
4 files changed, 52 insertions(+), 26 deletions(-)
diff --git a/frameworks/projects/Express/src/main/royale/org/apache/royale/express/Application.as b/frameworks/projects/Express/src/main/royale/org/apache/royale/express/Application.as
index 46b4b5b..24be184 100644
--- a/frameworks/projects/Express/src/main/royale/org/apache/royale/express/Application.as
+++ b/frameworks/projects/Express/src/main/royale/org/apache/royale/express/Application.as
@@ -21,17 +21,27 @@ package org.apache.royale.express
import org.apache.royale.binding.ApplicationDataBinding;
import org.apache.royale.core.Application;
import org.apache.royale.core.AllCSSValuesImpl;
-
+
/**
* This class extends the standard Application and sets up the
* SimpleCSSValuesImpl (implementation) for convenience.
+ *
+ * @flexcomponent spark.components.Application
+ * @flexdocurl https://flex.apache.org/asdoc/spark/components/Application.html
+ * @commentary Unlike Flex Application, Royale Application does not provide a user interface container. Instead, you create an instance of org.apache.royale.express.View as the Application's initialView property.
+ * @commentary The Express version of Application pre-packages some additional beads.
+ * @example <js:Application>
+ * @example <js:initialView>
+ * @example <local:MyInitialView />
+ * @example </js:initialView>
+ * @example </js:Application>
*/
public class Application extends org.apache.royale.core.Application
{
public function Application()
{
super();
-
+
this.valuesImpl = new AllCSSValuesImpl();
addBead(new ApplicationDataBinding());
}
diff --git a/frameworks/projects/Express/src/main/royale/org/apache/royale/express/Container.as b/frameworks/projects/Express/src/main/royale/org/apache/royale/express/Container.as
index e2812de..14653ba 100644
--- a/frameworks/projects/Express/src/main/royale/org/apache/royale/express/Container.as
+++ b/frameworks/projects/Express/src/main/royale/org/apache/royale/express/Container.as
@@ -21,34 +21,40 @@ package org.apache.royale.express
import org.apache.royale.binding.ContainerDataBinding;
import org.apache.royale.html.Container;
import org.apache.royale.html.supportClasses.ScrollingViewport;
-
+
import org.apache.royale.core.BindableCSSStyles;
import org.apache.royale.core.StyleChangeNotifier;
-
+
COMPILE::SWF {
import org.apache.royale.html.beads.SolidBackgroundWithChangeListenerBead;
import org.apache.royale.html.beads.SingleLineBorderWithChangeListenerBead;
}
-
+
/**
* This class extends the standard Container and adds the
* ContainerDataBinding bead and ScrollingViewport beads for
* convenience.
+ *
+ * @flexcomponent spark.components.Group
+ * @flexdocurl https://flex.apache.org/asdoc/spark/components/Group.html
+ * @commentary In the Royale Express package, data binding is prepackaged into the Container component.
+ * @commentary Royale Express Container also includes support for scrolling.
+ * @commentary Royale Express also provides HContainer (horizontal layout) and VContainer (vertical layout) for convenience.
*/
public class Container extends org.apache.royale.html.Container
{
public function Container()
{
super();
-
+
var wasStyle:Object = style;
-
+
style = new BindableCSSStyles();
-
+
addBead(new ContainerDataBinding());
addBead(new ScrollingViewport());
addBead(new StyleChangeNotifier());
-
+
COMPILE::SWF {
addBead(new SolidBackgroundWithChangeListenerBead());
addBead(new SingleLineBorderWithChangeListenerBead());
diff --git a/frameworks/projects/Express/src/main/royale/org/apache/royale/express/ImageButton.as b/frameworks/projects/Express/src/main/royale/org/apache/royale/express/ImageButton.as
index d3dd889..9a305aa 100644
--- a/frameworks/projects/Express/src/main/royale/org/apache/royale/express/ImageButton.as
+++ b/frameworks/projects/Express/src/main/royale/org/apache/royale/express/ImageButton.as
@@ -21,10 +21,15 @@ package org.apache.royale.express
import org.apache.royale.events.Event;
import org.apache.royale.html.ImageButton;
import org.apache.royale.html.accessories.ToolTipBead;
-
+
/**
* This class extends ImageButton and adds the toolTip bead
* as a convenience.
+ *
+ * @flexcomponent spark.components.Button
+ * @flexdocurl https://flex.apache.org/asdoc/spark/components/Button.html
+ * @commentary In Royale, buttons that uses images should either be an ImageButton or a ImageAndTextButton.
+ * @commentary This class includes <ul><li>toolTip: String</li><li>enabled: Boolean</li></ul> properties.
*/
public class ImageButton extends org.apache.royale.html.ImageButton
{
@@ -32,9 +37,9 @@ package org.apache.royale.express
{
super();
}
-
+
private var _toolTipBead:ToolTipBead = null;
-
+
[Bindable("toolTipChanged")]
/**
* Displays a hint when the mouse hovers over the button
@@ -51,13 +56,13 @@ package org.apache.royale.express
public function set toolTip(value:String):void
{
_toolTipBead = getBeadByType(ToolTipBead) as ToolTipBead;
-
+
if (_toolTipBead == null) {
_toolTipBead = new ToolTipBead();
addBead(_toolTipBead);
}
_toolTipBead.toolTip = value;
-
+
dispatchEvent(new Event("toolTipChanged"));
}
}
diff --git a/frameworks/projects/Express/src/main/royale/org/apache/royale/express/TextButton.as b/frameworks/projects/Express/src/main/royale/org/apache/royale/express/TextButton.as
index 77579f3..b8b6738 100644
--- a/frameworks/projects/Express/src/main/royale/org/apache/royale/express/TextButton.as
+++ b/frameworks/projects/Express/src/main/royale/org/apache/royale/express/TextButton.as
@@ -26,6 +26,11 @@ package org.apache.royale.express
/**
* This class extends TextButton and adds the toolTip bead
* as a convenience.
+ *
+ * @flexcomponent spark.components.Button
+ * @flexdocurl https://flex.apache.org/asdoc/spark/components/Button.html
+ * @commentary The Royale Express TextButton is pre-packaged with beads to do:
+ * @commentary <ul><li>enabled: Boolean</li><li>toolTip: String</li><li>secure: Boolean</li></ul>See also the Royale Express ImageButton and the Royale Express ImageAndTextButton.
*/
public class TextButton extends org.apache.royale.html.TextButton
{
@@ -33,11 +38,11 @@ package org.apache.royale.express
{
super();
}
-
+
private var _disableBead:DisableBead;
private var _enabled:Boolean = true;
private var _toolTipBead:ToolTipBead = null;
-
+
[Bindable("enabledChanged")]
/**
* Can enable or disable interaction with the control.
@@ -51,19 +56,19 @@ package org.apache.royale.express
public function set enabled(value:Boolean):void
{
_enabled = value;
-
+
_disableBead = getBeadByType(DisableBead) as DisableBead;
-
+
if (_disableBead == null) {
_disableBead = new DisableBead();
addBead(_disableBead);
}
-
+
_disableBead.disabled = !value;
-
+
dispatchEvent(new Event("enabledChanged"));
}
-
+
[Bindable("enabledChanged")]
/**
* Can enable or disable interaction with the control.
@@ -77,14 +82,14 @@ package org.apache.royale.express
override public function set enabled(value:Boolean):void
{
_enabled = value;
-
+
if (_disableBead == null) {
_disableBead = new DisableBead();
addBead(_disableBead);
}
-
+
_disableBead.disabled = !value;
-
+
dispatchEvent(new Event("enabledChanged"));
}
@@ -104,13 +109,13 @@ package org.apache.royale.express
public function set toolTip(value:String):void
{
_toolTipBead = getBeadByType(ToolTipBead) as ToolTipBead;
-
+
if (_toolTipBead == null) {
_toolTipBead = new ToolTipBead();
addBead(_toolTipBead);
}
_toolTipBead.toolTip = value;
-
+
dispatchEvent(new Event("toolTipChanged"));
}
}
--
To stop receiving notification emails like this one, please contact
['"commits@royale.apache.org" <co...@royale.apache.org>'].