org.jboss.forge.addon.ui.context

Interface UIRegion<SELECTIONTYPE>

public interface UIRegion<SELECTIONTYPE>

Provides location information about an element in the source file

Author:

George Gastaldi

Method Summary

Modifier and Type	Method and Description
int	getEndLine() Returns the number of the line containing the last character of the selected text.
int	getEndPosition() Returns the character index into the original source file indicating where the source fragment corresponding to this element ends.
SELECTIONTYPE	getResource() Returns the selected resource that this UIRegion belongs to.
int	getStartLine() Returns number of the line containing the offset of the selected text.
int	getStartPosition() Returns the character index into the original source file indicating where the source fragment corresponding to this element begins.
Optional<String>	getText() Returns the selected text.

Method Detail

getStartPosition

int getStartPosition()

Returns the character index into the original source file indicating where the source fragment corresponding to this element begins.

Returns:

the 0-based character index, or -1 if no source position information is recorded for this element

getEndPosition

int getEndPosition()

Returns the character index into the original source file indicating where the source fragment corresponding to this element ends.

Returns:

the 0-based character index, or -1 if no source position information is recorded for this element

getStartLine

int getStartLine()

Returns number of the line containing the offset of the selected text. If the underlying text has been changed between the creation of this selection object and the call of this method, the value returned might differ from what it would have been at the point of creation.

Returns:

the start line of this selection or -1 if there is no valid line information

getEndLine

int getEndLine()

Returns the number of the line containing the last character of the selected text. If the underlying text has been changed between the creation of this selection object and the call of this method, the value returned might differ from what it would have been at the point of creation.

Returns:

the end line of this selection or -1 if there is no valid line information

getText

Optional<String> getText()

Returns the selected text. If the underlying text has been changed between the creation of this selection object and the call of this method, the value returned might differ from what it would have been at the point of creation.

Returns:

an Optional containing the selected text. May be empty if there is no valid text information

getResource

SELECTIONTYPE getResource()

Returns the selected resource that this UIRegion belongs to.

Returns:

the resource that this UIRegion belongs to.