Last change
on this file since 25584 was 25584, checked in by davidb, 12 years ago |
Initial cut an a text edit area for GLI that supports color syntax highlighting
|
File size:
1.2 KB
|
Rev | Line | |
---|
[25584] | 1 | /*
|
---|
| 2 | * 10/08/2011
|
---|
| 3 | *
|
---|
| 4 | * FoldParser.java - Locates folds in an RSyntaxTextArea instance.
|
---|
| 5 | *
|
---|
| 6 | * This library is distributed under a modified BSD license. See the included
|
---|
| 7 | * RSyntaxTextArea.License.txt file for details.
|
---|
| 8 | */
|
---|
| 9 | package org.fife.ui.rsyntaxtextarea.folding;
|
---|
| 10 |
|
---|
| 11 | import java.util.List;
|
---|
| 12 |
|
---|
| 13 | import org.fife.ui.rsyntaxtextarea.RSyntaxTextArea;
|
---|
| 14 |
|
---|
| 15 |
|
---|
| 16 | /**
|
---|
| 17 | * Locates folds in a document. If you are implementing a language that has
|
---|
| 18 | * sections of source code that can be logically "folded," you can create an
|
---|
| 19 | * instance of this interface that locates those regions and represents them
|
---|
| 20 | * as {@link Fold}s. <code>RSyntaxTextArea</code> knows how to take it from
|
---|
| 21 | * there and implement code folding in the editor.
|
---|
| 22 | *
|
---|
| 23 | * @author Robert Futrell
|
---|
| 24 | * @version 1.0
|
---|
| 25 | * @see CurlyFoldParser
|
---|
| 26 | * @see XmlFoldParser
|
---|
| 27 | */
|
---|
| 28 | public interface FoldParser {
|
---|
| 29 |
|
---|
| 30 |
|
---|
| 31 | /**
|
---|
| 32 | * Returns a list of all folds in the text area.
|
---|
| 33 | *
|
---|
| 34 | * @param textArea The text area whose contents should be analyzed.
|
---|
| 35 | * @return The list of folds. If this method returns <code>null</code>,
|
---|
| 36 | * it is treated as if no folds were found.
|
---|
| 37 | */
|
---|
| 38 | public List getFolds(RSyntaxTextArea textArea);
|
---|
| 39 |
|
---|
| 40 |
|
---|
| 41 | } |
---|
Note:
See
TracBrowser
for help on using the repository browser.