org.uberfire.ext.widgets.common.client.ace

Class AceCompletionSnippetSegmentTabstopItem

java.lang.Object

org.uberfire.ext.widgets.common.client.ace.AceCompletionSnippetSegmentTabstopItem

All Implemented Interfaces:

AceCompletionSnippetSegment

public class AceCompletionSnippetSegmentTabstopItem
extends Object
implements AceCompletionSnippetSegment

A segment of a completion snippet

Constructor Summary

Constructors

Constructor and Description
AceCompletionSnippetSegmentTabstopItem(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.

Method Summary

Modifier and Type	Method and Description
String	getPreparedText(int tabstopNumber) 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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AceCompletionSnippetSegmentTabstopItem

public AceCompletionSnippetSegmentTabstopItem(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.

Parameters:

tabstopText - The literal text that makes up part of the tab stop. This does not need to be escaped, escaping will be handled automatically.

Method Detail

getPreparedText

public String getPreparedText(int tabstopNumber)

Description copied from 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)

Specified by:

getPreparedText in interface AceCompletionSnippetSegment

Returns:

the prepared textual representation of this snippet segment