io.jmix.ui.component

Interface SourceCodeEditor

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Field<java.lang.String>, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValidator<java.lang.String>, HasValue<java.lang.String>, HasValueSource<java.lang.String>, Requirable, Validatable

All Known Implementing Classes:

SourceCodeEditorImpl

@StudioComponent(caption="SourceCodeEditor",
                 category="Components",
                 xmlElement="sourceCodeEditor",
                 icon="io/jmix/ui/icon/component/sourceCodeEditor.svg",
                 canvasBehaviour=SOURCE_CODE_EDITOR,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/source-code-editor.html")
public interface SourceCodeEditor
extends Field<java.lang.String>, Component.Focusable

Text area component with source code highlighting support.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SourceCodeEditor.Mode

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
AutoCompleteSupport	getAutoCompleteSupport()
HighlightMode	getMode()
int	getPrintMarginColumn()
java.lang.String	getRawValue() Returns a string representation of the value.
Suggester	getSuggester()
java.lang.String	getValue()
boolean	isHandleTabKey()
boolean	isHighlightActiveLine()
boolean	isShowGutter()
boolean	isShowPrintMargin()
boolean	isSuggestOnDot()
void	resetEditHistory() Reset the stack of undo/redo redo operations.
void	setHandleTabKey(boolean handleTabKey) Enables Tab key handling as tab symbol.
void	setHighlightActiveLine(boolean highlightActiveLine)
void	setMode(HighlightMode mode)
void	setPrintMarginColumn(int printMarginColumn) Set print margin position in symbols
void	setShowGutter(boolean showGutter)
void	setShowPrintMargin(boolean showPrintMargin)
void	setSuggester(Suggester suggester)
void	setSuggestOnDot(boolean suggest) Sets whether SourceCodeEditor should suggest options after typing a dot character.

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasValidator

addValidator, addValidators, getValidators, removeValidator

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getMode

HighlightMode getMode()

setMode

@StudioProperty(type=ENUMERATION,
                defaultValue="Text",
                options={"Java","HTML","CSS","SCSS","XML","Groovy","SQL","JavaScript","Properties","Text"})
void setMode(HighlightMode mode)

getSuggester

@Nullable
Suggester getSuggester()

setSuggester

void setSuggester(@Nullable
                  Suggester suggester)

getAutoCompleteSupport

AutoCompleteSupport getAutoCompleteSupport()

setShowGutter

@StudioProperty(defaultValue="true")
void setShowGutter(boolean showGutter)

isShowGutter

boolean isShowGutter()

setShowPrintMargin

@StudioProperty(name="printMargin",
                defaultValue="true")
void setShowPrintMargin(boolean showPrintMargin)

isShowPrintMargin

boolean isShowPrintMargin()

setPrintMarginColumn

@StudioProperty(defaultValue="80")
void setPrintMarginColumn(int printMarginColumn)

Set print margin position in symbols

Parameters:

printMarginColumn - print margin position in symbols

getPrintMarginColumn

int getPrintMarginColumn()

Returns:

print margin position in symbols

setHighlightActiveLine

@StudioProperty(defaultValue="true")
void setHighlightActiveLine(boolean highlightActiveLine)

isHighlightActiveLine

boolean isHighlightActiveLine()

setHandleTabKey

@StudioProperty(defaultValue="true")
void setHandleTabKey(boolean handleTabKey)

Enables Tab key handling as tab symbol. If handleTabKey is false then Tab/Shift-Tab key press will change focus to next/previous field.

isHandleTabKey

boolean isHandleTabKey()

Returns:

if Tab key handling is enabled

getValue

@Nullable
java.lang.String getValue()

Specified by:

getValue in interface HasValue<java.lang.String>

getRawValue

java.lang.String getRawValue()

Returns a string representation of the value.

resetEditHistory

void resetEditHistory()

Reset the stack of undo/redo redo operations.

isSuggestOnDot

boolean isSuggestOnDot()

Returns:

true if SourceCodeEditor suggests options after typing a dot character

setSuggestOnDot

@StudioProperty(name="suggestOnDot",
                defaultValue="true")
void setSuggestOnDot(boolean suggest)

Sets whether SourceCodeEditor should suggest options after typing a dot character. Default value is true.

Parameters:

suggest - suggest option