< Jewel Components list

Jewel ResponsiveView

Reference

Available since version 0.9.4.

^{Note: This component is currently only available for JavaScript.}

Overview

ResponsiveView is the class used as the initialView in a responsive Royale Jewel Application. It is generally used as the root tag of MXML documents, and UI controls and containers are added to it.

It normaly can host a TopAppBar, FooterBar, Drawer and a ApplicationMainContent with other organized content for navigation.

For non-responsive applications you can use just a simple View instead.

Example of use

In MXML declare a ResponsiveView like this:

<j:ResponsiveView xmlns:fx="http://ns.adobe.com/mxml/2009" 
    xmlns:j="library://ns.apache.org/royale/jewel">

    <!-- ResponsiveView code goes here -->
</j:ResponsiveView>

ResponsiveView doesn’t need to specify width or height since they are both sized 100% by default. In this way we can use the width of the application container to apply responsive rules on any part of the application.

You can also set the ResponsiveView directly in the application mxml file inside the initialView:

<j:Application xmlns:fx="http://ns.adobe.com/mxml/2009" 
    xmlns:j="library://ns.apache.org/royale/jewel">
    ...
    <j:initialView>
        <j:ResponsiveView>
            <!-- ResponsiveView code goes here -->
        </j:ResponsiveView>
    </j:initialView>
</j:Application>

In ActionScript we can do the same in the following way:

// instantiate the view
var responsiveView:ResponsiveView = new ResponsiveView();
// add content to the view and and add to application's initialView
application.initialView = responsiveView;

where application is the Jewel Application.

Relevant Properties and Methods

Check the Reference of org.apache.royale.jewel.ResponsiveView for a more detailed list of properties and methods.

Properties

Methods

Relevant Events

The most important event is initComplete, which indicates that initialization of the view is complete.

It is needed when some action coded in a callback function needs to be triggered when the view is ready to use after initialization.

You can attach callback listeners to the initComplete event in MXML as follows:

<j:ResponsiveView initComplete="initCompleteHandler(event)"/>

the initComplete event will use the initCompleteHandler callback function you provide in ActionScript:

<fx:Script>
    <![CDATA[      
        private function initCompleteHandler(event:Event):void {
            trace("ResponsiveView is ready!");
        }
    ]]>
</fx:Script>

When the view is initialized the message “ResponsiveView is ready!” appears in the console log.

In ActionScript we can add an event handler this way:

var rv:ResponsiveView = new ResponsiveView();
rv.addEventListener('initComplete', initCompleteHandler);

Relevant Beads

Optional Beads

More examples

• Creating a Hello World in Apache Royale
• Using the Jewel Alert Control
• Using View States to show or hide content

Related controls

Other useful Jewel view components are:

• View
• Application