You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by ca...@apache.org on 2020/08/22 16:23:45 UTC
[royale-asjs] branch develop updated: jewel-views: refactor and docs
This is an automated email from the ASF dual-hosted git repository.
carlosrovira 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 4ffccd1 jewel-views: refactor and docs
4ffccd1 is described below
commit 4ffccd1de472da943cea115609751990eb524eec
Author: Carlos Rovira <ca...@apache.org>
AuthorDate: Sat Aug 22 18:23:31 2020 +0200
jewel-views: refactor and docs
---
.../royale/jewel/ApplicationResponsiveView.as | 55 +---------------------
.../main/royale/org/apache/royale/jewel/View.as | 18 ++++---
.../royale/jewel/supportClasses/view/ViewBase.as | 27 ++++-------
3 files changed, 24 insertions(+), 76 deletions(-)
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/ApplicationResponsiveView.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/ApplicationResponsiveView.as
index 6c7bfee..4c4b1fa 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/ApplicationResponsiveView.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/ApplicationResponsiveView.as
@@ -18,10 +18,7 @@
////////////////////////////////////////////////////////////////////////////////
package org.apache.royale.jewel
{
- import org.apache.royale.core.IApplicationView;
- import org.apache.royale.core.IPopUpHost;
- import org.apache.royale.core.IPopUpHostParent;
- import org.apache.royale.events.Event;
+ import org.apache.royale.jewel.View;
/**
* The ApplicationResponsiveView class is the main Container component capable of parenting other
@@ -34,7 +31,7 @@ package org.apache.royale.jewel
* @playerversion AIR 2.6
* @productversion Royale 0.9.4
*/
- public class ApplicationResponsiveView extends Group implements IPopUpHost, IPopUpHostParent, IApplicationView
+ public class ApplicationResponsiveView extends View
{
/**
* constructor.
@@ -50,53 +47,5 @@ package org.apache.royale.jewel
typeNames = "applicationResponsiveView";
}
-
- private var _applicationModel:Object;
-
- [Bindable("modelChanged")]
- /**
- * A reference to the Application's model. Usually,
- * a view is displaying the main model for an
- * application.
- *
- * @langversion 3.0
- * @playerversion Flash 10.2
- * @playerversion AIR 2.6
- * @productversion Royale 0.9.4
- */
- public function get applicationModel():Object
- {
- return _applicationModel;
- }
-
- /**
- * @private
- */
- public function set applicationModel(value:Object):void
- {
- _applicationModel = value;
- dispatchEvent(new Event("modelChanged"));
- }
-
- /**
- * ViewBase can host popups but they will be in the layout, if any
- *
- * @langversion 3.0
- * @playerversion Flash 10.2
- * @playerversion AIR 2.6
- * @productversion Royale 0.0
- */
- public function get popUpParent():IPopUpHostParent
- {
- return this;
- }
-
- /**
- */
- public function get popUpHost():IPopUpHost
- {
- return this;
- }
-
}
}
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/View.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/View.as
index 5f03abe..4ca4da7 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/View.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/View.as
@@ -21,8 +21,8 @@ package org.apache.royale.jewel
import org.apache.royale.core.IMXMLDocument;
import org.apache.royale.core.ValuesManager;
import org.apache.royale.events.Event;
- import org.apache.royale.utils.MXMLDataInterpreter;
import org.apache.royale.jewel.supportClasses.view.ViewBase;
+ import org.apache.royale.utils.MXMLDataInterpreter;
/**
* The default property uses when additional MXML content appears within an element's
@@ -30,10 +30,14 @@ package org.apache.royale.jewel
*/
[DefaultProperty("mxmlContent")]
- /**
- * The View class is the class for most views in a Royale
- * application. It is generally used as the root tag of MXML
+ /**
+ * The View class is the class used as the initialView in a Royale Jewel
+ * Application. It is generally used as the root tag of MXML
* documents and UI controls and containers are added to it.
+ *
+ * For responsive applications you can use ApplicationResponsiveView instead.
+ *
+ * @see org.apache.royale.jewel.ApplicationResponsiveView
*
* @langversion 3.0
* @playerversion Flash 10.2
@@ -45,6 +49,8 @@ package org.apache.royale.jewel
public function View()
{
super();
+
+ typeNames = "jewel view";
}
private var _mxmlDescriptor:Array;
@@ -71,8 +77,6 @@ package org.apache.royale.jewel
dispatchEvent(new Event("initBindings"));
dispatchEvent(new Event("initComplete"));
_initialized = true;
-
- // - why was this added here? childrenAdded(); //?? Is this necessary since MXMLDataInterpreter will already have called it
}
}
@@ -112,6 +116,8 @@ package org.apache.royale.jewel
}
/**
+ * The array of childs for this view. Is the `DefaultProperty`.
+ *
* @copy org.apache.royale.core.ItemRendererClassFactory#mxmlContent
*
* @langversion 3.0
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/view/ViewBase.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/view/ViewBase.as
index 96c2ec4..63ad3da 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/view/ViewBase.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/view/ViewBase.as
@@ -37,20 +37,18 @@ package org.apache.royale.jewel.supportClasses.view
* @langversion 3.0
* @playerversion Flash 10.2
* @playerversion AIR 2.6
- * @productversion Royale 0.0
+ * @productversion Royale 0.9.7
*/
[Event(name="initComplete", type="org.apache.royale.events.Event")]
- [DefaultProperty("mxmlContent")]
-
/**
- * The ViewBase class is the base class for most views in a Royale
- * application.
+ * The Jewel ViewBase class is the base class for most views in a Royale
+ * Jewel application.
*
* @langversion 3.0
* @playerversion Flash 10.2
* @playerversion AIR 2.6
- * @productversion Royale 0.0
+ * @productversion Royale 0.9.7
*/
public class ViewBase extends GroupBase implements IPopUpHost, IPopUpHostParent, IApplicationView
{
@@ -60,19 +58,14 @@ package org.apache.royale.jewel.supportClasses.view
* @langversion 3.0
* @playerversion Flash 10.2
* @playerversion AIR 2.6
- * @productversion Royale 0.0
+ * @productversion Royale 0.9.7
*/
public function ViewBase()
{
super();
-
- typeNames = "royale";
}
private var _applicationModel:Object;
-
- [Bindable("modelChanged")]
-
/**
* A reference to the Application's model. Usually,
* a view is displaying the main model for an
@@ -81,13 +74,13 @@ package org.apache.royale.jewel.supportClasses.view
* @langversion 3.0
* @playerversion Flash 10.2
* @playerversion AIR 2.6
- * @productversion Royale 0.0
+ * @productversion Royale 0.9.7
*/
+ [Bindable("modelChanged")]
public function get applicationModel():Object
{
return _applicationModel;
}
-
/**
* @private
*/
@@ -98,12 +91,12 @@ package org.apache.royale.jewel.supportClasses.view
}
/**
- * ViewBase can host popups but they will be in the layout, if any
+ * A view can be the parent of a popup that will be part of the layout.
*
* @langversion 3.0
* @playerversion Flash 10.2
* @playerversion AIR 2.6
- * @productversion Royale 0.0
+ * @productversion Royale 0.9.7
*/
public function get popUpParent():IPopUpHostParent
{
@@ -111,11 +104,11 @@ package org.apache.royale.jewel.supportClasses.view
}
/**
+ * A view can host popups that will be part of the layout.
*/
public function get popUpHost():IPopUpHost
{
return this;
}
-
}
}