@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
Modifier and Type | Interface and Description |
---|---|
static class |
SourceCodeEditor.Mode |
HasValue.ValueChangeEvent<V>
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper
HasContextHelp.ContextHelpIconClickEvent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE
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.
|
getValueSource, setValueSource
addValueChangeListener, clear, getEmptyValue, isEmpty, setValue
isEditable, isEditableWithParent, setEditable
getFrame, setFrame
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
isValid, isValidateOnCommit, validate
getIcon, setIcon, setIconFromSet
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
isCaptionAsHtml, setCaptionAsHtml
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled
addValidator, addValidators, getValidators, removeValidator
getRequiredMessage, isRequired, setRequired, setRequiredMessage
focus, getTabIndex, isFocusable, setFocusable, setTabIndex
static final java.lang.String NAME
HighlightMode getMode()
@StudioProperty(type=ENUMERATION, defaultValue="Text", options={"Java","HTML","CSS","SCSS","XML","Groovy","SQL","JavaScript","Properties","Text"}) void setMode(HighlightMode mode)
@Nullable Suggester getSuggester()
void setSuggester(@Nullable Suggester suggester)
AutoCompleteSupport getAutoCompleteSupport()
@StudioProperty(defaultValue="true") void setShowGutter(boolean showGutter)
boolean isShowGutter()
@StudioProperty(name="printMargin", defaultValue="true") void setShowPrintMargin(boolean showPrintMargin)
boolean isShowPrintMargin()
@StudioProperty(defaultValue="80") void setPrintMarginColumn(int printMarginColumn)
printMarginColumn
- print margin position in symbolsint getPrintMarginColumn()
@StudioProperty(defaultValue="true") void setHighlightActiveLine(boolean highlightActiveLine)
boolean isHighlightActiveLine()
@StudioProperty(defaultValue="true") void setHandleTabKey(boolean handleTabKey)
boolean isHandleTabKey()
@Nullable java.lang.String getValue()
java.lang.String getRawValue()
void resetEditHistory()
boolean isSuggestOnDot()
@StudioProperty(name="suggestOnDot", defaultValue="true") void setSuggestOnDot(boolean suggest)
suggest
- suggest option