OrionTextViewOverlay.java

/*******************************************************************************
 * Copyright (c) 2012-2017 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.ide.editor.orion.client.jso;

import elemental.dom.Element;

import com.google.gwt.core.client.JavaScriptObject;

import org.eclipse.che.ide.editor.orion.client.Action;

public class OrionTextViewOverlay extends JavaScriptObject {

    protected OrionTextViewOverlay() {
    }

    public final native OrionTextViewOptionsOverlay getOptions() /*-{
        return this.getOptions();
    }-*/;

    public final native Element getParent() /*-{
        return this.getOption("parent");
    }-*/;

    public final native void setOptions(final OrionTextViewOptionsOverlay newValue) /*-{
        this.setOptions(newValue);
    }-*/;

    public final native void toggleWrapMode() /*-{
        this.setOptions({wrapMode: !this.getOptions("wrapMode")});
    }-*/;

    public final native void focus() /*-{
        this.focus();
    }-*/;

    public final native boolean hasFocus() /*-{
        this.hasFocus();
    }-*/;

    public final native void redraw() /*-{
        this.redraw();
    }-*/;

    public final native void setRedraw(boolean redraw) /*-{
        this.setRedraw(redraw);
    }-*/;

    public final native OrionTextModelOverlay getModel() /*-{
        return this.getModel();
    }-*/;

    public final native String getText() /*-{
        return this.getText();
    }-*/;

    // selection

    public final native OrionSelectionOverlay getSelection() /*-{
        return this.getSelection();
    }-*/;

    public final native int getLineAtOffset(int offset) /*-{
        return this.getLineAtOffset(offset);
    }-*/;

    public final native int getLineStart(int lineIndex) /*-{
        return this.getLineStart(lineIndex);
    }-*/;

    public final native boolean showSelection() /*-{
        return this.showSelection();
    }-*/;

    public final native boolean showSelection(double additionalFractionScroll) /*-{
        return this.showSelection(additionalFractionScroll);
    }-*/;

    public final native boolean showSelection(double additionalFractionScroll, SimpleCallBack callback) /*-{
        return this.showSelection(additionalFractionScroll, function () {
            callback.@org.eclipse.che.ide.editor.orion.client.jso.OrionTextViewOverlay.SimpleCallBack::onFinished()();
        });
    }-*/;

    public final native boolean showSelection(OrionTextViewShowOptionsOverlay options, SimpleCallBack callback) /*-{
        return this.showSelection(options, function () {
            callback.@org.eclipse.che.ide.editor.orion.client.jso.OrionTextViewOverlay.SimpleCallBack::onFinished()();
        });
    }-*/;

    public final native void setSelection(int start, int end) /*-{
        this.setSelection(start, end);
    }-*/;

    public final native void setSelection(int start, int end, boolean show) /*-{
        this.setSelection(start, end, show);
    }-*/;

    public final native void setSelection(int start, int end, double show) /*-{
        this.setSelection(start, end, show);
    }-*/;

    public final native void setSelection(int start, int end, OrionTextViewShowOptionsOverlay show) /*-{
        this.setSelection(start, end, show);
    }-*/;

    /* there are variants with callbacks also */

    public final native void setCaretOffset(int offset) /*-{
        this.setCaretOffset(offset);
    }-*/;

    public final native void setCaretOffset(int offset, boolean show) /*-{
        this.setCaretOffset(offset, show);
    }-*/;

    public final native void setCaretOffset(int offset, double show) /*-{
        this.setCaretOffset(offset, show);
    }-*/;

    public final native void setCaretOffset(int offset, OrionTextViewShowOptionsOverlay show) /*-{
        this.setCaretOffset(offset, show);
    }-*/;

    public final native int getCaretOffset() /*-{
        return this.getCaretOffset();
    }-*/;


    // keymodes

    public final native void addKeyMode(OrionKeyModeOverlay keyMode) /*-{
        this.addKeyMode(keyMode);
    }-*/;

    public final native void removeKeyMode(OrionKeyModeOverlay keyMode) /*-{
        this.removeKeyMode(keyMode);
    }-*/;

    public final native OrionKeyModeOverlay getKeyModes() /*-{
        return this.getKeyModes();
    }-*/;

    // actions

    public final native void setAction(String actionId, Action action) /*-{
        this.setAction(actionId, function () {
            return action.@org.eclipse.che.ide.editor.orion.client.Action::onAction()();
        });
    }-*/;

    /**
     * Set custom action
     *
     * @param actionId
     *         actonId
     * @param action
     *         implementation of action
     * @param description
     *         action description
     */
    public final native void setAction(String actionId, Action action, String description) /*-{
        var actionDescription = {name: description};
        this.setAction(actionId, function () {
            return action.@org.eclipse.che.ide.editor.orion.client.Action::onAction()();
        }, actionDescription);
    }-*/;

    public final native void setKeyBinding(OrionKeyStrokeOverlay keyBinding, String actionId) /*-{
        this.setKeyBinding(keyBinding, actionId);
    }-*/;

    public final native void update() /*-{
        this.update();
    }-*/;

    public final native void resize() /*-{
        this.resize();
    }-*/;

    // events

    public final native void addEventListener(String eventType, EventHandlerNoParameter handler, boolean useCapture) /*-{
        this.addEventListener(eventType, function () {
            handler.@org.eclipse.che.ide.editor.orion.client.jso.OrionTextViewOverlay.EventHandlerNoParameter::onEvent()();
        }, useCapture);
    }-*/;

    public final native <T extends OrionEventOverlay> void addEventListener(String eventType, EventHandler<T> handler,
                                                                            boolean useCapture) /*-{
        var func = function (param) {
            handler.@org.eclipse.che.ide.editor.orion.client.jso.OrionTextViewOverlay.EventHandler::onEvent(*)(param);
        };
        if ($wnd.che_handels === undefined) {
            $wnd.che_handels = {};
        }
        $wnd.che_handels[handler] = func;
        this.addEventListener(eventType, func, useCapture);
    }-*/;

    public final void addEventListener(String type, EventHandlerNoParameter handler) {
        addEventListener(type, handler, false);
    }

    public final <T extends OrionEventOverlay> void addEventListener(String type, EventHandler<T> handler) {
        addEventListener(type, handler, false);
    }

    public interface EventHandlerNoParameter {
        void onEvent();
    }

    public interface EventHandler<T extends OrionEventOverlay> {
        void onEvent(T parameter);
    }

    public interface SimpleCallBack {
        void onFinished();
    }

    public final native void setTopIndex(int topLine) /*-{
        this.setTopIndex(topLine);
    }-*/;

    public final native void setBottomIndex(int bottomLine) /*-{
        this.setBottomIndex(bottomLine);
    }-*/;

    public final native int getTopIndex() /*-{
        return this.getTopIndex();
    }-*/;

    public final native int getBottomIndex() /*-{
        return this.getBottomIndex();
    }-*/;

    public final native int getTopIndex(boolean fullyVisible) /*-{
        return this.getTopIndex(fullyVisible);
    }-*/;

    public final native int getBottomIndex(boolean fullyVisible) /*-{
        return this.getBottomIndex(fullyVisible);
    }-*/;

    public final native int getLinePixel(int lineIndex) /*-{
        return this.getLinePixel(lineIndex);
    }-*/;

    /**
     * Returns the {x, y} pixel location of the top-left corner of the character bounding box at the specified offset
     * in the document. The pixel location is relative to the document.
     *
     * @param offset
     *         the text offset
     * @return the pixel location
     */
    public final native OrionPixelPositionOverlay getLocationAtOffset(int offset) /*-{
        return this.getLocationAtOffset(offset);
    }-*/;

    /**
     * Converts the given rectangle from one coordinate spaces to another.
     * The supported coordinate spaces are:
     * "document" - relative to document, the origin is the top-left corner of first line
     * "page" - relative to html page that contains the text view
     * All methods in the view that take or return a position are in the document coordinate space.
     *
     * @return the pixel location
     */
    public final native OrionPixelPositionOverlay convert(OrionPixelPositionOverlay rect, String from, String to) /*-{
        return this.convert(rect, from, to);
    }-*/;

    /**
     * Returns the default line height
     *
     * @return
     */
    public final native int getLineHeight() /*-{
        return this.getLineHeight();
    }-*/;

    /**
     * Returns the character offset nearest to the given pixel location. The pixel location is relative to the document.
     *
     * @param x
     *         the horizontal pixel coordinate
     * @param y
     *         the vertical pixel coordinate
     * @return the text offset
     */
    public final native int getOffsetAtLocation(int x, int y) /*-{
        return this.getOffsetAtLocation(x, y);
    }-*/;


    /**
     * Replaces the text in the given range with the given text.
     * The character at the end offset is not replaced.
     */
    public final native void setText(String text, int start, int end) /*-{
        this.setText(text, start, end);
    }-*/;


    /**
     * Adds a ruler to the text view at the specified position.
     * The position is relative to the ruler location.
     */
    public final native void addRuler(OrionExtRulerOverlay ruler, int index) /*-{
        this.addRuler(ruler, index);
    }-*/;

    /**
     * Get the view rulers.
     */
    public final native OrionExtRulerOverlay[] getRulers() /*-{
        return this.getRulers();
    }-*/;

    public final native <T extends OrionEventOverlay> void removeEventListener(String eventType, EventHandler<T> handler,

                                                                               boolean useCapture) /*-{
        if ($wnd.che_handels) {
            this.removeEventListener(eventType, $wnd.che_handels[handler], useCapture);
        }
    }-*/;

    /**
     * Get action description by actionId
     *
     * @param actionId
     * @return action description
     */
    public final native String getActionDescription(String actionId) /*-{
        var object = this.getActionDescription(actionId);
        return (object != null) ? object.name : null;
    }-*/;
}