Package net.ssehub.easy.dslCore.ui.editors

Class EmbeddedXtextSourceEditor

java.lang.Object

net.ssehub.easy.dslCore.ui.editors.EmbeddedXtextSourceEditor

All Implemented Interfaces:

IEmbeddedEditor, IUpdatableEditor

class EmbeddedXtextSourceEditor
extends java.lang.Object
implements IEmbeddedEditor, IUpdatableEditor

Represents an embedded Xtext editor.

Author:

Holger Eichelberger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	EmbeddedXtextSourceEditor.DocumentContextObserver	Implements a delegating document context observer.
private class	EmbeddedXtextSourceEditor.ValidationStateListener	Implements a delegating validation state listener.

Nested classes/interfaces inherited from interface net.ssehub.easy.dslCore.ui.editors.IEmbeddedEditor

IEmbeddedEditor.IDocumentStateListener, IEmbeddedEditor.IValidationStateListener

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	dirty
private java.util.Map<IEmbeddedEditor.IDocumentStateListener,org.eclipse.xtext.ui.editor.model.IXtextDocumentContentObserver>	documentStateListeners
private org.eclipse.xtext.ui.editor.embedded.EmbeddedEditor	embeddedEditor
private AbstractModelChangeListener	modelListener
private org.eclipse.xtext.ui.editor.embedded.EmbeddedEditorModelAccess	partialEditorModelAccess
private org.eclipse.core.resources.IResource	resource
private boolean	skipNextUpdateEvent
private java.util.Map<IEmbeddedEditor.IValidationStateListener,org.eclipse.jface.text.source.IAnnotationModelListener>	validationStateListeners
private org.eclipse.xtext.ui.editor.XtextSourceViewer	viewer

Constructor Summary

Constructors

Constructor	Description
EmbeddedXtextSourceEditor(org.eclipse.xtext.ui.editor.embedded.EmbeddedEditor embeddedEditor, org.eclipse.xtext.ui.editor.XtextSourceViewer viewer, org.eclipse.xtext.ui.editor.embedded.EmbeddedEditorModelAccess partialEditorModelAccess, boolean requireWorkspaceResource)	Creates an editor representation instance.

Method Summary

Modifier and Type	Method	Description
void	addDocumentStateListener(IEmbeddedEditor.IDocumentStateListener listener)	Adds a document state listener.
void	addValidationStateListener(IEmbeddedEditor.IValidationStateListener listener)	Adds a validation state listener.
void	buildModel(org.eclipse.xtext.ui.editor.model.IXtextDocument doc)	Creates the model in the given xText document doc.
boolean	doSave()	Save the editor content to the original resource if content changed.
java.lang.String	getContent()	Returns the full content of the editor, including potential context such as prefix and postfix.
java.lang.String	getEditableContent()	Returns the editable content in this editor.
private EASyLoggerFactory.EASyLogger	getLogger()	Returns the logger of this class.
org.eclipse.core.resources.IResource	getResource()	Returns the resource of this editor.
org.eclipse.jface.viewers.Viewer	getViewer()	Returns the actual viewer implementing the editor.
void	refresh()	Refreshes the editor.
void	removeDocumentStateListener(IEmbeddedEditor.IDocumentStateListener listener)	Removes the given document state listener.
void	removeValidationStateListener(IEmbeddedEditor.IValidationStateListener listener)	Removes the given validation state listener.
boolean	setContent(java.lang.String[] content)	Changes the content of the embedded editor.
void	setEditable(boolean editable)	Changes whether the editor is enabled for editing.
void	setModelListener(AbstractModelChangeListener modelListener)	Defines the model listener being called in IEmbeddedEditor.doSave().
void	updateEditor()	Updates this editor.

Methods inherited from class java.lang.Object

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

Field Detail

embeddedEditor

private org.eclipse.xtext.ui.editor.embedded.EmbeddedEditor embeddedEditor

viewer

private org.eclipse.xtext.ui.editor.XtextSourceViewer viewer

partialEditorModelAccess

private org.eclipse.xtext.ui.editor.embedded.EmbeddedEditorModelAccess partialEditorModelAccess

validationStateListeners

private java.util.Map<IEmbeddedEditor.IValidationStateListener,org.eclipse.jface.text.source.IAnnotationModelListener> validationStateListeners

documentStateListeners

private java.util.Map<IEmbeddedEditor.IDocumentStateListener,org.eclipse.xtext.ui.editor.model.IXtextDocumentContentObserver> documentStateListeners

modelListener

private AbstractModelChangeListener modelListener

dirty

private boolean dirty

skipNextUpdateEvent

private boolean skipNextUpdateEvent

resource

private org.eclipse.core.resources.IResource resource

Constructor Detail

EmbeddedXtextSourceEditor

