Package com.intellij.openapi.fileTypes

Interface SyntaxHighlighter

All Known Implementing Classes:

BuildoutCfgSyntaxHighlighter, CommandLineSyntaxHighlighter, CustomFileHighlighter, FileTemplateHighlighter, GroovyDocSyntaxHighlighter, GroovySyntaxHighlighter, HtmlFileHighlighter, IgnoreLanguageHighlighter, JavaFileHighlighter, JqlHighlighter, MarkdownSyntaxHighlighter, PlainSyntaxHighlighter, PropertiesHighlighter, PropertiesValueHighlighter, PyHighlighter, RegExpHighlighter, RestSyntaxHighlighter, RncHighlighter, ShSyntaxHighlighter, SyntaxHighlighterBase, SyntaxHighlighterOverEditorHighlighter, TemplateDataHighlighterWrapper, TextMateHighlighter, XmlFileHighlighter, XPathHighlighter, YAMLSyntaxHighlighter

public interface SyntaxHighlighter

Controls the syntax highlighting of a file. Extend SyntaxHighlighterBase.

See Also:

SyntaxHighlighterFactory.getSyntaxHighlighter(com.intellij.openapi.project.Project, com.intellij.openapi.vfs.VirtualFile), SyntaxHighlighterFactory.getSyntaxHighlighter(com.intellij.lang.Language, com.intellij.openapi.project.Project, com.intellij.openapi.vfs.VirtualFile)

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<KeyedFactoryEPBean>	EP_NAME
static SyntaxHighlighterProvider	PROVIDER Deprecated. see SyntaxHighlighterFactory.getSyntaxHighlighter(com.intellij.openapi.project.Project, com.intellij.openapi.vfs.VirtualFile) and SyntaxHighlighterFactory.getSyntaxHighlighter(com.intellij.lang.Language, com.intellij.openapi.project.Project, com.intellij.openapi.vfs.VirtualFile)

Method Summary

Modifier and Type	Method and Description
Lexer	getHighlightingLexer() Returns the lexer used for highlighting the file.
TextAttributesKey []	getTokenHighlights(IElementType tokenType) Returns the list of text attribute keys used for highlighting the specified token type.

Field Detail

EP_NAME

static final ExtensionPointName<KeyedFactoryEPBean> EP_NAME

PROVIDER

@Deprecated
static final SyntaxHighlighterProvider PROVIDER

Deprecated. see SyntaxHighlighterFactory.getSyntaxHighlighter(com.intellij.openapi.project.Project, com.intellij.openapi.vfs.VirtualFile) and SyntaxHighlighterFactory.getSyntaxHighlighter(com.intellij.lang.Language, com.intellij.openapi.project.Project, com.intellij.openapi.vfs.VirtualFile)

Method Detail

getHighlightingLexer

Lexer getHighlightingLexer()

Returns the lexer used for highlighting the file. The lexer is invoked incrementally when the file is changed, so it must be capable of saving/restoring state and resuming lexing from the middle of the file.

Returns:

The lexer implementation.

getTokenHighlights

TextAttributesKey [] getTokenHighlights(IElementType tokenType)

Returns the list of text attribute keys used for highlighting the specified token type. The attributes of all attribute keys returned for the token type are successively merged to obtain the color and attributes of the token.

Parameters:

tokenType - The token type for which the highlighting is requested.

Returns:

The array of text attribute keys.