- Direct Known Subclasses:
public class DefaultDamagerRepairer extends Object implements IPresentationDamager, IPresentationRepairer
A standard implementation of a syntax driven presentation damager and presentation repairer. It uses a token scanner to scan the document and to determine its damage and new text presentation. The tokens returned by the scanner are supposed to return text attributes as their data.
- See Also:
Method SummaryModifier and TypeMethodDescription
protected voidAdds style information to the given text presentation.
voidFills the given presentation with the style ranges which when applied to the presentation reconciler's text viewer repair the presentation damage described by the given region.
(int offset)Returns the end offset of the line that contains the specified offset or if the offset is inside a line delimiter, the end offset of the next line.Returns the damage in the document's presentation caused by the given document change.
protected TextAttributeReturns a text attribute encoded in the given token.
voidTells the presentation damager on which document it will work.
DefaultDamagerRepairer@Deprecated public DefaultDamagerRepairer
(ITokenScanner scanner, TextAttribute defaultTextAttribute)Deprecated.use DefaultDamagerRepairer(ITokenScanner) insteadCreates a damager/repairer that uses the given scanner and returns the given default text attribute if the current token does not carry a text attribute.
scanner- the token scanner to be used
defaultTextAttribute- the text attribute to be returned if non is specified by the current token, may not be
(ITokenScanner scanner)Creates a damager/repairer that uses the given scanner. The scanner may not be
nulland is assumed to return only token that carry text attributes.
scanner- the token scanner to be used, may not be
setDocumentpublic void setDocument
(IDocument document)Description copied from interface:
IPresentationDamagerTells the presentation damager on which document it will work.
endOfLineOfprotected int endOfLineOf
(int offset) throws BadLocationExceptionReturns the end offset of the line that contains the specified offset or if the offset is inside a line delimiter, the end offset of the next line.
offset- the offset whose line end offset must be computed
- the line end offset for the given offset
BadLocationException- if offset is invalid in the current document
getDamageRegionpublic IRegion getDamageRegion
(ITypedRegion partition, DocumentEvent e, boolean documentPartitioningChanged)Returns the damage in the document's presentation caused by the given document change. The damage is restricted to the specified partition for which the presentation damager is responsible. The damage may also depend on whether the document change also caused changes of the document's partitioning.
This implementation damages entire lines unless clipped by the given partition.
- Specified by:
partition- the partition inside which the damage must be determined
e- the event describing the change whose damage must be determined
documentPartitioningChanged- indicates whether the given change changed the document's partitioning
- the full lines containing the document changes described by the document event, clipped by the given partition. If there was a partitioning change then the whole partition is returned.
createPresentationDescription copied from interface:
IPresentationRepairerFills the given presentation with the style ranges which when applied to the presentation reconciler's text viewer repair the presentation damage described by the given region.
getTokenTextAttributeReturns a text attribute encoded in the given token. If the token's data is not
nulland a text attribute it is assumed that it is the encoded text attribute. It returns the default text attribute if there is no encoded text attribute found.
token- the token whose text attribute is to be determined
- the token's text attribute
addRangeAdds style information to the given text presentation.
presentation- the text presentation to be extended
offset- the offset of the range to be styled
length- the length of the range to be styled
attr- the attribute describing the style of the range to be styled