AceCompletionSnippetSegmentTabstopItem.java

/*
 * Copyright 2015 JBoss, by Red Hat, Inc
 *
 * 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 org.uberfire.ext.widgets.common.client.ace;

/**
 * A segment of a completion snippet
 */
public class AceCompletionSnippetSegmentTabstopItem implements AceCompletionSnippetSegment {

    private String tabstopText;

    /**
     * Text that should fit inside a tabstop, the first tabstop is selected after a substitution, and subsequent tabstops are moved between by
     * pressing the tab button. Tabstops are identified using an id.
     * @param tabstopText The literal text that makes up part of the tab stop. This does not need to be escaped, escaping will be handled automatically.
     */
    public AceCompletionSnippetSegmentTabstopItem(String tabstopText) {
        this.tabstopText = tabstopText;
    }

    @Override
    public String getPreparedText(int tabstopNumber) {

        // Special characters need escaping so that we can support tokens, see demo to see how this works in practice

        final String escapedText =
                tabstopText
                        .replace("\\",
                                 "\\\\") // backslash becomes double backslash
                        .replace("$",
                                 "\\$")   // dollar becomes backslash dollar
                        .replace("}",
                                 "\\}");  // right brace becones backslash right brace
        return "${" + tabstopNumber + ":" + escapedText + "}";
    }
}