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

Class AceCompletionValue

java.lang.Object

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

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

public class AceCompletionValue
extends AceCompletion

A completion proposed by an AceCompletionProvider. 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
AceCompletionValue(String name, String value, String meta, int score) Constructor.
AceCompletionValue(String name, String value, String meta, String tooltip, int score) Constructor.

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

AceCompletionValue

public AceCompletionValue(String name,
                          String value,
                          String meta,
                          int score)

Constructor.

Parameters:

name - 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.

value - The text value of the completion. This does not need to be escaped.

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.

AceCompletionValue

public AceCompletionValue(String name,
                          String value,
                          String meta,
                          String tooltip,
                          int score)

Constructor.

Parameters:

name - 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.

value - The text value of the completion. This does not need to be escaped.

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".

tooltip - "tooltip" is an escaped html tooltip to be displayed when the completion option is displayed, this can be null.

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.