This is an automated email from the ASF dual-hosted git repository.
carlosrovira pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
The following commit(s) were added to refs/heads/master by this push:
new da47150 add jewel application
da47150 is described below
commit da4715094fcc72dbb29e7957561351546e28e0b8
Author: Carlos Rovira <[email protected]>
AuthorDate: Fri Aug 14 10:57:08 2020 +0200
add jewel application
---
_sass/markdown.sass | 1 +
component-sets/jewel.md | 3 +-
component-sets/jewel/jewel-application.md | 67 +++++++++++++++++++++++++++++++
3 files changed, 70 insertions(+), 1 deletion(-)
diff --git a/_sass/markdown.sass b/_sass/markdown.sass
index 4a27dac..eacf7e9 100644
--- a/_sass/markdown.sass
+++ b/_sass/markdown.sass
@@ -32,6 +32,7 @@ table th
table td, table th
border: 1px solid darken(#dfe2e5, 5%)
padding: 6px 13px
+ vertical-align: top
table tr
diff --git a/component-sets/jewel.md b/component-sets/jewel.md
index b3bbf4c..b5c716f 100644
--- a/component-sets/jewel.md
+++ b/component-sets/jewel.md
@@ -57,7 +57,8 @@ If the component name is a link, you can click it to see more
information about
| Type | Name
| Description
| Available SDK | State |
|------------------ |------------------------------------------------------
|---------------------------------------------------------------------------------
|------------------ |-------------- |
-| __Containers__ | ButtonBar
| Container that displays a series of buttons
| 0.9.7 | Complete |
+| __Containers__ | [Aplication](component-sets/jewel/application)
| The root container of a Jewel
Application | 0.9.4 | Complete
|
+| | ButtonBar
| Container that displays a series of buttons
| 0.9.7 | Complete |
| | Card |
Content (text, images,...) container with optional title and actions zones
| 0.9.4 | Complete |
| | [Container](component-sets/jewel/container) |
Container that surrounds other components
| 0.9.4 | Complete |
| | [DataContainer](component-sets/jewel/datacontainer) | A
Container that creates child elements dynamically based on a data provider
| 0.9.4 | Complete |
diff --git a/component-sets/jewel/jewel-application.md
b/component-sets/jewel/jewel-application.md
new file mode 100644
index 0000000..1fdd45e
--- /dev/null
+++ b/component-sets/jewel/jewel-application.md
@@ -0,0 +1,67 @@
+---
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+layout: docpage
+title: Jewel Application
+description: The Jewel Application
+permalink: /component-sets/jewel/application
+---
+[< Jewel Components list](component-sets/jewel/application)
+
+# Jewel Application
+
+## Reference
+
+Available since version __0.9.4__.
+
+| Class | Extends |
Implements |
+|------------------------------ |----------------------------------
|--------------------------------- |
+|
[org.apache.royale.jewel.Application](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel/Application){:target='_blank'}
|
[ApplicationBase](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/ApplicationBase){:target='_blank'}
|
[IStrand](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IStrand){:target='_blank'},
[IParent](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IParent){:target='_blank'},
[IEventDispatcher]( [...]
+
+<sup>_Note: This component is currently only available for JavaScript._</sup>
+
+## Overview
+
+The Application class is the main class and entry point for a Royale
application and does not contain user interface elements. Those UI elements go
in the view ([Jewel
ViewBase](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.supportClasses.view/ViewBase){:target='_blank'}).
This Application class expects there to be a main __model__, a __controller__,
and an __initial view__.
+
+Jewel Application holds specific Jewel needs in a Royale Application. This
class extends the standard ApplicationBase and sets up the
[AllCSSValuesImpl](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/AllCSSValuesImpl){:target='_blank'}
implementation for convenience.
+
+## Example of use
+
+In __MXML__ declare a `Application` as the root tag of the main application
file like this:
+
+```mxml
+<j:Application xmlns:fx="http://ns.adobe.com/mxml/2009";
+ xmlns:j="library://ns.apache.org/royale/jewel">
+
+ <!-- Application code goes here -->
+</j:Application>
+```
+
+If the filaname is `App.mxml`, building the application will generate the
following code in the `index.html` file:
+
+```javascript
+<script type="text/javascript">
+ new App().start();
+</script>
+```
+
+launching the the html file in a browser will execute the Jewel Royale
Application.
+
+## Relevant Properties and Methods
+
+> Check the Reference of
[org.apache.royale.jewel.Application](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel/Application){:target='_blank'}
for a more detailed list of properties and methods.
+
