org.eclipse.epsilon.common.dt.editor

Class AbstractModuleEditor

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.EditorPart

org.eclipse.ui.texteditor.AbstractTextEditor

org.eclipse.ui.texteditor.StatusTextEditor

org.eclipse.ui.texteditor.AbstractDecoratedTextEditor

org.eclipse.epsilon.common.dt.editor.AbstractModuleEditor

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.ui.IEditorPart, org.eclipse.ui.INavigationLocationProvider, org.eclipse.ui.IPersistable, org.eclipse.ui.IPersistableEditor, org.eclipse.ui.IReusableEditor, org.eclipse.ui.ISaveablePart, org.eclipse.ui.ISaveablesSource, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation, org.eclipse.ui.texteditor.ITextEditor, org.eclipse.ui.texteditor.ITextEditorExtension, org.eclipse.ui.texteditor.ITextEditorExtension2, org.eclipse.ui.texteditor.ITextEditorExtension3, org.eclipse.ui.texteditor.ITextEditorExtension4, org.eclipse.ui.texteditor.ITextEditorExtension5, org.eclipse.ui.texteditor.ITextEditorExtension6

Direct Known Subclasses:

EglEditor, EolEditor

public abstract class AbstractModuleEditor
extends org.eclipse.ui.texteditor.AbstractDecoratedTextEditor

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.ui.texteditor.AbstractTextEditor

org.eclipse.ui.texteditor.AbstractTextEditor.AbstractSelectionChangedListener, org.eclipse.ui.texteditor.AbstractTextEditor.ColumnSupport, org.eclipse.ui.texteditor.AbstractTextEditor.IdMapEntry, org.eclipse.ui.texteditor.AbstractTextEditor.LineEndAction, org.eclipse.ui.texteditor.AbstractTextEditor.LineStartAction, org.eclipse.ui.texteditor.AbstractTextEditor.SelectionProvider, org.eclipse.ui.texteditor.AbstractTextEditor.TextEditorSavable

Nested classes/interfaces inherited from interface org.eclipse.ui.texteditor.ITextEditorExtension3

org.eclipse.ui.texteditor.ITextEditorExtension3.InsertMode

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.swt.graphics.Color	backgroundColor
static String	EDITOR_MATCHING_BRACKETS
static String	EDITOR_MATCHING_BRACKETS_COLOR
protected EpsilonHighlightingManager	highlightingManager
protected ArrayList<IModuleParseListener>	moduleParsedListeners
protected org.eclipse.core.runtime.jobs.Job	parseModuleJob
static String	PROBLEM_MARKER
protected ArrayList<IAbstractModuleEditorTemplateContributor>	templateContributors

Fields inherited from class org.eclipse.ui.texteditor.AbstractDecoratedTextEditor

DEFAULT_OVERVIEW_RULER_CONTEXT_MENU_ID, fAnnotationAccess, fIsUpdatingMarkerViews, fLineNumberRulerColumn, fOverviewRuler, fSourceViewerDecorationSupport

Fields inherited from class org.eclipse.ui.texteditor.AbstractTextEditor

ACTION_MAP, COMMON_EDITOR_CONTEXT_MENU_ID, COMMON_RULER_CONTEXT_MENU_ID, DEFAULT_EDITOR_CONTEXT_MENU_ID, DEFAULT_RULER_CONTEXT_MENU_ID, fErrorLabel, PREFERENCE_COLOR_BACKGROUND, PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT, PREFERENCE_COLOR_FIND_SCOPE, PREFERENCE_COLOR_FOREGROUND, PREFERENCE_COLOR_FOREGROUND_SYSTEM_DEFAULT, PREFERENCE_COLOR_SELECTION_BACKGROUND, PREFERENCE_COLOR_SELECTION_BACKGROUND_SYSTEM_DEFAULT, PREFERENCE_COLOR_SELECTION_FOREGROUND, PREFERENCE_COLOR_SELECTION_FOREGROUND_SYSTEM_DEFAULT, PREFERENCE_FONT, PREFERENCE_HOVER_ENRICH_MODE, PREFERENCE_HYPERLINK_KEY_MODIFIER, PREFERENCE_HYPERLINK_KEY_MODIFIER_MASK, PREFERENCE_HYPERLINKS_ENABLED, PREFERENCE_NAVIGATION_SMART_HOME_END, PREFERENCE_RULER_CONTRIBUTIONS, PREFERENCE_SHOW_CARET_OFFSET, PREFERENCE_SHOW_CARRIAGE_RETURN, PREFERENCE_SHOW_ENCLOSED_IDEOGRAPHIC_SPACES, PREFERENCE_SHOW_ENCLOSED_SPACES, PREFERENCE_SHOW_ENCLOSED_TABS, PREFERENCE_SHOW_LEADING_IDEOGRAPHIC_SPACES, PREFERENCE_SHOW_LEADING_SPACES, PREFERENCE_SHOW_LEADING_TABS, PREFERENCE_SHOW_LINE_FEED, PREFERENCE_SHOW_SELECTION_SIZE, PREFERENCE_SHOW_TRAILING_IDEOGRAPHIC_SPACES, PREFERENCE_SHOW_TRAILING_SPACES, PREFERENCE_SHOW_TRAILING_TABS, PREFERENCE_SHOW_WHITESPACE_CHARACTERS, PREFERENCE_TEXT_DRAG_AND_DROP_ENABLED, PREFERENCE_USE_CUSTOM_CARETS, PREFERENCE_WHITESPACE_CHARACTER_ALPHA_VALUE, PREFERENCE_WIDE_CARET, PREFERENCE_WORD_WRAP_ENABLED, TAG_SELECTION_HORIZONTAL_PIXEL, TAG_SELECTION_LENGTH, TAG_SELECTION_OFFSET, TAG_SELECTION_TOP_PIXEL, VERTICAL_RULER_WIDTH

