com.vaadin.copilot.Copilot API 24.4.4 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.copilot.

java.lang.Object

com.vaadin.copilot.Copilot

All Implemented Interfaces:

DevToolsMessageHandler

public class Copilot extends Object implements DevToolsMessageHandler

Field Summary

Fields

Modifier and Type

Field

Description

static final String

PREFIX
Constructor Summary

Constructors

Constructor

Description

Copilot()
Method Summary

Modifier and Type

Method

Description

void

handleConnect(DevToolsInterface devToolsInterface)

Called when a browser connects.

boolean

handleMessage(String command, elemental.json.JsonObject data, DevToolsInterface devToolsInterface)

Called when a message from the browser arrives.

static boolean

isDevelopmentMode()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.base.devserver.DevToolsMessageHandler
handleDisconnect

Field Details
- PREFIX
  
  public static final String PREFIX
  See Also:
  
  Constant Field Values
Constructor Details
- Copilot
  
  public Copilot()
Method Details
- handleConnect
  
  public void handleConnect(DevToolsInterface devToolsInterface)
  
  Description copied from interface: DevToolsMessageHandler
  
  Called when a browser connects.
  This happens on each refresh but also when the application is opened in a new browser tab or window.
  
  Specified by:
  
  handleConnect in interface DevToolsMessageHandler
  
  Parameters:
  
  devToolsInterface - for interaction with the development tools, e.g. sending a message
- handleMessage
  
  public boolean handleMessage(String command, elemental.json.JsonObject data, DevToolsInterface devToolsInterface)
  
  Description copied from interface: DevToolsMessageHandler
  
  Called when a message from the browser arrives.
  
  Specified by:
  
  handleMessage in interface DevToolsMessageHandler
  
  Parameters:
  
  command - the command received
  
  data - the data received
  
  devToolsInterface - for interaction with the development tools, e.g. sending a message
  
  Returns:
  
  true if the message was handled and should not be passed on to further handlers
- isDevelopmentMode
  
  public static boolean isDevelopmentMode()