org.netbeans.api.editor.fold

Class FoldType

java.lang.Object

org.netbeans.api.editor.fold.FoldType

public final class FoldType
extends Object

Each Fold is identified by its fold type.
Each fold type presents a fold type acceptor as well accepting just itself.

As the equals() method is declared final (delegating to super) the fold types can directly be compared by using == operator.

FoldTypes are MIME-type specific. Sets of FoldType, which apply to a certain MIME type are collected in a FoldType.Domain, which can be obtained by FoldUtilities.getFoldTypes(java.lang.String). FoldTypes for a MIME type are collected with the help of FoldTypeProvider.

Several generalized types of folds are defined in this class as constants. When creating custom FoldTypes, please check carefully whether the new FoldType is not, in fact, one of these general ones, or is not a specialization of it. If a general action (e.g. auto-collapse all folds XXX) would make sense for the new fold, consider to FoldType.derive(java.lang.String, java.lang.String, org.netbeans.api.editor.fold.FoldTemplate) it from an existing one.

Each FoldType has a specific FoldTemplate instance that controls how it is presented. If a new Fold has same semantics as an existing one, but a different FoldTemplate is needed, use FoldType.override(java.lang.String, org.netbeans.api.editor.fold.FoldTemplate) to create a new FoldType with appropriate properties. FoldTypes defined here can be reused in individual MIME types, if their configuration is appropriate. In general, FoldTypes from more general MIME types (e.g. text/xml) can be reused in specialized ones (e.g. text/x-ant+xml).

FoldTypes can form a hierarchy of generalization. For example java Method fold can have a more general 'parent', FoldType.MEMBER.

The generalization is designed to allow several kinds of the same concept operated separately at the level of the language, but managed at once using general options or operations. If no settings are specified for Method folding, FoldType.MEMBER settings are applied. Likewise, a general-purpose folding operation can work on FoldType.MEMBER fold type, which will affect both FUNCTION in PHP or METHOD in java (and other fold types in other languages).

Because of this, please be careful to use FoldType.isKindOf(org.netbeans.api.editor.fold.FoldType) to check whether a FoldType is of a specific type. This method respects the generalization. == can be still used to check for exact type match. When using ==, javadoc comments may be evaluated as different from general 'documentation' and yet different from PHP docs. Comparison using == are safe only when applied on FoldType instances defined for the same MIME type

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FoldType.Domain Represents a value set of FoldTypes for one MIME type.

Field Summary

Fields

Modifier and Type	Field and Description
static FoldType	CODE_BLOCK A generic code block.
static FoldType	COMMENT Unspecified type of comment
static FoldType	DOCUMENTATION Documentation comment, as defined by the language
static FoldType	IMPORT Various import, includes and references to sibling files.
static FoldType	INITIAL_COMMENT Initial file-level comment.
static FoldType	MEMBER Member of a symbol (type, class, object)
static FoldType	NESTED Nested part; for example an embedded type, or nested namespace.
static FoldType	TAG Tag in markup languages
static FoldType	USER User-defined fold, recoded using a special comment

Constructor Summary

Constructors

Constructor and Description
FoldType(String description) Deprecated. Use the {link create} static method.

Method Summary

Modifier and Type	Method and Description
boolean	accepts(FoldType type) Deprecated. Use FoldType.isKindOf(org.netbeans.api.editor.fold.FoldType)
String	code() Persistable value of FoldType.
static FoldType	create(String code, String label, FoldTemplate template) Creates an instance of FoldType.
FoldType	derive(String code, String label, FoldTemplate template) Derives a FoldType which acts as a child of this instance.
String	getLabel() Provides human-readable label for the type
FoldTemplate	getTemplate() Provides FoldTemplate instance for this type.
boolean	isKindOf(FoldType other) Checks whether the fold can act as the 'other' type.
FoldType	override(String label, FoldTemplate template) Creates a FoldType, overriding its appearance.
FoldType	parent() Provides parent of this FoldType.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CODE_BLOCK

public static final FoldType CODE_BLOCK

A generic code block. Note that other categories are defined that represent method, class, member or nested symbol levels

