Label

Guide for using labels in your applications

This guide will show how to use labels in your applications. See how easy it is to drag and drop labels onto your forms to show different types of information. Labels can be modified, styled, and even changed at runtime.

To see a live sample of the Label component you can go here.

Content under construction

Get Started

In the Form Editor, drag the Label component from the Pallet onto the form

Add Label

If the component does not appear in the pallet, it means you do not have the Bootstrap Components package installed. Click "Get more components" at the top of the pallet to open the Servoy Package Manager and install it.

Modifying a Label at Design-Time

Labels, like all components, have properties that can be modified at design time to set the appearance and behavior of the component. Select the label in the Form Editor to see a list of properties in the Component Properties Editor. Below are some common properties and how to set them at design time.

See the reference docs for Label for a complete list of its properties.

Setting the Text

The text displayed on a label can be modified by setting its text property, it can be entered directly on the component by double-clicking it or using the Text Property Editor.

The label text can be plain text, a locale-translated value when using i18n, HTML markup, or dynamic content when tags are used to display values from dataproviders like Table Columns, Calculations, Aggregations, Form Variables, or standard tags (i.e. %%selectedIndex%% as used in the screenshot above).

The text can also be a combination of all the options above and Servoy will simply calculate the final result before rendering the label.

Setting a Tooltip message

Labels, like many components, can display tooltip messages when a user hovers their cursor, this can be done by modifying the tooltipText property using the Text Property Editor.

The tooltip text, like the label text, can also be dynamic, data-driven, or localized.

Setting an Image / Font-Icon

Many times, a label will be decorated with an image or font icon. To add an image before the text of the label, edit the imageStyleClass property and choose the style class of the font icon you wish to use. For example, enter a value of fa fa-user to get a nice icon that represents a User.

In the same way, there is a trailingImageStyleClass property to add an image or icon after the text of the label.

For more information, please see the Font Icon section of the guide on Styling and Themes.

Styling

Like all components, a Label can be styled using themes, variants, and raw CSS. To apply any available style class, simply enter one or more space-delimited values for the styleClass property.

For example, styleClass="label-info"

Label Variants

If you are using Variants, then you can easily drag and drop variations of your label onto your form.

Add Label Variants to Form

Handling Events

Like most components, Labels have events, which allow you to execute some logic when something happens in the UI. Of course, the most common event for a label is the onAction event, which is triggered when the label is clicked or the user hits the Enter key while the label has focus.

To Handle the event, double-click the value for the onAction property in the Properties Editor. You will see the Method Selection Wizard. You'll have the option to select an existing Method or create a new Method. The method will be called when the label's onAction event is fired and the Event object will be passed to it.

Create method to handle the onAction event

/**
 * Click event. 
 * dataTarget parameter is used to identify inner html elements 
 * (by their data-target attribute).
 *
 * @param {JSEvent} event
 * @param {String} dataTarget
 *
 * @properties={typeid:24,uuid:"4FA50A53-70A6-4D14-83B8-EA3E675EBAEB"}
 */
function onAction(event, dataTarget) {
	// TODO Auto-generated method stub
}

See the Label reference for a comprehensive list of all events

Modifying a Label at Runtime

Labels, like many components, can be modified at runtime through code. Below are a few examples of controlling a Label from code.

Enabling / Disabling a label

You can easily change the enabled state of a Label at runtime.

function disableLabel(){
	elements.myLabel.enabled = false;
}

Hiding/Showing a Label

You can easily change the visible state of a Label at runtime.

function hideLabel(){
	elements.myLabel.visible = false;
}

Calling Label API Methods

Like most components, a Label has API methods which can be called from code. Below is an example of common API calls.

Add CSS Style Class

You can easily add a style class to a Label using the addStyleClass method.

function AddStyleClassLabel(){
	elements.myLabel.addStyleClass('mycssclass');
}

See the Label reference for a complete list of programmable properties and methods.

Related Articles

The following articles are recommended for additional reading

• Label Reference Documentation

• Styling and Themes

• Scripting the UI