PairsMarker.java

/*
 * Copyright 2008 Ayman Al-Sairafi ayman.alsairafi@gmail.com
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License 
 *       at http://www.apache.org/licenses/LICENSE-2.0 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 * See the License for the specific language governing permissions and 
 * limitations under the License.  
 */
package jsyntaxpane.components;

import java.awt.Color;
import jsyntaxpane.actions.*;
import javax.swing.JEditorPane;
import javax.swing.event.CaretEvent;
import javax.swing.event.CaretListener;
import javax.swing.text.JTextComponent;
import jsyntaxpane.SyntaxDocument;
import jsyntaxpane.Token;
import jsyntaxpane.util.Configuration;

/**
 * This class highlights any pairs of the given language.  Pairs are defined
 * with the Token.pairValue.
 *
 * @author Ayman Al-Sairafi
 */
public class PairsMarker implements CaretListener, SyntaxComponent {
    public static final String PROPERTY_COLOR = "PairMarker.Color";

    private JTextComponent pane;
    private Markers.SimpleMarker marker;

    public PairsMarker() {
    }

    @Override
    public void caretUpdate(CaretEvent e) {
        removeMarkers();
        int pos = e.getDot();
        SyntaxDocument doc = ActionUtils.getSyntaxDocument(pane);
        Token token = doc.getTokenAt(pos);
        if (token != null && token.pairValue != 0) {
            Markers.markToken(pane, token, marker);
            Token other = doc.getPairFor(token);
            if (other != null) {
                Markers.markToken(pane, other, marker);
            }
        }
    }

    /**
     * Remove all the highlights from the editor pane.  This should be called
     * when the editorkit is removed.
     */
    public void removeMarkers() {
        Markers.removeMarkers(pane, marker);
    }

    public void config(Configuration config, String prefix) {
        Color markerColor = new Color(config.getPrefixInteger(prefix,
                PROPERTY_COLOR,
                0xeeee33));
        this.marker = new Markers.SimpleMarker(markerColor);
    }

    public void install(JEditorPane editor) {
        pane = editor;
        pane.addCaretListener(this);
    }

    public void deinstall(JEditorPane editor) {
        pane.removeCaretListener(this);
        removeMarkers();
    }
}