org.povclipse2.editors

Class PovrayEditor

java.lang.Object

TextEditor

org.povclipse2.editors.PovrayEditor

public class PovrayEditor
extends TextEditor

Editor for a POV-Ray source file

Author:

Wolfgang Möstl

See Also:

gitweb

Field Summary

Fields

Modifier and Type	Field and Description
protected PovrayEditorConfiguration	configuration
static java.lang.String	ID
static java.lang.String	MARKER_ROOT
protected PovClipseHoverPresenter	presenter

Constructor Summary

Constructors

Constructor and Description
PovrayEditor() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	createActions()
void	createPartControl(Composite parent)
protected ISourceViewer	createSourceViewer(Composite parent, IVerticalRuler ruler, int styles)
void	dispose()
java.lang.Object	getAdapter(java.lang.Class required)
IAnnotationHover	getCurrentAnnotationHover() Returns the currently displayed annotaion hover if any, null otherwise.
ITextHover	getCurrentTextHover() Returns the currently displayed text hover if any, null otherwise.
java.lang.String	getEditedFileName()
PovrayContentOutlinePage	getOutlinePage()
PovrayEditorConfiguration	getPovrayEditorConfiguration()
protected void	init()
protected void	initializeEditor()
protected void	initializeKeyBindingScopes() Initializes the key binding scopes of this editor.
void	notifyKeyListenersForPreferenceUpdate()
void	updateErrorAnnotations() Updates all PovClipse related markers.
void	updateFoldingStructure() recalculates the folding structure.
void	updatePreferenceSettings()

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

MARKER_ROOT

public static final java.lang.String MARKER_ROOT

See Also:

Constant Field Values

configuration

protected PovrayEditorConfiguration configuration

presenter

protected PovClipseHoverPresenter presenter

Constructor Detail

PovrayEditor

public PovrayEditor()

Constructor.

Method Detail

init

protected void init()

initializeEditor

protected void initializeEditor()

getPovrayEditorConfiguration

public PovrayEditorConfiguration getPovrayEditorConfiguration()

updatePreferenceSettings

public void updatePreferenceSettings()

notifyKeyListenersForPreferenceUpdate

public void notifyKeyListenersForPreferenceUpdate()

dispose

public void dispose()

initializeKeyBindingScopes

protected void initializeKeyBindingScopes()

Initializes the key binding scopes of this editor.

createActions

protected void createActions()

createPartControl

public void createPartControl(Composite parent)

getCurrentAnnotationHover

public IAnnotationHover getCurrentAnnotationHover()

Returns the currently displayed annotaion hover if any, null otherwise.

Returns:

the currently displayed annotaion hover or null

getCurrentTextHover

public ITextHover getCurrentTextHover()

Returns the currently displayed text hover if any, null otherwise.

Returns:

the currently displayed text hover or null

createSourceViewer

protected ISourceViewer createSourceViewer(Composite parent,
                                           IVerticalRuler ruler,
                                           int styles)

getAdapter

public java.lang.Object getAdapter(java.lang.Class required)

getOutlinePage

public PovrayContentOutlinePage getOutlinePage()

Returns:

The instance of the outline page.

updateFoldingStructure

public void updateFoldingStructure()

recalculates the folding structure.

updateErrorAnnotations

public void updateErrorAnnotations()

Updates all PovClipse related markers.

This is the main hook for generating error- warning- or information markers.

Note: Make sure that ***ALL*** generated markers are children of MARKER_ROOT, as all markers of type MARKER_ROOT are deleted - including the sub-types - prior to generating the new markers.

getEditedFileName

public java.lang.String getEditedFileName()

Returns:

The name (including the path) of the resource being edited.