com.haulmont.cuba.gui.components

Interface SourceCodeEditor

All Superinterfaces:

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

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 com.haulmont.cuba.gui.components.Field

Field.Validator<T>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

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

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

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

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

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()
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)

Methods inherited from interface com.haulmont.cuba.gui.components.Field

addValidator, addValidators, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage

Methods inherited from interface com.haulmont.cuba.gui.components.DatasourceComponent

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.HasValue

addValueChangeListener, clear, getEmptyValue, isEmpty, removeValueChangeListener, setValue

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.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

void setMode(HighlightMode mode)

getSuggester

Suggester getSuggester()

setSuggester

void setSuggester(Suggester suggester)

getAutoCompleteSupport

AutoCompleteSupport getAutoCompleteSupport()

setShowGutter

void setShowGutter(boolean showGutter)

isShowGutter

boolean isShowGutter()

setShowPrintMargin

void setShowPrintMargin(boolean showPrintMargin)

isShowPrintMargin

boolean isShowPrintMargin()

setPrintMarginColumn

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

void setHighlightActiveLine(boolean highlightActiveLine)

isHighlightActiveLine

boolean isHighlightActiveLine()

setHandleTabKey

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

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.