org.vaadin.aceeditor

Class AceEditor

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.v7.ui.AbstractLegacyComponent

com.vaadin.v7.ui.AbstractField<String>

org.vaadin.aceeditor.AceEditor

All Implemented Interfaces:

com.vaadin.event.Action.ShortcutNotifier, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.SerializableEventListener, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.v7.data.Buffered, com.vaadin.v7.data.BufferedValidatable, com.vaadin.v7.data.Property<String>, com.vaadin.v7.data.Property.Editor, com.vaadin.v7.data.Property.ReadOnlyStatusChangeListener, com.vaadin.v7.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.v7.data.Property.ValueChangeListener, com.vaadin.v7.data.Property.ValueChangeNotifier, com.vaadin.v7.data.Property.Viewer, com.vaadin.v7.data.Validatable, com.vaadin.v7.event.FieldEvents.BlurNotifier, com.vaadin.v7.event.FieldEvents.FocusNotifier, com.vaadin.v7.event.FieldEvents.TextChangeNotifier, com.vaadin.v7.ui.Field<String>, Serializable, EventListener

@JavaScript(value={"client/js/ace/ace.js","client/js/ace/ext-searchbox.js","client/js/diff_match_patch.js"})
 @StyleSheet(value="client/css/ace-gwt.css")
public class AceEditor
extends com.vaadin.v7.ui.AbstractField<String>
implements com.vaadin.v7.event.FieldEvents.BlurNotifier, com.vaadin.v7.event.FieldEvents.FocusNotifier, com.vaadin.v7.event.FieldEvents.TextChangeNotifier

AceEditor wraps an Ace code editor inside a TextField-like Vaadin component.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AceEditor.DiffEvent
static interface	AceEditor.DiffListener
static class	AceEditor.SelectionChangeEvent
static interface	AceEditor.SelectionChangeListener
static class	AceEditor.TextChangeEventImpl

Nested classes/interfaces inherited from class com.vaadin.v7.ui.AbstractField

com.vaadin.v7.ui.AbstractField.FocusShortcut, com.vaadin.v7.ui.AbstractField.ReadOnlyStatusChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.v7.ui.Field

com.vaadin.v7.ui.Field.ValueChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.v7.data.Buffered

com.vaadin.v7.data.Buffered.SourceException

Nested classes/interfaces inherited from interface com.vaadin.v7.data.Property

com.vaadin.v7.data.Property.Editor, com.vaadin.v7.data.Property.ReadOnlyException, com.vaadin.v7.data.Property.ReadOnlyStatusChangeListener, com.vaadin.v7.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.v7.data.Property.Transactional<T>, com.vaadin.v7.data.Property.ValueChangeListener, com.vaadin.v7.data.Property.ValueChangeNotifier, com.vaadin.v7.data.Property.Viewer

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
AceEditor()

Method Summary

Modifier and Type	Method and Description
void	addBlurListener(com.vaadin.event.FieldEvents.BlurListener listener)
void	addDiffListener(AceEditor.DiffListener listener)
void	addFocusListener(com.vaadin.event.FieldEvents.FocusListener listener)
void	addListener(com.vaadin.event.FieldEvents.BlurListener listener) Deprecated.
void	addListener(com.vaadin.event.FieldEvents.FocusListener listener) Deprecated.
void	addListener(com.vaadin.v7.event.FieldEvents.TextChangeListener listener) Deprecated.
String	addMarker(AceMarker marker) Adds an ace marker.
String	addMarker(AceRange range, String cssClass, AceMarker.Type type, boolean inFront, AceMarker.OnTextChange onChange) Adds an ace marker with a generated id.
void	addMarkerAnnotation(AceAnnotation ann, AceMarker marker)
void	addMarkerAnnotation(AceAnnotation ann, String markerId)
void	addRowAnnotation(AceAnnotation ann, int row)
void	addSelectionChangeListener(AceEditor.SelectionChangeListener listener)
void	addTextChangeListener(com.vaadin.v7.event.FieldEvents.TextChangeListener listener)
void	beforeClientResponse(boolean initial)
void	clearMarkerAnnotations()
void	clearMarkers()
void	clearRowAnnotations()
protected void	clientChanged(TransportDiff diff, TransportDoc.TransportRange selection, boolean focused)
int	getCursorPosition()
AceDoc	getDoc()
TextRange	getSelection()
protected AceEditorState	getState()
protected AceEditorState	getState(boolean markAsDirty)
Class<? extends String>	getType()
boolean	isHighlightActiveLine()
boolean	isShowGutter()
boolean	isShowPrintMargin()
void	removeBlurListener(com.vaadin.event.FieldEvents.BlurListener listener)
void	removeDiffListener(AceEditor.DiffListener listener)
void	removeFocusListener(com.vaadin.event.FieldEvents.FocusListener listener)
void	removeListener(com.vaadin.event.FieldEvents.BlurListener listener) Deprecated.
void	removeListener(com.vaadin.event.FieldEvents.FocusListener listener) Deprecated.
void	removeListener(com.vaadin.v7.event.FieldEvents.TextChangeListener listener) Deprecated.
void	removeMarker(AceMarker marker)
void	removeMarker(String markerId)
void	removeSelectionChangeListener(AceEditor.SelectionChangeListener listener)
void	removeTextChangeListener(com.vaadin.v7.event.FieldEvents.TextChangeListener listener)
void	scrollToPosition(int pos) Scrolls the to the given position (characters from the start of the file).
void	scrollToRow(int row) Scrolls to the given row.
void	setBasePath(String path)
void	setCursorPosition(int pos) Sets the cursor position to be pos characters from the beginning of the text.
void	setCursorRowCol(int row, int col) Sets the cursor on the given row and column.
void	setDoc(AceDoc doc)
void	setHighlightActiveLine(boolean highlightActiveLine)
protected void	setInternalValue(String newValue)
void	setMode(AceMode mode)
void	setMode(String mode)
void	setModePath(String path)
void	setSelection(int start, int end) Sets the selection to be between characters [start,end).
void	setSelectionRowCol(int startRow, int startCol, int endRow, int endCol) Sets the selection to be between the given (startRow,startCol) and (endRow, endCol).
void	setShowGutter(boolean showGutter)
void	setShowPrintMargin(boolean showPrintMargin)
void	setTextChangeEventMode(com.vaadin.v7.ui.AbstractTextField.TextChangeEventMode inputEventMode) Sets the mode how the TextField triggers FieldEvents.TextChangeEvents.
void	setTextChangeTimeout(int timeoutMs) The text change timeout modifies how often text change events are communicated to the application when setTextChangeEventMode(com.vaadin.v7.ui.AbstractTextField.TextChangeEventMode) is AbstractTextField.TextChangeEventMode.LAZY or AbstractTextField.TextChangeEventMode.TIMEOUT.
void	setTheme(AceTheme theme)
void	setTheme(String theme)
void	setThemePath(String path)
void	setUseWorker(boolean useWorker)
void	setWordWrap(boolean ww)
void	setWorkerPath(String path)

