Package org.eclipse.jface.text.rules
Provides a framework for rule based text scanning
and uses the framework to provide rule-driven default implementations of
IPresentationDamager
, IPresentationRepairer
and IDocumentPartitioner
.
Package Specification
RuleBasedScanner
is a document-based scanner controlled by IRule
objects. When evaluated an IRule
always returns an IToken
.
The package provides a set of rules whereby PatternRule
is the
most important one. PatternRule
defines a pattern-configurable
rule.-
Interface Summary Interface Description ICharacterScanner Defines the interface of a character scanner used by rules.IPartitionTokenScanner A partition token scanner returns tokens that represent partitions.IPredicateRule Defines the interface for a rule used in the scanning of text for the purpose of document partitioning or text styling.IRule Defines the interface for a rule used in the scanning of text for the purpose of document partitioning or text styling.IToken A token to be returned by a rule.ITokenScanner A token scanner scans a range of a document and reports about the token it finds.IWhitespaceDetector Defines the interface by whichWhitespaceRule
determines whether a given character is to be considered whitespace in the current context.IWordDetector Defines the interface by whichWordRule
determines whether a given character is valid as part of a word in the current context. -
Class Summary Class Description BufferedRuleBasedScanner A buffered rule based scanner.DefaultDamagerRepairer A standard implementation of a syntax driven presentation damager and presentation repairer.DefaultPartitioner Deprecated. As of 3.1, replaced byFastPartitioner
insteadEndOfLineRule A specific configuration of a single line rule whereby the pattern begins with a specific sequence but is only ended by a line delimiter.FastPartitioner A standard implementation of a document partitioner.MultiLineRule A rule for detecting patterns which begin with a given sequence and may end with a given sequence thereby spanning multiple lines.NumberRule An implementation ofIRule
detecting a numerical value.PatternRule Standard implementation ofIPredicateRule
.RuleBasedDamagerRepairer Deprecated. useDefaultDamagerRepairer
RuleBasedPartitioner Deprecated. useFastPartitioner
insteadRuleBasedPartitionScanner Scanner that exclusively uses predicate rules.RuleBasedScanner A generic scanner which can be "programmed" with a sequence of rules.SingleLineRule A specific configuration of pattern rule whereby the pattern begins with a specific sequence and may end with a specific sequence, but will not span more than a single line.Token Standard implementation ofIToken
.WhitespaceRule An implementation ofIRule
capable of detecting whitespace.WordPatternRule A specific single line rule which stipulates that the start and end sequence occur within a single word, as defined by a word detector.WordRule An implementation ofIRule
capable of detecting words.