oracle.javatools.editor.language

Interface OffsetDescriptionProvider

public interface OffsetDescriptionProvider

Provides a way for a language to provide a user displayable description of a location in a text buffer

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescription(TextBuffer buffer, int offset) Provide the user displayable name for the given location

Method Detail

getDescription

java.lang.String getDescription(TextBuffer buffer,
                              int offset)

Provide the user displayable name for the given location

Parameters:

buffer - the text buffer contining the code

offset - the offset at which to provide a description

Returns:

a user displayable name, or null if one could not be created.