Package io.jmix.flowui.kit.component.codeeditor

Class JmixCodeEditor

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.AbstractField<C,T>
com.vaadin.flow.component.AbstractSinglePropertyField<JmixCodeEditor,String>
io.jmix.flowui.kit.component.codeeditor.JmixCodeEditor
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<JmixCodeEditor>, com.vaadin.flow.component.CompositionNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<JmixCodeEditor>, com.vaadin.flow.component.FocusNotifier<JmixCodeEditor>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<JmixCodeEditor,String>,String>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<JmixCodeEditor,String>,String>, com.vaadin.flow.component.InputNotifier, com.vaadin.flow.component.KeyNotifier, com.vaadin.flow.component.shared.HasClientValidation, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, com.vaadin.flow.data.binder.HasValidator<String>, HasTitle, Serializable
Direct Known Subclasses:
CodeEditor
@Tag("jmix-code-editor") @NpmPackage(value="ace-builds", version="1.39.0") @JsModule("./src/code-editor/jmix-code-editor.js") public class JmixCodeEditor extends com.vaadin.flow.component.AbstractSinglePropertyField<JmixCodeEditor,String> implements com.vaadin.flow.component.CompositionNotifier, com.vaadin.flow.component.Focusable<JmixCodeEditor>, com.vaadin.flow.component.shared.HasClientValidation, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, HasTitle, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, com.vaadin.flow.data.binder.HasValidator<String>, com.vaadin.flow.component.InputNotifier, com.vaadin.flow.component.KeyNotifier
Code Editor is a multi-line text area to display and enter source code featured with code highlighting and optional print margin and gutter with line numbers.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    JmixCodeEditor.JmixCodeEditorValueChangedEvent
    An event fired when the value of a JmixCodeEditor changes.

    Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

    com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V extends Object>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

    com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

    com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.shared.HasClientValidation

    com.vaadin.flow.component.shared.HasClientValidation.ClientValidatedEvent

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

    com.vaadin.flow.component.HasValue.ValueChangeEvent<V extends Object>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final String
    CODE_EDITOR_VALUE_CHANGED_EVENT
     
    protected static final String
    FONT_SIZE_DEFAULT_VALUE
     
    protected elemental.json.JsonFactory
    jsonFactory
     
    protected com.fasterxml.jackson.databind.ObjectMapper
    objectMapper
     
    protected static final int
    PRINT_MARGIN_COLUMN_DEFAULT_VALUE
     
    protected static final String
    PROPERTY_FONT_SIZE
     
    protected static final String
    PROPERTY_HIGHLIGHT_ACTIVE_LINE
     
    protected static final String
    PROPERTY_HIGHLIGHT_GUTTER_LINE
     
    protected static final String
    PROPERTY_MODE
     
    protected static final String
    PROPERTY_PRINT_MARGIN_COLUMN
     
    protected static final String
    PROPERTY_SHOW_GUTTER
     
    protected static final String
    PROPERTY_SHOW_LINE_NUMBERS
     
    protected static final String
    PROPERTY_SHOW_PRINT_MARGIN
     
    protected static final String
    PROPERTY_TEXT_WRAP
     
    protected static final String
    PROPERTY_THEME
     
    protected static final String
    PROPERTY_THEME_CHANGED_EVENT
     
    protected static final String
    PROPERTY_USE_SOFT_TABS
     
    protected static final String
    PROPERTY_VALUE
     
    protected Suggester
    suggester
     
    protected CodeEditorValidationSupport
    validationSupport
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    JmixCodeEditor()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addValidationStatusChangeListener(com.vaadin.flow.data.binder.ValidationStatusChangeListener<String> listener)
     
    com.vaadin.flow.data.binder.Validator<String>
    getDefaultValidator()
     
    String
    getEmptyValue()
     
    String
    getFontSize()
     
    protected elemental.json.JsonFactory
    getJsonFactory()
     
    CodeEditorMode
    getMode()
     
    protected com.fasterxml.jackson.databind.ObjectMapper
    getObjectMapper()
     
    int
    getPrintMarginColumn()
     
    Suggester
    getSuggester()
     
    protected elemental.json.JsonValue
    getSuggestions(String value, Double cursorPosition, String prefix)
    Returns a serialized list of suggestions for the client-side.
    String
    getSuggestOn()
     
    CodeEditorTheme
    getTheme()
     
    protected CodeEditorValidationSupport
    getValidationSupport()
     
    protected void
    handleValueChanged(boolean isFromClient, String newValue)
     
    protected void
    initComponent()
     
    boolean
    isDefaultSuggestionsEnabled()
     
    boolean
    isHighlightActiveLine()
     
    boolean
    isHighlightGutterLine()
     
    boolean
    isLiveSuggestionsEnabled()
     
    boolean
    isRequired()
    Determines whether the field is marked as input required.
    boolean
    isShowGutter()
     
    boolean
    isShowLineNumbers()
     
    boolean
    isShowPrintMargin()
     
    boolean
    isTextWrap()
     
    boolean
    isUseSoftTabs()
     
    protected void
    onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
     
    protected void
    onCodeEditorValueChangedEvent(JmixCodeEditor.JmixCodeEditorValueChangedEvent event)
     
    protected elemental.json.JsonValue
    serialize(Object object)
     
    void
    setDefaultSuggestionsEnabled(boolean defaultSuggestionsEnabled)
    Sets whether default suggestions based on the current editor mode are enabled.
    void
    setFontSize(String fontSize)
    Sets the font size for code in the editor.
    void
    setHighlightActiveLine(boolean highlightActiveLine)
    Sets the highlight of the active line.
    void
    setHighlightGutterLine(boolean highlightGutterLine)
    Sets the highlight of the current gutter line.
    void
    setLiveSuggestionsEnabled(boolean liveSuggestionsEnabled)
    Sets whether live suggestions that are suggested while typing are enabled.
    void
    setMode(CodeEditorMode mode)
    Sets syntax highlighting for a specific mode.
    protected void
    setPresentationValue(String newPresentationValue)
     
    void
    setPrintMarginColumn(int printMarginColumn)
    Sets the column for the vertical line, which shows the limit on the length of a line of code.
    void
    setRequired(boolean required)
    Specifies that the user must fill in a value.
    void
    setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
     
    void
    setShowGutter(boolean showGutter)
    Sets the visibility of the gutter.
    void
    setShowLineNumbers(boolean showLineNumbers)
    Sets the line numbers visibility.
    void
    setShowPrintMargin(boolean showPrintMargin)
    Sets the visibility of the vertical line that shows the limit on the length of a line of code.
    void
    setSuggester(Suggester suggester)
    Sets the Suggester that provides suggestion options on request from client-side.
    void
    setSuggestOn(String suggestOn)
    Sets the regular expression that triggers the display of a popup with suggestions.
    void
    setTextWrap(boolean textWrap)
    Sets the text content wrapping mode.
    void
    setTheme(CodeEditorTheme theme)
    Sets the visual theme of the editor.
    void
    setUseSoftTabs(boolean useSoftTabs)
    Sets the tab character representing mode.
    protected void
    validate()
     

    Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField

    getSynchronizationRegistration, hasValidValue, setSynchronizedEvent

    Methods inherited from class com.vaadin.flow.component.AbstractField

    addValueChangeListener, getValue, isEmpty, setModelValue, setValue, valueEquals

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.BlurNotifier

    addBlurListener

    Methods inherited from interface com.vaadin.flow.component.CompositionNotifier

    addCompositionEndListener, addCompositionStartListener, addCompositionUpdateListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.Focusable

    addFocusShortcut, blur, focus, getTabIndex, setTabIndex

    Methods inherited from interface com.vaadin.flow.component.FocusNotifier

    addFocusListener

    Methods inherited from interface com.vaadin.flow.component.shared.HasClientValidation

    addClientValidatedEventListener

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasEnabled

    isEnabled, setEnabled

    Methods inherited from interface com.vaadin.flow.component.HasHelper

    getHelperComponent, getHelperText, setHelperComponent, setHelperText

    Methods inherited from interface com.vaadin.flow.component.HasLabel

    getLabel, setLabel

    Methods inherited from interface com.vaadin.flow.component.HasSize

    getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

    Methods inherited from interface io.jmix.flowui.kit.component.HasTitle

    getTitle, setTitle

    Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

    getTooltip, setTooltipText

    Methods inherited from interface com.vaadin.flow.component.HasValidation

    setManualValidation

    Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties

    getErrorMessage, isInvalid, setErrorMessage, setInvalid

    Methods inherited from interface com.vaadin.flow.component.HasValue

    clear, getOptionalValue

    Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

    isReadOnly, isRequiredIndicatorVisible, setReadOnly

    Methods inherited from interface com.vaadin.flow.component.InputNotifier

    addInputListener

    Methods inherited from interface com.vaadin.flow.component.KeyNotifier

    addKeyDownListener, addKeyDownListener, addKeyPressListener, addKeyPressListener, addKeyUpListener, addKeyUpListener

  • Field Details

  • Constructor Details

    • JmixCodeEditor

      public JmixCodeEditor()

  • Method Details

    • initComponent

      protected void initComponent()

    • isHighlightActiveLine

      @Synchronize("highlightActiveLine") public boolean isHighlightActiveLine()
      Returns:
      true if the active line highlighting is enabled, false otherwise

    • setHighlightActiveLine

      public void setHighlightActiveLine(boolean highlightActiveLine)
      Sets the highlight of the active line. If the highlighting is enabled, the line the cursor is on will be highlighted. The highlight is enabled by default.
      Parameters:
      highlightActiveLine - whether to use active line highlighting

    • isHighlightGutterLine

      @Synchronize("highlightGutterLine") public boolean isHighlightGutterLine()
      Returns:
      true if the current gutter line highlighting is enabled, false otherwise

    • setHighlightGutterLine

      public void setHighlightGutterLine(boolean highlightGutterLine)
      Sets the highlight of the current gutter line. If the highlighting is enabled, the gutter line the cursor is on will be highlighted. The highlight is enabled by default.
      Parameters:
      highlightGutterLine - whether to use gutter line highlighting

    • isShowGutter

      @Synchronize("showGutter") public boolean isShowGutter()
      Returns:
      true if gutter is visible, false otherwise

    • setShowGutter

      public void setShowGutter(boolean showGutter)
      Sets the visibility of the gutter. The gutter is visible by default.
      Parameters:
      showGutter - whether to show the gutter

    • isShowLineNumbers

      @Synchronize("showLineNumbers") public boolean isShowLineNumbers()
      Returns:
      true if line numbers is visible, false otherwise

    • setShowLineNumbers

      public void setShowLineNumbers(boolean showLineNumbers)
      Sets the line numbers visibility. The line number is visible by default.
      Parameters:
      showLineNumbers - whether to show the line numbers

    • isShowPrintMargin

      @Synchronize("showPrintMargin") public boolean isShowPrintMargin()
      Returns:
      true if the print margin, false otherwise

    • setShowPrintMargin

      public void setShowPrintMargin(boolean showPrintMargin)
      Sets the visibility of the vertical line that shows the limit on the length of a line of code. The print margin is visible by default.
      Parameters:
      showPrintMargin - whether to show the print margin

    • getPrintMarginColumn

      @Synchronize("printMarginColumn") public int getPrintMarginColumn()
      Returns:
      print margin position in symbols

    • setPrintMarginColumn

      public void setPrintMarginColumn(int printMarginColumn)
      Sets the column for the vertical line, which shows the limit on the length of a line of code. The print margin column is 80 by default.
      Parameters:
      printMarginColumn - print margin position in symbols

    • getTheme

      @Synchronize(property="theme", value="theme-changed") public CodeEditorTheme getTheme()
      Returns:
      current visual theme applied to the editor

    • setTheme

      public void setTheme(CodeEditorTheme theme)
      Sets the visual theme of the editor. The visual theme is CodeEditorTheme.TEXTMATE by default, but if no theme is specified explicitly, the component will adapt the visual theme to the theme of the application.

      Thus - when using the light theme of the application, CodeEditorTheme.TEXTMATE will be applied, when using the dark theme - CodeEditorTheme.NORD_DARK will be applied.

      Parameters:
      theme - the instance of the CodeEditorTheme to be applied

    • getMode

      @Synchronize("mode") public CodeEditorMode getMode()
      Returns:
      current syntax highlighting mode applied to the editor

    • setMode

      public void setMode(CodeEditorMode mode)
      Sets syntax highlighting for a specific mode. The syntax highlighting mode is CodeEditorMode.PLAIN_TEXT by default.
      Parameters:
      mode - the instance of the CodeEditorMode to be applied

    • getFontSize

      @Synchronize("fontSize") public String getFontSize()
      Returns:
      font size for code in the editor in CSS font-size string format

    • setFontSize

      public void setFontSize(String fontSize)
      Sets the font size for code in the editor. The font size is 1rem by default.
      Parameters:
      fontSize - CSS font-size string

    • isTextWrap

      @Synchronize("textWrap") public boolean isTextWrap()
      Returns:
      true if the text content inside editor should be wrapped, false otherwise

    • setTextWrap

      public void setTextWrap(boolean textWrap)
      Sets the text content wrapping mode. The text wrap is false by default.
      Parameters:
      textWrap - whether to wrap text content

    • isUseSoftTabs

      @Synchronize("useSoftTabs") public boolean isUseSoftTabs()
      Returns:
      true if tab character should be represented as spaces instead of a special \t character, false otherwise.

    • setUseSoftTabs

      public void setUseSoftTabs(boolean useSoftTabs)
      Sets the tab character representing mode. Soft tabs mode means that tab character will be represented as a series of spaces. Hard tabs mode means that tab character will be represented as the special \t character. The soft tabs is true by default.
      Parameters:
      useSoftTabs - whether to use soft tabs

    • isRequired

      public boolean isRequired()
      Determines whether the field is marked as input required.
      Returns:
      true if the input is required, false otherwise

    • setRequired

      public void setRequired(boolean required)
      Specifies that the user must fill in a value.
      Parameters:
      required - the boolean value to set

    • isDefaultSuggestionsEnabled

      public boolean isDefaultSuggestionsEnabled()
      Returns:
      true if default suggestions based on the current editor mode are enabled, false otherwise
      See Also:

    • setDefaultSuggestionsEnabled

      public void setDefaultSuggestionsEnabled(boolean defaultSuggestionsEnabled)
      Sets whether default suggestions based on the current editor mode are enabled.

      For example, if the CodeEditorMode.JAVA is set, then when prompted for a suggestion, the standard keywords and local variables and methods defined in the code will be suggested.

      It is allowed to use custom Suggester with the default suggester at the same time.

      Parameters:
      defaultSuggestionsEnabled - whether to enable default suggestions

    • isLiveSuggestionsEnabled

      public boolean isLiveSuggestionsEnabled()
      Returns:
      true if live suggestions that are suggested while typing are enabled, false otherwise

    • setLiveSuggestionsEnabled

      public void setLiveSuggestionsEnabled(boolean liveSuggestionsEnabled)
      Sets whether live suggestions that are suggested while typing are enabled.

      At least one suggester is required.

      Parameters:
      liveSuggestionsEnabled - whether to enable live suggestions
      See Also:

    • getSuggestOn

      @Nullable public String getSuggestOn()
      Returns:
      regular expression that triggers the display of a popup with suggestions

    • setSuggestOn

      public void setSuggestOn(String suggestOn)
      Sets the regular expression that triggers the display of a popup with suggestions. If the end-user enters a sequence of characters that matches the regular expression then a popup with suggestions will open.
      Parameters:
      suggestOn - regular expression that triggers the display of a popup with suggestions

    • getSuggester

      @Nullable public Suggester getSuggester()
      Returns:
      the current editor suggester that provides suggestion options on request from the client-side

    • setSuggester

      public void setSuggester(@Nullable Suggester suggester)
      Sets the Suggester that provides suggestion options on request from client-side.
      Parameters:
      suggester - suggester to set
      See Also:

    • getSuggestions

      @ClientCallable protected elemental.json.JsonValue getSuggestions(String value, Double cursorPosition, String prefix)
      Returns a serialized list of suggestions for the client-side. The list is generated using a suggester based on the current state of the editor on the client-side.
      Parameters:
      value - current value from the client-side of the editor (may not match the server-side value)
      cursorPosition - current cursor position in the editor
      prefix - literal before current cursor position
      Returns:
      serialized list of suggestions
      See Also:

    • setPresentationValue

      protected void setPresentationValue(String newPresentationValue)
      Overrides:
      setPresentationValue in class com.vaadin.flow.component.AbstractSinglePropertyField<JmixCodeEditor,String>

    • getEmptyValue

      public String getEmptyValue()
      Specified by:
      getEmptyValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<JmixCodeEditor,String>,String>
      Overrides:
      getEmptyValue in class com.vaadin.flow.component.AbstractField<JmixCodeEditor,String>

    • setRequiredIndicatorVisible

      public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
      Specified by:
      setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<JmixCodeEditor,String>,String>
      Specified by:
      setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<JmixCodeEditor,String>,String>

    • getDefaultValidator

      public com.vaadin.flow.data.binder.Validator<String> getDefaultValidator()
      Specified by:
      getDefaultValidator in interface com.vaadin.flow.data.binder.HasValidator<String>

    • addValidationStatusChangeListener

      public com.vaadin.flow.shared.Registration addValidationStatusChangeListener(com.vaadin.flow.data.binder.ValidationStatusChangeListener<String> listener)
      Specified by:
      addValidationStatusChangeListener in interface com.vaadin.flow.data.binder.HasValidator<String>

    • validate

      protected void validate()

    • onAttach

      protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
      Overrides:
      onAttach in class com.vaadin.flow.component.Component

    • onCodeEditorValueChangedEvent

      protected void onCodeEditorValueChangedEvent(JmixCodeEditor.JmixCodeEditorValueChangedEvent event)

    • handleValueChanged

      protected void handleValueChanged(boolean isFromClient, String newValue)

    • getValidationSupport

      protected CodeEditorValidationSupport getValidationSupport()

    • serialize

      protected elemental.json.JsonValue serialize(Object object)

    • getObjectMapper

      protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

    • getJsonFactory

      protected elemental.json.JsonFactory getJsonFactory()