public EmbeddedXtextSourceEditor(org.eclipse.xtext.ui.editor.embedded.EmbeddedEditor embeddedEditor,
                                 org.eclipse.xtext.ui.editor.XtextSourceViewer viewer,
                                 org.eclipse.xtext.ui.editor.embedded.EmbeddedEditorModelAccess partialEditorModelAccess,
                                 boolean requireWorkspaceResource)

Creates an editor representation instance.

Parameters:

embeddedEditor - the embedded editor

viewer - the underlying source viewer

partialEditorModelAccess - the model access

requireWorkspaceResource - whether the editor requires a workspace resource and shall complain at least in the logs or whether it shall be silent

Method Detail

getLogger

private EASyLoggerFactory.EASyLogger getLogger()

Returns the logger of this class.

Returns:

the logger

getViewer

public org.eclipse.jface.viewers.Viewer getViewer()

Description copied from interface: IEmbeddedEditor

Returns the actual viewer implementing the editor.

Specified by:

getViewer in interface IEmbeddedEditor

Returns:

the actiall viewer

setContent

public boolean setContent(java.lang.String[] content)

Description copied from interface: IEmbeddedEditor

Changes the content of the embedded editor.

Specified by:

setContent in interface IEmbeddedEditor

Parameters:

content - the actual editable content in terms of prefix not to be shown [0], content to be displayed [1] and postfix not to be shown[2]

Returns:

whether the operation was successful (true) or not (false)

refresh

public void refresh()

Description copied from interface: IEmbeddedEditor

Refreshes the editor.

Specified by:

refresh in interface IEmbeddedEditor

addValidationStateListener

public void addValidationStateListener(IEmbeddedEditor.IValidationStateListener listener)

Description copied from interface: IEmbeddedEditor

Adds a validation state listener.

Specified by:

addValidationStateListener in interface IEmbeddedEditor

Parameters:

listener - the listener to be added

removeValidationStateListener

public void removeValidationStateListener(IEmbeddedEditor.IValidationStateListener listener)

Description copied from interface: IEmbeddedEditor

Removes the given validation state listener.

Specified by:

removeValidationStateListener in interface IEmbeddedEditor

Parameters:

listener - the listener to be removed

addDocumentStateListener

public void addDocumentStateListener(IEmbeddedEditor.IDocumentStateListener listener)

Description copied from interface: IEmbeddedEditor

Adds a document state listener.

Specified by:

addDocumentStateListener in interface IEmbeddedEditor

Parameters:

listener - the listener to be added

removeDocumentStateListener

public void removeDocumentStateListener(IEmbeddedEditor.IDocumentStateListener listener)

Description copied from interface: IEmbeddedEditor

Removes the given document state listener.

Specified by:

removeDocumentStateListener in interface IEmbeddedEditor

Parameters:

listener - the listener to be removed

setModelListener

public void setModelListener(AbstractModelChangeListener modelListener)

Description copied from interface: IEmbeddedEditor

Defines the model listener being called in IEmbeddedEditor.doSave().

Specified by:

setModelListener in interface IEmbeddedEditor

Parameters:

modelListener - the model listener (null for ignore it)

getEditableContent

public java.lang.String getEditableContent()

Description copied from interface: IEmbeddedEditor

Returns the editable content in this editor.

Specified by:

getEditableContent in interface IEmbeddedEditor

Returns:

the editable content

getContent

public java.lang.String getContent()

Description copied from interface: IEmbeddedEditor

Returns the full content of the editor, including potential context such as prefix and postfix.

Specified by:

getContent in interface IEmbeddedEditor

Returns:

the full content

doSave

public boolean doSave()

Description copied from interface: IEmbeddedEditor

Save the editor content to the original resource if content changed.

Specified by:

doSave in interface IEmbeddedEditor

Returns:

true if the content was saved, false else

updateEditor

public void updateEditor()

Description copied from interface: IUpdatableEditor

Updates this editor.

Specified by:

updateEditor in interface IUpdatableEditor

getResource

public org.eclipse.core.resources.IResource getResource()

Description copied from interface: IUpdatableEditor

Returns the resource of this editor.

Specified by:

getResource in interface IUpdatableEditor

Returns:

the resource

buildModel

public void buildModel(org.eclipse.xtext.ui.editor.model.IXtextDocument doc)

Description copied from interface: IUpdatableEditor

Creates the model in the given xText document doc. This method synchronizes over doc in order to avoid reentrant model validation.

Specified by:

buildModel in interface IUpdatableEditor

Parameters:

doc - the document to create the model for

setEditable

public void setEditable(boolean editable)

Description copied from interface: IEmbeddedEditor

Changes whether the editor is enabled for editing.

Specified by:

setEditable in interface IEmbeddedEditor

Parameters:

editable - true if editing is enabled, false if only viewing is supported