Class ThemeEditorMessageHandler

java.lang.Object
com.vaadin.copilot.CopilotCommand
com.vaadin.copilot.plugins.themeeditor.ThemeEditorMessageHandler
All Implemented Interfaces:
HasSourceModifier, HasThemeModifier

public class ThemeEditorMessageHandler extends CopilotCommand implements HasSourceModifier, HasThemeModifier
Handler for ThemeEditor debug window communication messages. Responsible for preparing data for ThemeModifier and JavaSourceModifier.
  • Constructor Details

    • ThemeEditorMessageHandler

      public ThemeEditorMessageHandler()
  • Method Details

    • getSourceModifier

      public JavaSourceModifier getSourceModifier()
      Specified by:
      getSourceModifier in interface HasSourceModifier
    • getThemeModifier

      public ThemeModifier getThemeModifier()
      Specified by:
      getThemeModifier in interface HasThemeModifier
    • canHandle

      public boolean canHandle(String command, tools.jackson.databind.JsonNode data)
      Checks if given command can be handled by ThemeEditor.
      Parameters:
      command - command to be verified if supported
      data - data object to be verified if is of proper structure
      Returns:
      true if it can be handled, false otherwise
    • handleDebugMessageData

      public BaseResponse handleDebugMessageData(String command, tools.jackson.databind.JsonNode data)
      Handles debug message command and performs given action.
      Parameters:
      command - Command name
      data - Command data
      Returns:
      response in form of JsonNode
    • registerHandlers

      protected void registerHandlers()
    • handleMessage

      public boolean handleMessage(String command, tools.jackson.databind.JsonNode data, com.vaadin.base.devserver.DevToolsInterface devToolsInterface)
      Description copied from class: CopilotCommand
      Called whenever there is a message from the browser. Implementations should check if the command is for them, handle it and return true if the command was handled.
      Specified by:
      handleMessage in class CopilotCommand
      Parameters:
      command - the command to handle
      data - the data for the command
      devToolsInterface - the devtools interface for the connection
      Returns:
      true if the command was handled, false otherwise
    • canBeParallelCommand

      public boolean canBeParallelCommand(String command)
      Description copied from class: CopilotCommand
      Checks if given command can be handled asynchronously. If the handler can't be asynchronous at all, it can return false always. But if you want to handle one or more commands asynchronously, you should specify the exact command to prevent handling commands that are not part of the handler as asynchronous.
      Overrides:
      canBeParallelCommand in class CopilotCommand
      Parameters:
      command - the command to check
      Returns:
      true if the command can be handled by this command handler