org.kie.uberfire.client.ace.AceCompletionSnippetSegment Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kie-uberfire-widgets-commons Show documentation

KIE UberFire Widgets Commons

The newest version!

// Copyright (c) 2011-2014, David H. Hovemeyer 
// Copyright (c) 2014, Chris Ainsley 
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package org.kie.uberfire.client.ace;


/**
 * A segment of a completion snippet
 * */
public interface AceCompletionSnippetSegment  {
	
	/**
	 * Gets the escaped and prepared textual representation of this snippet segment (backslash and dollar are escaped in general and the dollar is used for certain special tokens)
	 * @return the prepared textual representation of this snippet segment
	 */
	public String getPreparedText( int tabStopNumber );
}