jsyntaxpane.actions.CaretMonitor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.kevoree.tools.ui.kevscript Show documentation
There is a newer version: 5.3.2
Show newest version
/*
 * Copyright 2008 Ayman Al-Sairafi [email protected]
 *
 * 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.actions;

import javax.swing.JLabel;
import javax.swing.event.CaretEvent;
import javax.swing.event.CaretListener;
import javax.swing.text.BadLocationException;
import javax.swing.text.JTextComponent;
import jsyntaxpane.SyntaxDocument;

/**
 * This class can be used to display the caret location in friendly manner for
 * an EditorPane.
 *
 * @author Ayman Al-Sairafi
 */
public class CaretMonitor implements CaretListener {

    private JLabel label;
    private JTextComponent text;

    /**
     * The format string to use when there is no selected:
     * the arguments are:
     * 1 based line number
     * 1 based column number
     * 0 based position
     */
    private String noSelectionFormat = "%d:%d (%d)";
    /**
     * The format string to use when something is selected:
     * the arguments are:
     * 1 based line number for selection start
     * 1 based column number for selection start
     * 1 based line number for selection end
     * 1 based column number for selection end
     * length of selection
     * 0 based start position
     * 0 based end position
     */
    private String selectionFormat = "%d:%d - %d:%d (%d)";

    public CaretMonitor(JTextComponent text, JLabel label) {
        this.label = label;
        this.text = text;
        text.addCaretListener(this);
		updateLabel(text.getCaretPosition());
    }

    @Override
    public void caretUpdate(CaretEvent evt) {
		updateLabel(evt.getDot());
	}

	protected void updateLabel(int pos) {
        if (text.getDocument() instanceof SyntaxDocument) {
            try {
                if (text.getSelectionStart() == text.getSelectionEnd()) {
                    String loc = String.format(noSelectionFormat,
                            ActionUtils.getLineNumber(text, pos) + 1,
                            ActionUtils.getColumnNumber(text, pos) + 1,
                            pos);
                    label.setText(loc);
                } else {
                    int start = text.getSelectionStart();
                    int end = text.getSelectionEnd();
                    String loc = String.format(selectionFormat,
                            ActionUtils.getLineNumber(text, start) + 1,
                            ActionUtils.getColumnNumber(text, start) + 1,
                            ActionUtils.getLineNumber(text, end) + 1,
                            ActionUtils.getColumnNumber(text, end) + 1,
                            (end - start),
                            start,
                            end);
                    label.setText(loc);
                }
            } catch (BadLocationException ex) {
                label.setText("Ex: " + ex.getMessage());
            }
        } else {
            label.setText(String.format(noSelectionFormat, 1, 1, 1));
        }
    }

    @Override
    protected void finalize() throws Throwable {
        text.removeCaretListener(this);
        super.finalize();
    }

    public String getNoSelectionFormat() {
        return noSelectionFormat;
    }

    public void setNoSelectionFormat(String noSelectionFormat) {
        this.noSelectionFormat = noSelectionFormat;
    }

    public String getSelectionFormat() {
        return selectionFormat;
    }

    public void setSelectionFormat(String selectionFormat) {
        this.selectionFormat = selectionFormat;
    }

}