Documentation versions (currently viewingVaadin 24)

Detecting Component Mappings

How to detect whether a component is part of a template.

You can detect whether a component is part of a template by using the isTemplateMapped() method.

This is useful if you want to execute custom logic depending on whether the component was mapped in a template (injected via the @Id or annotation) or, for example, created directly using one of its constructors.

Example: Calling the isTemplateMapped() method in MyComponent.

public class MyComponent extends Div {

  public MyComponent() {
    if (!isTemplateMapped()) {
      getElement().getStyle().set("color", "red");

By default, the component only sets a style when the component isn’t part of a template.

See Binding Template Components for more about @Id mappings.