Eclipse Platform
2.0

org.eclipse.jface.text.rules
Class MultiLineRule

java.lang.Object
  |
  +--org.eclipse.jface.text.rules.PatternRule
        |
        +--org.eclipse.jface.text.rules.MultiLineRule
All Implemented Interfaces:
IPredicateRule, IRule

public class MultiLineRule
extends PatternRule

A rule for detecting patterns which begin with a given sequence and may end with a given sequence thereby spanning multiple lines.


Field Summary
 
Fields inherited from class org.eclipse.jface.text.rules.PatternRule
fBreaksOnEOL, fColumn, fEndSequence, fEscapeCharacter, fStartSequence, fToken, UNDEFINED
 
Constructor Summary
MultiLineRule(String startSequence, String endSequence, IToken token)
          Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
MultiLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter)
          Creates a rule for the given starting and ending sequence which, if detected, will return the specific token.
 
Methods inherited from class org.eclipse.jface.text.rules.PatternRule
doEvaluate, doEvaluate, endSequenceDetected, evaluate, evaluate, getSuccessToken, sequenceDetected, setColumnConstraint
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MultiLineRule

public MultiLineRule(String startSequence,
                     String endSequence,
                     IToken token)
Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.

Parameters:
startSequence - the pattern's start sequence
endSequence - the pattern's end sequence
token - the token to be returned on success

MultiLineRule

public MultiLineRule(String startSequence,
                     String endSequence,
                     IToken token,
                     char escapeCharacter)
Creates a rule for the given starting and ending sequence which, if detected, will return the specific token. Any character which follows the given escape character will be ignored.

Parameters:
startSequence - the pattern's start sequence
endSequence - the pattern's end sequence
token - the token to be returned on success
escapeCharacter - the escape character

Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.