< Jewel Components list

Jewel HGroup

Reference

Available since version 0.9.7.

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

Overview

The Jewel HGroup class is a Group that lays out elements horizontally and provides some properties to allow more flexibility like gap to define spacing between items, and itemsHorizontalAlign and itemsVerticalAlign to distribute elements in different ways along the horizontal or vertical axis.

Example of use

In MXML declare a HGroup like this:

<j:HGroup width="100%" height="300" gap="3" itemsHorizontalAlign="itemsCenter">
	<j:Card width="100" height="50%">
		<j:Label text="horz center"/>
	</j:Card>
	<j:Card width="100" height="50%">
		<j:Label text="horz center"/>
	</j:Card>
</j:HGroup>

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

var hg:HGroup = new HGroup();
// add a label to the HGroup
var label:Label = new Label();
label.text = "Some text";
hg.addElement(label);
// add the HGroup to the parent
parent.addElement(hg);

where parent is the container to which the HGroup will be added.

Relevant Properties and Methods

Check the Reference of org.apache.royale.jewel.HGroup 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 group is complete.

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

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

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

the initComplete event uses the initCompleteHandler callback function you provide in ActionScript:

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

When the group is initialized the message “HGroup is ready!” appears in the console log.

In ActionScript we can add an event handler this way:

var hg:HGroup = new HGroup();
hg.addEventListener('initComplete', initCompleteHandler);
parent.addElement(hg);

Relevant Beads

Optional Beads

More examples

• Using Jewel TileHorizontalLayout
• Using View States to show or hide content
• Customization through the Royale API

Related controls

Other useful Jewel containers components are:

• Group
• VGroup
• Container
• HContainer
• VContainer
• Card