Methods inherited from class com.vaadin.v7.ui.AbstractField

addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, attach, clear, commit, detach, discard, fireReadOnlyStatusChange, fireValueChange, focus, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getCustomAttributes, getErrorMessage, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getTabIndex, getValidators, getValue, isBuffered, isEmpty, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValid, isValidationVisible, readDesign, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInvalidAllowed, setInvalidCommitted, setLocale, setPropertyDataSource, setReadOnly, setRequired, setRequiredError, setTabIndex, setValidationVisible, setValue, setValue, setValue, shouldHideErrors, validate, validate, valueChange, writeDesign

Methods inherited from class com.vaadin.v7.ui.AbstractLegacyComponent

getExplicitImmediateValue, isImmediate, setImmediate

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setParent, setPrimaryStyleName, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier

addShortcutListener, removeShortcutListener

Constructor Detail

AceEditor

public AceEditor()

Method Detail

addDiffListener

public void addDiffListener(AceEditor.DiffListener listener)

addFocusListener

public void addFocusListener(com.vaadin.event.FieldEvents.FocusListener listener)

Specified by:

addFocusListener in interface com.vaadin.v7.event.FieldEvents.FocusNotifier

addBlurListener

public void addBlurListener(com.vaadin.event.FieldEvents.BlurListener listener)

Specified by:

addBlurListener in interface com.vaadin.v7.event.FieldEvents.BlurNotifier

addListener

@Deprecated
public void addListener(com.vaadin.event.FieldEvents.BlurListener listener)

Deprecated.

addListener

@Deprecated
public void addListener(com.vaadin.event.FieldEvents.FocusListener listener)

Deprecated.

addListener

@Deprecated
public void addListener(com.vaadin.v7.event.FieldEvents.TextChangeListener listener)

Deprecated.

addMarker

public String addMarker(AceMarker marker)

Adds an ace marker. The id of the marker must be unique within this editor.

Parameters:

marker -

Returns:

marker id

addMarker

public String addMarker(AceRange range,
                        String cssClass,
                        AceMarker.Type type,
                        boolean inFront,
                        AceMarker.OnTextChange onChange)

Adds an ace marker with a generated id. The id is unique within this editor.

Parameters:

range -

cssClass -

type -

inFront -

onChange -

Returns:

marker id

addMarkerAnnotation

public void addMarkerAnnotation(AceAnnotation ann,
                                AceMarker marker)

addMarkerAnnotation

public void addMarkerAnnotation(AceAnnotation ann,
                                String markerId)

addRowAnnotation

public void addRowAnnotation(AceAnnotation ann,
                             int row)

addSelectionChangeListener

public void addSelectionChangeListener(AceEditor.SelectionChangeListener listener)

addTextChangeListener

public void addTextChangeListener(com.vaadin.v7.event.FieldEvents.TextChangeListener listener)

Specified by:

addTextChangeListener in interface com.vaadin.v7.event.FieldEvents.TextChangeNotifier

beforeClientResponse

public void beforeClientResponse(boolean initial)

Specified by:

beforeClientResponse in interface com.vaadin.server.ClientConnector

Overrides:

beforeClientResponse in class com.vaadin.v7.ui.AbstractField<String>