Since:

1.35

DOCUMENTATION

public static final FoldType DOCUMENTATION

Documentation comment, as defined by the language

Since:

1.35

COMMENT

public static final FoldType COMMENT

Unspecified type of comment

Since:

1.35

INITIAL_COMMENT

public static final FoldType INITIAL_COMMENT

Initial file-level comment. Either documentation comment or comment containing copyright. Defaults to 'comment'

Since:

1.35

TAG

public static final FoldType TAG

Tag in markup languages

Since:

1.35

NESTED

public static final FoldType NESTED

Nested part; for example an embedded type, or nested namespace. Do not use this category for top-level symbols. This type is different from a 'member', as type may have many member types, nested types form worlds of their own

Since:

1.35

MEMBER

public static final FoldType MEMBER

Member of a symbol (type, class, object)

Since:

1.35

IMPORT

public static final FoldType IMPORT

Various import, includes and references to sibling files.

Since:

1.35

USER

public static final FoldType USER

User-defined fold, recoded using a special comment

Since:

1.35

Constructor Detail

FoldType

@Deprecated
public FoldType(String description)

Deprecated. Use the {link create} static method.

Construct fold type with the given description.

Parameters:

description - textual description of the fold type. Two fold types with the same description are not equal.

Method Detail

create

public static FoldType create(String code,
                              String label,
                              FoldTemplate template)

Creates an instance of FoldType. The code, label and template parameters will be assigned to the FoldType's properties.

Parameters:

code - code used to form, e.g. persistent keys for info related to the FoldType. Cannot be null.

label - human-readable label that identifies the FoldType. Must not be null.

template - describes how the fold is presented. If null, FoldTemplate.DEFAULT will be used.

Returns:

FoldType instance

Since:

1.35

override

public FoldType override(String label,
                         FoldTemplate template)

Creates a FoldType, overriding its appearance. The new FoldType will use the same code, but label and/or template can be changed.

Parameters:

label - human-readable label that describes the FoldType. If null, the original label will be used.

template - human-readable label that describes the FoldType. If null, the original template will be used.

Returns:

an instance of FoldType initialized according to parameters

Since:

1.35

derive

public FoldType derive(String code,
                       String label,
                       FoldTemplate template)

Derives a FoldType which acts as a child of this instance. The FoldType will be treated as a special case of this instance. If A is the returned instance and B is this instance, then A.isKindOf(B) will return true.

Parameters:

code - new code for the FoldType

label - human-readable label that describes the FoldType. If null, the original label will be used.

template - human-readable label that describes the FoldType. If null, the original template will be used.

Returns:

an instance of child FoldType

Since:

1.35

accepts

@Deprecated
public boolean accepts(FoldType type)

Deprecated. Use FoldType.isKindOf(org.netbeans.api.editor.fold.FoldType)

Parameters:

type -

Returns:

toString

public String toString()

Overrides:

toString in class Object

getLabel

public String getLabel()

Provides human-readable label for the type

Returns:

Since:

1.35

getTemplate

public FoldTemplate getTemplate()

Provides FoldTemplate instance for this type. The FoldTemplate is the default template used when creating a Fold. Specific FoldTemplate may be provided when creating the Fold instance.

Returns:

fold template for the type.

Since:

1.35

isKindOf

public boolean isKindOf(FoldType other)

Checks whether the fold can act as the 'other' type. This check respect parent relationship (see FoldType.parent). The method returns true, if semantics, operations, settings,... applicable to 'other' could be also applied on this FoldType.

Parameters:

other - the type to check

Returns:

true, if this FoldType should be affected

Since:

1.35

parent

public FoldType parent()

Provides parent of this FoldType. Returns null, if no parent is defined. The parent is a FoldType, which is more general and could be used as a fallback when no information is provided/available on this FoldType instance.

Returns:

parent instance or null

Since:

1.35

code

public String code()

Persistable value of FoldType. Use FoldType.Domain.valueOf(java.lang.String) to convert the value back to FoldType instance. The value can (and is) used to compose preference setting keys.

Returns:

value of FoldType.

Since:

1.35