HighlightsLayerFactory (Editor Library 2) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.lib2/1 1.3 2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.spi.editor.highlighting
Interface HighlightsLayerFactory

public interface HighlightsLayerFactory

Factory for producing HighlightsLayers. Modules can implement this interface and register their implementations among the mime-type specific services under the Editors folder on the system filesystem.

The infrastructure uses HighlightsLayerFactory instances registered in the mime-type specific registry to create HighlightsLayers, which will participate in rendering a document. All factories that the infrastructure considers relelvant for rendering a document will be asked to create HighlightsLayers for that document.

Nested Class Summary

static class HighlightsLayerFactory.Context
The context passed to a factory when it is asked to create HighlightLayers.

Method Summary

HighlightsLayer[] createLayers(HighlightsLayerFactory.Context context)
Creates HighlightLayers appropriate for the context passed in.

Nested Class Summary
`static class`	`HighlightsLayerFactory.Context` The context passed to a factory when it is asked to create `HighlightLayer`s.

Method Summary
`HighlightsLayer[]`	`createLayers(HighlightsLayerFactory.Context context)` Creates `HighlightLayer`s appropriate for the context passed in.

Method Detail

createLayers

HighlightsLayer[] createLayers(HighlightsLayerFactory.Context context)

Creates HighlightLayers appropriate for the context passed in.

Parameters:: context - The context that should be used for creating the layer.
Returns:: The array of HighlightLayers that should be used for rendering the document in the Context. This method can return null if there are no HighlightLayers available.