public abstract class FoldHandler
extends java.lang.Object
Plugins can provide fold handlers by defining entries in their
services.xml
files like so:
<SERVICE CLASS="org.gjt.sp.jedit.buffer.FoldHandler" NAME="name"> new MyFoldHandler(); </SERVICE>See
ServiceManager
for details.Modifier and Type | Field and Description |
---|---|
static FoldHandlerProvider |
foldHandlerProvider
The FoldHandlerProvider.
|
Modifier | Constructor and Description |
---|---|
protected |
FoldHandler(java.lang.String name) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o)
Returns if the specified fold handler is equal to this one.
|
static FoldHandler |
getFoldHandler(java.lang.String name)
Returns the fold handler with the specified name, or null if
there is no registered handler with that name.
|
abstract int |
getFoldLevel(JEditBuffer buffer,
int lineIndex,
javax.swing.text.Segment seg)
Returns the fold level of the specified line.
|
static java.lang.String[] |
getFoldModes()
Returns an array containing the names of all registered fold
handlers.
|
java.lang.String |
getName()
Returns the internal name of this FoldHandler
|
java.util.List<java.lang.Integer> |
getPrecedingFoldLevels(JEditBuffer buffer,
int lineIndex,
javax.swing.text.Segment seg,
int lineFoldLevel)
Returns the fold levels of the lines preceding the specified line,
which depend on the specified line.
|
int |
hashCode() |
java.lang.String |
toString() |
public static FoldHandlerProvider foldHandlerProvider
public java.lang.String getName()
public abstract int getFoldLevel(JEditBuffer buffer, int lineIndex, javax.swing.text.Segment seg)
buffer
- The buffer in questionlineIndex
- The line indexseg
- A segment the fold handler can use to obtain any
text from the buffer, if necessarypublic java.util.List<java.lang.Integer> getPrecedingFoldLevels(JEditBuffer buffer, int lineIndex, javax.swing.text.Segment seg, int lineFoldLevel)
buffer
- The buffer in questionlineIndex
- The line indexseg
- A segment the fold handler can use to obtain anylineFoldLevel
- The fold level of the specified linepublic boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- The objectpublic int hashCode()
hashCode
in class java.lang.Object
public static FoldHandler getFoldHandler(java.lang.String name)
name
- The name of the desired fold handlerpublic static java.lang.String[] getFoldModes()
public java.lang.String toString()
toString
in class java.lang.Object