org.vaadin.highlighter

Class ComponentHighlighterExtension

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

org.vaadin.highlighter.ComponentHighlighterExtension

All Implemented Interfaces:

com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Extension, com.vaadin.shared.Connector, Serializable

public class ComponentHighlighterExtension
extends com.vaadin.server.AbstractExtension

This extension adds an eye-catching label to an extended component on the client-side that displays the component's fully-qualified class name by default. This label will only be active when the application is running in Vaadin's debug mode. In production mode, the client-side component will not be touched.

The highlighting labels will not be visible right away. They first have to be activated by using Vaadin's debug URL parameter. You can either add ?debug to the current URL to make the labels visible. Or you can alternatively use ?debug=quiet to simultaneously hide Vaadin's debug console at the same time.

Author:

Roland Krüger

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Constructor Summary

Constructors

Constructor and Description
ComponentHighlighterExtension()
ComponentHighlighterExtension(com.vaadin.server.AbstractClientConnector target) Creates a new extension object and immediately extends the specified component.

Method Summary

Modifier and Type	Method and Description
void	extend(com.vaadin.server.AbstractClientConnector target) The given connector will only be extended with the highlighting label, if the application is currently being run in debug mode.
protected ComponentHighlighterState	getState()
void	setComponentDebugLabel(String label) Sets the text which will be displayed by the highlighting label.

Methods inherited from class com.vaadin.server.AbstractExtension

getSupportedParentType, remove, setParent

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, attach, beforeClientResponse, createState, detach, encodeState, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getParent, getResource, getRpcManager, getRpcProxy, getSession, getState, getStateType, getUI, handleConnectorRequest, hasListeners, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, attach, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getParent, getRpcManager, getStateType, getUI, handleConnectorRequest, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Detail

ComponentHighlighterExtension

public ComponentHighlighterExtension()

ComponentHighlighterExtension

public ComponentHighlighterExtension(com.vaadin.server.AbstractClientConnector target)

Creates a new extension object and immediately extends the specified component. The component will only be extended, when the application is running in Vaadin's debug mode.

Parameters:

target - Connector to be extended. This can be any connector provided that the corresponding widget will be rendered on the client-side in some sort of HTML container, such as a DIV. That is because the highlighting label's span-element will be added as the first child of that container. If null is given, nothing will be extended and no error will be thrown. This will have the same effect as calling the default constructor.

Method Detail

extend

public void extend(com.vaadin.server.AbstractClientConnector target)

The given connector will only be extended with the highlighting label, if the application is currently being run in debug mode. This operation will do nothing if running in production mode. More specifically, the client-side widget of the extended connector will not be touched when running in production mode.

The extended component will display its fully qualified class name in the highlighting label by default. This can be adjusted with method setComponentDebugLabel(String).

Overrides:

extend in class com.vaadin.server.AbstractExtension

getState

protected ComponentHighlighterState getState()

Overrides:

getState in class com.vaadin.server.AbstractClientConnector

setComponentDebugLabel

public void setComponentDebugLabel(String label)

Sets the text which will be displayed by the highlighting label. By default, this label shows the fully qualified class name of the extended component.

Parameters:

label - the new text for the highlighting label