Skip to main content


Java API

The Label class is used to create a label object which shows static text.


The Label component is a static text UI component that is commonly used in applications to display descriptive or informational text. It serves as a visual element that provides context, identifies UI elements, or presents information to the user. The Label component is highly versatile and can be used in various scenarios throughout an application. Some common usages of the Label component include:

  1. Form Labels: Labels are frequently used alongside form fields to describe the purpose or expected input for a particular field. They improve usability and accessibility by providing clear instructions or hints to users. For example, you can use Labels in registration forms, contact forms, or search forms to identify input fields like name, email, address, or search query.

  2. Data Display: Labels are useful for displaying static information or labeling data elements in different sections of an application. They can be used to present user profiles, product details, or any other information that needs proper identification or description.

  3. Navigation: Labels can be employed in navigation menus, sidebars, or tabs to indicate the purpose or destination of a particular navigation item. They help users understand the function of each navigation option and improve the overall user experience.

  4. Headers and Section Titles: Labels can be used as section titles or headers to organize content and provide clear delineation between different sections or blocks of information. They enhance the readability and structure of the user interface.


The Label class has three constructors:

  1. Label(): Creates an empty label.
  2. Label(String text): Creates a label with the specified text.
  3. Label(String text, boolean wrap): Creates a label with the specified text and sets whether or not the text should be wrapped. More detail about line wrapping can be found here.

Here's an example of how to create a Label object using each constructor:

// Creates an empty label.
Label emptyLabel = new Label();

// Creates a label with the specified text.
Label textLabel = new Label("Hello, world!");

// Creates a label with the specified text and sets whether or not the text should be wrapped.
Label wrappedLabel = new Label("Lorem ipsum dolor sit amet, consectetur adipiscing elit.", true);

HTML Injection

In addition to using the label as static text, it can also be used as an HTML tag within your code. Simply set the label's content to the desired HTML tag with the various attributes, class names, etc, and the label will be replaced with the desired HTML element.

Show Code

Line Wrapping

The line wrap method for a Label component sets whether or not the component automatically wraps the text within the label onto multiple lines when it exceeds the available width, ensuring that the entire text is visible without overflowing the container. Setting this value to false will truncate any text that falls out of the component's bounds. This helps manipulate readability and truncation of longer text content within the label. The default value for lineWrap is true.

Show Code


The Label class implements the TextAlignable interface, which allows you to set the text alignment of the label. The possible alignment values are Alignment.LEFT, Alignment.MIDDLE, and Alignment.RIGHT. To set the alignment, use the setTextAlignment method:

Show Code


The Label class provides methods to add and remove event listeners for the following events:

An event that is triggered when the mouse cursor enters the boundaries of a component.
An event that is triggered when the mouse cursor exits the boundaries of a component.
An event that is triggered when the user presses the right mouse button while the cursor is over a component.

Adding Events

To add an event listener, use the appropriate method:

myLabel.addMouseEnterListener( e -> {
//Executed when the event fires

Additional syntactic sugar methods, or aliases, have been added to allow for alternative addition of events by using the on prefix followed by the event, such as:

myLabel.onMouseEnter( e -> {
//Executed when the event fires

Using the event payload that comes with various events to attain information reduces the number of round trips made when instead querying the component for the required information.

Removing Events

To remove an event listener, use the appropriate method:



Here is an example of how to use the Label class to create a simple UI component which allows the user to hover over the text to change the message:

Show Code