org.netbeans.api.editor.settings

Class CodeTemplateSettings

java.lang.Object

org.netbeans.api.editor.settings.CodeTemplateSettings

public abstract class CodeTemplateSettings
extends Object

The list of code templates available for particular mime paths. Instances of this class can be retrieved from MimeLookup as shown on the example below.

 Lookup l = MimeLookup.getLookup(MimePath.parse(mimePath));
 CodeTemplateSettings cds = l.lookup(CodeTemplateSettings.class);
 List codeTemplates = cds.getCodeTemplateDescriptions();
 

IMPORTANT: There is a much more powerful API for working with editor code templates in Editor Code Templates module. If you are retrieving this class from MimeLookup you should should probably use the Editor Code Templates API instead.

This class must NOT be extended by any API clients.

Constructor Summary

Constructors

Constructor and Description
CodeTemplateSettings() Construction prohibited for API clients.

Method Summary

Methods

Modifier and Type	Method and Description
abstract List<CodeTemplateDescription>	getCodeTemplateDescriptions() Gets the list of code template descriptions.
abstract KeyStroke	getExpandKey() Gets the keystroke that expands the code templates abbreviations.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeTemplateSettings

public CodeTemplateSettings()

Construction prohibited for API clients.

Method Detail

getCodeTemplateDescriptions

public abstract List<CodeTemplateDescription> getCodeTemplateDescriptions()

Gets the list of code template descriptions.

Returns:

An unmodifiable list of code template descriptions.

getExpandKey

public abstract KeyStroke getExpandKey()

Gets the keystroke that expands the code templates abbreviations.

Returns:

A keystroke that expands code template abbreviations to its code text.