ComponentHighlighter

Extension for decorating a component with a debug info label

View larger

Close

The add-on provides a component extension which will highlight the extended component in the browser with an eye-catching label containing the fully qualified class name of the extended component or a user-defined text. By that, you can see which part of your UI is implemented by which Java class directly in the browser. The extension is only active when the Vaadin application is run in debug mode. In production mode, the add-on will have no effect.

The file download contains all JavaDocs and documentation.

Sample code

public class MyComponent extends CustomComponent {
    ...
    public MyComponent() {
        super();
        new ComponentHighlighterExtension(this);
        ...
    }
}

String templateName = "mytemplate";
CustomLayout layout = new CustomLayout(templateName);

new ComponentHighlighterExtension (layout)
    .setComponentDebugLabel (
          CustomLayout.class.getName ()
          + " (template name: " + templateName + ".html)");

Links

• Blog Post
• Documentation
• Issue Tracker
• Source Code
• Discussion Forum

Compatibility