Package com.intellij.openapi.fileTypes

Class SyntaxHighlighterFactory

java.lang.Object

com.intellij.openapi.fileTypes.SyntaxHighlighterFactory

Direct Known Subclasses:

IgnoreLanguageHighlighterFactory, JavaSyntaxHighlighterFactory, JsonSyntaxHighlighterFactory, ManifestSyntaxHighlighterFactory, PlainSyntaxHighlighterFactory, PlainTextSyntaxHighlighterFactory, PySyntaxHighlighterFactory, RestHighlighterFactory, SingleLazyInstanceSyntaxHighlighterFactory, TextMateSyntaxHighlighterFactory, YAMLSyntaxHighlighterFactory

public abstract class SyntaxHighlighterFactory
extends java.lang.Object

See Also:

SingleLazyInstanceSyntaxHighlighterFactory

Field Summary

Fields

Modifier and Type	Field and Description
static SyntaxHighlighterLanguageFactory	LANGUAGE_FACTORY

Constructor Summary

Constructors

Constructor and Description
SyntaxHighlighterFactory()

Method Summary

Modifier and Type	Method and Description
static SyntaxHighlighter	getSyntaxHighlighter(FileType fileType, Project project, VirtualFile file) Returns syntax highlighter for the given file type.
static SyntaxHighlighter	getSyntaxHighlighter(Language language, Project project, VirtualFile file) Returns syntax highlighter for the given language.
abstract SyntaxHighlighter	getSyntaxHighlighter(Project project, VirtualFile virtualFile) Override this method to provide syntax highlighting (coloring) capabilities for your language implementation.

Methods inherited from class java.lang.Object

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

Field Detail

LANGUAGE_FACTORY

public static final SyntaxHighlighterLanguageFactory LANGUAGE_FACTORY

Constructor Detail

SyntaxHighlighterFactory

public SyntaxHighlighterFactory()

Method Detail

getSyntaxHighlighter

public static SyntaxHighlighter getSyntaxHighlighter(Language language,
                                                     Project project,
                                                     VirtualFile file)

Returns syntax highlighter for the given language.

Parameters:

language - a Language to get highlighter for

project - might be necessary to gather various project settings from

file - might be necessary to collect file specific settings

Returns:

SyntaxHighlighter interface implementation for the given file type

getSyntaxHighlighter

public static SyntaxHighlighter getSyntaxHighlighter(FileType fileType,
                                                     Project project,
                                                     VirtualFile file)

Returns syntax highlighter for the given file type. Note: it is recommended to use getSyntaxHighlighter(Language, Project, VirtualFile) in most cases, and use this method only when do not know the language you use.

Parameters:

fileType - a file type to use to select appropriate highlighter

project - might be necessary to gather various project settings from

file - might be necessary to collect file specific settings

Returns:

SyntaxHighlighter interface implementation for the given file type

getSyntaxHighlighter

public abstract SyntaxHighlighter getSyntaxHighlighter(Project project,
                                                       VirtualFile virtualFile)

Override this method to provide syntax highlighting (coloring) capabilities for your language implementation. By syntax highlighting we mean highlighting of keywords, comments, braces etc. where lexing the file content is enough to identify proper highlighting attributes.

Default implementation doesn't highlight anything.

Parameters:

project - might be necessary to gather various project settings from.

virtualFile - might be necessary to collect file specific settings

Returns:

SyntaxHighlighter interface implementation for this particular language.