edu.ycp.cs.dh.acegwt.client.ace

Class AceCompletionSnippet

java.lang.Object

edu.ycp.cs.dh.acegwt.client.ace.AceCompletion

edu.ycp.cs.dh.acegwt.client.ace.AceCompletionSnippet

public class AceCompletionSnippet
extends AceCompletion

A completion proposed by an AceCompletionProvider. This particular implementation allows for tabstops to be defines post-sunstitution.

This is useful when providing substitutions with a default value in the centre of the substituted text value that typically has to be overwritten by the user or when substituting several values that should be modified by the user.

There are two different constructors, a simple constructor that trust the user to manually escape the snippet text, and a constructor where the escaping and tokenization is managed.

Warning: this is an experimental feature of AceGWT. It is possible that the API will change in an incompatible way in future releases.

Constructor Summary

Constructors

Constructor and Description
AceCompletionSnippet(java.lang.String caption, AceCompletionSnippetSegment[] snippetSegments, java.lang.String meta, java.lang.String htmlTooltip, int score) Creates a snippet type substitution.
AceCompletionSnippet(java.lang.String caption, java.lang.String snippet, int score, java.lang.String meta, java.lang.String htmlTooltip) Creates a snippet type substitution.

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

AceCompletionSnippet

public AceCompletionSnippet(java.lang.String caption,
                            AceCompletionSnippetSegment[] snippetSegments,
                            java.lang.String meta,
                            java.lang.String htmlTooltip,
                            int score)

Creates a snippet type substitution. A snippet-type substitution allows for tab-stop regions to be defined, in which text is automatically selected immediately the autocomplete substitution. Multiple regions may be defined to be tabbed through for user editing.

This may be useful if a substiution is a template type subsitution where several areas of the template typically need to be edited always after a substitution. Being able to tab through the regions rather than having to manually locate and edit is a lot faster when dealing with potentially repeated text editing usage patterns.

Parameters:

caption - The caption of the completion (this is the left aligned autocompletion name on the left side of items in the dropdown box. If only a single completion is available in a context, then the caption will not be seen.

snippetSegments - The segments that make up this snippet. None of these segments needs to be escaped, this will be handled automatically.

meta - "meta" means the category of the substitution (this appears right aligned on the dropdown list). This is freeform description and can contain anything but typically a very short category description (9 chars or less) such as "function" or "param" or "template".

htmlTooltip - the HTML tooltip

score - The score is the value assigned to the autocompletion option. Scores with a higher value will appear closer to the top. Items with an identical score are sorted alphbetically by caption in the drop down.

AceCompletionSnippet

public AceCompletionSnippet(java.lang.String caption,
                            java.lang.String snippet,
                            int score,
                            java.lang.String meta,
                            java.lang.String htmlTooltip)

Creates a snippet type substitution. A snippet-type substitution allows for tab-stop regions to be defined, in which text is automatically selected immediately the autocomplete substitution. Multiple regions may be defined to be tabbed through for user editing.

This may be useful if a substiution is a template type subsitution where several areas of the template typically need to be edited always after a substitution. Being able to tab through the regions rather than having to manually locate and edit is a lot faster when dealing with potentially repeated text editing usage patterns.

NOTE :: This is the advanced version of the completion snippet, where escaping and tokenization must be done manually.

It is recommended to use the alternative AceCompletionSnippet(String, AceCompletionSnippetSegment[], String, String, int) constructor for 99% of use-cases. This raw version is provided as a convenience.

Parameters:

caption - The caption of the completion (this is the left aligned autocompletion name on the left side of items in the dropdown box. If only a single completion is available in a context, then the caption will not be seen.

snippet - the snippet text of the substitution, this should be in the format start-${0:snippetText}-after-${1:nexttabstop}-after. $ and backslash and rbrace should be escaped with a leading backslash

meta - "meta" means the category of the substitution (this appears right aligned on the dropdown list). This is freeform description and can contain anything but typically a very short category description (9 chars or less) such as "function" or "param" or "template".

score - The score is the value assigned to the autocompletion option. Scores with a higher value will appear closer to the top. Items with an identical score are sorted alphbetically by caption in the drop down.

htmlTooltip - the HTML tooltip