Fields inherited from interface org.eclipse.ui.IEditorPart

PROP_DIRTY, PROP_INPUT

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Fields inherited from interface org.eclipse.ui.texteditor.ITextEditorExtension3

INSERT, SMART_INSERT

Constructor Summary

Constructors

Constructor and Description
AbstractModuleEditor()

Method Summary

Modifier and Type	Method and Description
ModuleElement	adaptToAST(Object o)
void	addModuleParsedListener(IModuleParseListener listener)
void	addTemplateContributor(IAbstractModuleEditorTemplateContributor templateContributor)
void	close(boolean save)
protected void	configureSourceViewerDecorationSupport(org.eclipse.ui.texteditor.SourceViewerDecorationSupport support)
protected void	createActions()
abstract IModule	createModule()
protected abstract ModuleContentProvider	createModuleContentProvider()
abstract ModuleElementLabelProvider	createModuleElementLabelProvider()
ModuleContentOutlinePage	createOutlinePage()
void	createPartControl(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.jface.text.source.ISourceViewer	createSourceViewer(org.eclipse.swt.widgets.Composite parent, org.eclipse.jface.text.source.IVerticalRuler ruler, int styles)
org.eclipse.jface.text.source.SourceViewerConfiguration	createSourceViewerConfiguration()
void	doSave(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
<T> T	getAdapter(Class<T> required)
List<String>	getAssertions()
org.eclipse.swt.graphics.Color	getBackgroundColor()
abstract List<String>	getBuiltinVariables()
EpsilonHighlightingManager	getHighlightingManager()
abstract List<String>	getKeywords()
ArrayList<IModuleParseListener>	getModuleParsedListeners()
List<org.eclipse.jface.text.templates.Template>	getTemplates()
String	getText()
Collection<String>	getTypes()
void	init(org.eclipse.ui.IEditorSite site, org.eclipse.ui.IEditorInput input)
void	insertText(String text)
boolean	isClosed()
boolean	isDirty()
protected void	notifyModuleParsedListeners(IModule module)
void	parseModule()
boolean	removeModuleParsedListener(IModuleParseListener listener)
boolean	removeTemplateContributor(IAbstractModuleEditorTemplateContributor templateContributor)
void	setBackgroundColor(org.eclipse.swt.graphics.Color backgroundColor)
protected abstract boolean	supportsDirtyTextParsing()
protected abstract boolean	supportsHyperlinks()

Methods inherited from class org.eclipse.ui.texteditor.AbstractDecoratedTextEditor

collectContextMenuPreferencePages, collectOverviewRulerMenuPreferencePages, collectRulerMenuPreferencePages, createAnnotationAccess, createAnnotationRulerColumn, createChangeHover, createChangeRulerColumn, createColumnSupport, createCompositeRuler, createContextMenuListener, createLineNumberRulerColumn, createOverviewRuler, createOverviewRulerContextMenu, createShowInTargetList, createStatusControl, createVerticalRuler, dispose, disposeDocumentProvider, doSetInput, editorContextMenuAboutToShow, getAnnotationAccess, getAnnotationPreferenceLookup, getAnnotationPreferences, getDocumentProvider, getOverviewRuler, getOverviewRulerContextMenuId, getSharedColors, getSourceViewerDecorationSupport, getUndoRedoOperationApprover, gotoAnnotation, gotoMarker, handleEditorInputChanged, handlePreferenceStoreChanged, hideOverviewRuler, initializeEditor, initializeKeyBindingScopes, initializeLineNumberRulerColumn, isChangeInformationShowing, isEditable, isErrorStatus, isLineNumberRulerVisible, isNavigationTarget, isOverviewRulerVisible, isOverwriteModeEnabled, isPrefQuickDiffAlwaysOn, isSpacesAsTabsDeletionEnabled, isTabsToSpacesConversionEnabled, openSaveErrorDialog, overviewRulerContextMenuAboutToShow, performSaveAs, rulerContextMenuAboutToShow, setDocumentProvider, setOverviewRulerContextMenuId, showChangeInformation, showOverviewRuler, showRevisionInformation, updateMarkerViews, validateEditorInputState

Methods inherited from class org.eclipse.ui.texteditor.StatusTextEditor

doRevertToSaved, getStatusBanner, getStatusHeader, getStatusMessage, handleElementContentReplaced, sanityCheckState, setFocus, updatePartControl, updateStatusField

Methods inherited from class org.eclipse.ui.texteditor.AbstractTextEditor

addAction, addAction, addGroup, addRulerContextMenuListener, adjustHighlightRange, affectsTextPresentation, canHandleMove, configureInsertMode, containsSavedState, createEmptyNavigationLocation, createNavigationActions, createNavigationLocation, createUndoRedoActions, doGetSelection, doRestoreState, doSaveAs, doSetSelection, editorSaved, enableOverwriteMode, enableSanityChecking, enableStateValidation, findAnnotation, firePropertyChange, getAction, getActiveSaveables, getContextMenuListener, getCoverage, getCursorListener, getCursorPosition, getEditorContextMenuId, getFontPropertyPreferenceKey, getHelpContextId, getHighlightRange, getInitialWordWrapStatus, getInsertMode, getLegalInsertModes, getPreferenceStore, getProgressMonitor, getRangeIndicator, getRulerContextMenuId, getRulerMouseListener, getSaveables, getSelectionChangedListener, getSelectionProvider, getSourceViewer, getSourceViewerConfiguration, getStatusField, getStatusLineManager, getVerticalRuler, handleCursorPositionChanged, handleExceptionOnSave, handleInsertModeChanged, initializeDragAndDrop, initializeViewerColors, installCodeMiningProviders, installTabsToSpacesConverter, installTextDragAndDrop, internalInit, isBlockSelectionModeEnabled, isBlockSelectionModeSupported, isEditorInputIncludedInContextMenu, isEditorInputModifiable, isEditorInputReadOnly, isInInsertMode, isSaveAsAllowed, isVisible, isWordWrapEnabled, isWordWrapSupported, markAsContentDependentAction, markAsPropertyDependentAction, markAsSelectionDependentAction, markAsStateDependentAction, markInNavigationHistory, modelOffset2WidgetOffset, performRevert, performSave, rememberSelection, removeActionActivationCode, removeRulerContextMenuListener, resetHighlightRange, restoreSelection, restoreState, safelySanityCheckState, saveState, selectAndReveal, selectAndReveal, setAction, setActionActivationCode, setBlockSelectionMode, setCompatibilityMode, setDocumentProvider, setEditorContextMenuId, setHelpContextId, setHighlightRange, setInput, setInputWithNotify, setInsertMode, setKeyBindingScopes, setPreferenceStore, setRangeIndicator, setRulerContextMenuId, setSourceViewerConfiguration, setStatusField, setStatusLineErrorMessage, setStatusLineMessage, setWordWrap, showHighlightRangeOnly, showsHighlightRangeOnly, uninstallTabsToSpacesConverter, uninstallTextDragAndDrop, updateContentDependentActions, updateContributedRulerColumns, updateIndentPrefixes, updatePropertyDependentActions, updateSelectionDependentActions, updateState, updateStateDependentActions, updateStatusFields, validateState, widgetOffset2ModelOffset

Methods inherited from class org.eclipse.ui.part.EditorPart

checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPartPropertyListener, addPropertyListener, firePartPropertyChanged, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ui.IEditorPart

getEditorInput, getEditorSite

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

Methods inherited from interface org.eclipse.ui.ISaveablePart

isSaveOnCloseNeeded

Field Detail

backgroundColor

protected org.eclipse.swt.graphics.Color backgroundColor

parseModuleJob

protected org.eclipse.core.runtime.jobs.Job parseModuleJob

moduleParsedListeners

protected ArrayList<IModuleParseListener> moduleParsedListeners

templateContributors

protected ArrayList<IAbstractModuleEditorTemplateContributor> templateContributors

highlightingManager

protected EpsilonHighlightingManager highlightingManager

PROBLEM_MARKER

public static final String PROBLEM_MARKER

See Also:

Constant Field Values

EDITOR_MATCHING_BRACKETS

public static final String EDITOR_MATCHING_BRACKETS

See Also:

Constant Field Values

EDITOR_MATCHING_BRACKETS_COLOR

public static final String EDITOR_MATCHING_BRACKETS_COLOR

See Also:

Constant Field Values

Constructor Detail

AbstractModuleEditor

public AbstractModuleEditor()

Method Detail

addModuleParsedListener

public void addModuleParsedListener(IModuleParseListener listener)

getModuleParsedListeners

public ArrayList<IModuleParseListener> getModuleParsedListeners()

removeModuleParsedListener

public boolean removeModuleParsedListener(IModuleParseListener listener)

addTemplateContributor

public void addTemplateContributor(IAbstractModuleEditorTemplateContributor templateContributor)

removeTemplateContributor

public boolean removeTemplateContributor(IAbstractModuleEditorTemplateContributor templateContributor)

notifyModuleParsedListeners

protected void notifyModuleParsedListeners(IModule module)

adaptToAST

public ModuleElement adaptToAST(Object o)

insertText

public void insertText(String text)

configureSourceViewerDecorationSupport

protected void configureSourceViewerDecorationSupport(org.eclipse.ui.texteditor.SourceViewerDecorationSupport support)

Overrides:

configureSourceViewerDecorationSupport in class org.eclipse.ui.texteditor.AbstractDecoratedTextEditor

getAdapter

public <T> T getAdapter(Class<T> required)

Specified by:

getAdapter in interface org.eclipse.core.runtime.IAdaptable

Overrides:

getAdapter in class org.eclipse.ui.texteditor.AbstractDecoratedTextEditor

getAssertions

public List<String> getAssertions()

getTypes

public Collection<String> getTypes()

getKeywords

public abstract List<String> getKeywords()

getBuiltinVariables

public abstract List<String> getBuiltinVariables()

createOutlinePage

public ModuleContentOutlinePage createOutlinePage()

createModule

public abstract IModule createModule()

createModuleElementLabelProvider

public abstract ModuleElementLabelProvider createModuleElementLabelProvider()

createModuleContentProvider

protected abstract ModuleContentProvider createModuleContentProvider()

createPartControl

public void createPartControl(org.eclipse.swt.widgets.Composite parent)

Specified by:

createPartControl in interface org.eclipse.ui.IWorkbenchPart

Overrides:

createPartControl in class org.eclipse.ui.texteditor.AbstractDecoratedTextEditor

createSourceViewer

protected org.eclipse.jface.text.source.ISourceViewer createSourceViewer(org.eclipse.swt.widgets.Composite parent,
                                                                         org.eclipse.jface.text.source.IVerticalRuler ruler,
                                                                         int styles)

Overrides:

createSourceViewer in class org.eclipse.ui.texteditor.AbstractDecoratedTextEditor

createSourceViewerConfiguration

public org.eclipse.jface.text.source.SourceViewerConfiguration createSourceViewerConfiguration()

init

public void init(org.eclipse.ui.IEditorSite site,
                 org.eclipse.ui.IEditorInput input)

Specified by:

init in interface org.eclipse.ui.IEditorPart

Overrides:

init in class org.eclipse.ui.texteditor.AbstractTextEditor

isClosed

public boolean isClosed()

getText

public String getText()

parseModule

public void parseModule()

doSave

public void doSave(org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Specified by:

doSave in interface org.eclipse.ui.ISaveablePart

Overrides:

doSave in class org.eclipse.ui.texteditor.AbstractTextEditor

supportsHyperlinks

protected abstract boolean supportsHyperlinks()

supportsDirtyTextParsing

protected abstract boolean supportsDirtyTextParsing()

getBackgroundColor

public org.eclipse.swt.graphics.Color getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(org.eclipse.swt.graphics.Color backgroundColor)

close

public void close(boolean save)

Specified by:

close in interface org.eclipse.ui.texteditor.ITextEditor

Overrides:

close in class org.eclipse.ui.texteditor.AbstractTextEditor

getTemplates

public final List<org.eclipse.jface.text.templates.Template> getTemplates()

createActions

protected void createActions()

Overrides:

createActions in class org.eclipse.ui.texteditor.AbstractDecoratedTextEditor

getHighlightingManager

public EpsilonHighlightingManager getHighlightingManager()

isDirty

public boolean isDirty()

Specified by:

isDirty in interface org.eclipse.ui.ISaveablePart

Overrides:

isDirty in class org.eclipse.ui.texteditor.AbstractTextEditor