clearMarkerAnnotations

public void clearMarkerAnnotations()

clearMarkers

public void clearMarkers()

clearRowAnnotations

public void clearRowAnnotations()

getCursorPosition

public int getCursorPosition()

getDoc

public AceDoc getDoc()

getSelection

public TextRange getSelection()

getType

public Class<? extends String> getType()

Specified by:

getType in interface com.vaadin.v7.data.Property<String>

Specified by:

getType in class com.vaadin.v7.ui.AbstractField<String>

removeDiffListener

public void removeDiffListener(AceEditor.DiffListener listener)

removeFocusListener

public void removeFocusListener(com.vaadin.event.FieldEvents.FocusListener listener)

Specified by:

removeFocusListener in interface com.vaadin.v7.event.FieldEvents.FocusNotifier

removeBlurListener

public void removeBlurListener(com.vaadin.event.FieldEvents.BlurListener listener)

Specified by:

removeBlurListener in interface com.vaadin.v7.event.FieldEvents.BlurNotifier

removeListener

@Deprecated
public void removeListener(com.vaadin.event.FieldEvents.BlurListener listener)

Deprecated.

removeListener

@Deprecated
public void removeListener(com.vaadin.event.FieldEvents.FocusListener listener)

Deprecated.

removeListener

@Deprecated
public void removeListener(com.vaadin.v7.event.FieldEvents.TextChangeListener listener)

Deprecated.

removeMarker

public void removeMarker(AceMarker marker)

removeMarker

public void removeMarker(String markerId)

removeSelectionChangeListener

public void removeSelectionChangeListener(AceEditor.SelectionChangeListener listener)

removeTextChangeListener

public void removeTextChangeListener(com.vaadin.v7.event.FieldEvents.TextChangeListener listener)

Specified by:

removeTextChangeListener in interface com.vaadin.v7.event.FieldEvents.TextChangeNotifier

setBasePath

public void setBasePath(String path)

setCursorPosition

public void setCursorPosition(int pos)

Sets the cursor position to be pos characters from the beginning of the text.

Parameters:

pos -

setCursorRowCol

public void setCursorRowCol(int row,
                            int col)

Sets the cursor on the given row and column.

Parameters:

row - starting from 0

col - starting from 0

setDoc

public void setDoc(AceDoc doc)

setMode

public void setMode(AceMode mode)

setMode

public void setMode(String mode)

setModePath

public void setModePath(String path)

setSelection

public void setSelection(int start,
                         int end)

Sets the selection to be between characters [start,end). The cursor will be at the end.

Parameters:

start -

end -

setSelectionRowCol

public void setSelectionRowCol(int startRow,
                               int startCol,
                               int endRow,
                               int endCol)

Sets the selection to be between the given (startRow,startCol) and (endRow, endCol). The cursor will be at the end.

Parameters:

startRow - starting from 0

startCol - starting from 0

endRow - starting from 0

endCol - starting from 0

setTextChangeEventMode

public void setTextChangeEventMode(com.vaadin.v7.ui.AbstractTextField.TextChangeEventMode inputEventMode)

Sets the mode how the TextField triggers FieldEvents.TextChangeEvents.

Parameters:

inputEventMode - the new mode

See Also:

AbstractTextField.TextChangeEventMode

setTextChangeTimeout

public void setTextChangeTimeout(int timeoutMs)

The text change timeout modifies how often text change events are communicated to the application when setTextChangeEventMode(com.vaadin.v7.ui.AbstractTextField.TextChangeEventMode) is AbstractTextField.TextChangeEventMode.LAZY or AbstractTextField.TextChangeEventMode.TIMEOUT.

Parameters:

timeoutMs - the timeout in milliseconds

scrollToRow

public void scrollToRow(int row)

Scrolls to the given row. First row is 0.

scrollToPosition

public void scrollToPosition(int pos)

Scrolls the to the given position (characters from the start of the file).

setTheme

public void setTheme(AceTheme theme)

setTheme

public void setTheme(String theme)

setThemePath

public void setThemePath(String path)

setUseWorker

public void setUseWorker(boolean useWorker)

setWordWrap

public void setWordWrap(boolean ww)

setShowGutter

public void setShowGutter(boolean showGutter)

isShowGutter

public boolean isShowGutter()

setShowPrintMargin

public void setShowPrintMargin(boolean showPrintMargin)

isShowPrintMargin

public boolean isShowPrintMargin()

setHighlightActiveLine

public void setHighlightActiveLine(boolean highlightActiveLine)

isHighlightActiveLine

public boolean isHighlightActiveLine()

setWorkerPath

public void setWorkerPath(String path)

clientChanged

protected void clientChanged(TransportDiff diff,
                             TransportDoc.TransportRange selection,
                             boolean focused)

getState

protected AceEditorState getState()

Overrides:

getState in class com.vaadin.v7.ui.AbstractField<String>

getState

protected AceEditorState getState(boolean markAsDirty)

Overrides:

getState in class com.vaadin.v7.ui.AbstractField<String>

setInternalValue

protected void setInternalValue(String newValue)

Overrides:

setInternalValue in class com.vaadin.v7.ui.AbstractField<String>