org.netbeans.spi.editor.fold

Interface FoldTypeProvider

@MimeLocation(subfolderName="FoldManager")
public interface FoldTypeProvider

Provider of FoldType constants for the MimeType. The Provider should enumerate FoldTypes that apply to the given MIME type. There can be multiple providers for a MIME type - some advanced constructions in the language can be recognized / folded by extension modules. Consider Java vs. Bean Patterns, or XML vs. Spring bean config.

FoldTypes will be collected and some pieces of UI can present the folds, such as Auto-folding options.

The Provider may specify inheritable=true; in that case the contributed FoldTypes will become available for more specific MIME types, too. For example, if a FoldTypeProvider for text/xml registers FoldTypes TAG and COMMENT with inheritable=true, those FoldTypes will be listed also for text/x-ant+xml. This feature allows to "inject" Fold types and FoldManager on general MIME type ("") for all types of files.

Since:

1.35

Method Summary

Modifier and Type	Method and Description
Collection	getValues(Class type) Enumerates values for the given type.
boolean	inheritable() Determines whether the folds propagate to child mime types(paths).

Method Detail

getValues

Collection getValues(Class type)

Enumerates values for the given type.

Returns:

FoldType values.

inheritable

boolean inheritable()

Determines whether the folds propagate to child mime types(paths). If the method returns true, then more specific MIME types will also list FoldTypes returned by this Provider.

Returns:

whether the provided FoldTypes should be inherited (true).