Eclipse Editor: Partially editable/read-only editor Part 2

Decorating read-only section by line background

The second part of this series I am going to explain changing line background color for particular section of editor, in this case read-only code section. We had reached till restricting editing in read-only code section in previous post.

After previous post changes, user won’t able to edit in read-only code section, but user should get some kind of feedback about not able to edit the particular section of file. It would be very informative to color the background with grey color so that user understand that greyed out section is read-only.

This can be achieved by providing Line background color listen over source viewer. 

LineBackgroundListener lineBackgroundListener = new LineBackgroundListener(){
    @Override
    public void lineGetBackground(LineBackgroundEvent event) {
        int offset = event.lineOffset;
        if(editorSupport.isInsideReadOnlyBlock(offset, 0)){
            event.lineBackground = colorManager.getColor(new RGB(245,245,245));
        }
    }
};
//Install line background color listener on source viewer 
getSourceViewer().getTextWidget().addLineBackgroundListener(lineBackgroundListener);


Result of installing above listener


Untitled


You can see grey background for the read-only code section ( highlighted with red rectangle in above image).


Complete XMLEditor implementation



package sample.xml.editor.editors;
 
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IEventConsumer;
import org.eclipse.swt.custom.LineBackgroundEvent;
import org.eclipse.swt.custom.LineBackgroundListener;
import org.eclipse.swt.events.VerifyEvent;
import org.eclipse.swt.graphics.RGB;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.editors.text.TextEditor;
import org.eclipse.ui.texteditor.IDocumentProvider;
 
public class XMLEditor extends TextEditor {
 
    private ColorManager colorManager;
    public CustomEditorSupport editorSupport = null;
 
    public XMLEditor() {
        super();
        editorSupport = new CustomEditorSupport(this);
        colorManager = new ColorManager();
        setSourceViewerConfiguration(new XMLConfiguration(colorManager));
        setDocumentProvider(new XMLDocumentProvider());
    }
    public void dispose() {
        colorManager.dispose();
        super.dispose();
    }
    
    public IDocument getDocument() {
        IDocumentProvider documentProvider = getDocumentProvider();
        if (documentProvider != null) {
            return documentProvider.getDocument(getEditorInput());
        }
        return null;
    }
    
    @Override
    public void createPartControl(Composite parent) {
        super.createPartControl(parent);
        /* Install Keyboard event consumer to disable any editing  read only
         * code section */
        getSourceViewer().setEventConsumer(new IEventConsumer() {
            @Override
            public void processEvent(VerifyEvent event) {
                int offset = event.start;
                if(editorSupport.isInsideReadOnlyBlock(offset, 0)){
                    // swallow the event.
                    event.doit = false;
                    return;
                }
            }
        });
        
        LineBackgroundListener lineBackgroundListener = new LineBackgroundListener(){
            @Override
            public void lineGetBackground(LineBackgroundEvent event) {
                int offset = event.lineOffset;
                if(editorSupport.isInsideReadOnlyBlock(offset, 0)){
                    event.lineBackground = colorManager.getColor(new RGB(245,245,245));
                }
            }
        };
        //Install line background color listener on source viewer 
        getSourceViewer().getTextWidget().addLineBackgroundListener(lineBackgroundListener);
    }
 
}

Comments

Post a Comment

Popular posts from this blog

State Design Pattern by Example

Image
State pattern falls under the category of Behavioral patterns. State design pattern comes in picture when a system’s behavior is depends on its own state or some other resource’s state. If an implementation is depends on the states, we end up with snarl of conditional statement every where in code. A very neat approach to deal with such situation is to separate out every state’s behavior and use them where ever they are applicable. The state pattern allows an object to alter its behavior when is internal state changes . The object is appeared to change its class. State pattern is a way to implement the same. Class Diagram : As above class diagram shows, System class holds state instance. As state of system changes , all handle request delegated to respective State’s concrete implementation. Example : Have an example of Vending machine. Vending machine has following states No Coin Inserted Coin Inserted Dispensing Empty Following diagram explain behavior...
Read more

Eclipse command framework core expression: Property tester

Image
Addition to Eclipse command framework series, this post explains use of property tester to control command’s enable/visible properties. In earlier post we have tried declarative way to achieve same thing but property tester gives us more control. Property tester is associated with, tester class which implements PropertyTester.java, a namespace and set of property which it supports. We can refer this property tester using its namespace + a property name. It gives you call back to test() method with property name as parameter inside property tester class. We can configure property tester for type of input parameter. Here is sample declaration of property tester extension point < extension point ="org.eclipse.core.expressions.propertyTesters" > < propertyTester class ="com.example.advance.cmd.EditorTester" id ="com.example.advance.cmd.propertyTester1" namespace ="com.example.advance.cm...
Read more

Composite Design Pattern by example

Image
This post explains Composite design pattern with an example. When to use ? – Use Composite pattern when you have treat a collection of objects as they were once one thing. With Composite design pattern it is very easy to simplify operations over collection data structure. It reduces complexity of the code required if you were going to handle collection as special case. How to Use? - The Composite pattern consist of Component, Leaf and Composite Classes as shown below class diagram Component – Component declares the common interface that both the single and composite nodes will implements Leaf – The leaf class represent the singular atomic data type implementing he component interface.     Composite – Composite is an abstract entity which declares common functionality which are needed by concrete implementation for handling collection data. An Example -   Item.java public interface Item {     public double getPrice(); ...
Read more