< Jewel Components list

Jewel Label

Reference

Available since version 0.9.4.

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

Overview

The Jewel Label implements the Jewel control for single and multi line text labels. It dispatches a click event when the user clicks over it.

Example of use

In MXML declare a Label like this:

<j:Label/>

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

var label:Label = new Label();
parent.addElement(label);

where parent is the container where the control will be added.

Here is an example of the default label:

code here

Relevant Properties and Methods

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

Properties

Methods

None.

Relevant Events

The Label has a click event of type org.apache.royale.events.Event. This event is dispatched when the user clicks the control and triggers some action coded in a callback function. Programmatic changes will not trigger this event.

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

<j:Label click="clickHandler(event)"/>

the click event will use the clickHandler callback function you provide in ActionScript:

<fx:Script>
    <![CDATA[      
        private function clickHandler(event:Event):void {
            trace("You clicked the label!");
        }
    ]]>
</fx:Script>

When the user clicks the label, the message “You clicked the label!” appears in the console log.

In ActionScript we can add an event handler this way:

var label:Label = new Label();
label.addEventListener('click', clickHandler);
parent.addElement(label);

Relevant Beads

Unlike other components in Royale, the Jewel Label does not have beads for View pr Controller in the JavaScript platform, but has Model.

Jewel does not have beads specially crafted for this control, but it can use other common Jewel control beads (shared with other controls) to provide more functionality.

Label Beads

None

Common Beads

More examples

• Binding the text property of a Jewel Label to update a text Label