StructureElement (LSP APIs)

java.lang.Object
- org.netbeans.api.lsp.StructureElement

```
public final class StructureElement
extends Object
```
StructureElement is a tree item that shows the structure of the source code.

Since:

1.8

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`StructureElement.Kind` Kind of the structure element.
`static class`	`StructureElement.Tag` Tags are extra annotations that tweak the rendering of a symbol.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<StructureElement>`	`getChildren()` Children of this element, e.g.
`String`	`getDetail()` More detail for this symbol, e.g the signature of a function.
`int`	`getExpandedEndOffset()` The expanded range is offset range that is typically used to determine if the cursors inside the element to reveal in the element in the UI.
`Range`	`getExpandedRange()` The expanded range is offset range that is typically used to determine if the cursors inside the element to reveal in the element in the UI.
`int`	`getExpandedStartOffset()` The expanded range is offset range that is typically used to determine if the cursors inside the element to reveal in the element in the UI.
`FileObject`	`getFile()` File which contains this element.
`StructureElement.Kind`	`getKind()` Kind of this structure element.
`String`	`getName()` The name is displayed in the structure tree and other ui.
`int`	`getSelectionEndOffset()` The end of offset range where this element should be selected and revealed in document when selected.
`Range`	`getSelectionRange()` The selection range marks part of document that should be revealed and selected for an element.
`int`	`getSelectionStartOffset()` The start of offset range where this element should be selected and revealed in document when selected in outline view.
`Set<StructureElement.Tag>`	`getTags()` Tags for this element.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getName
```
@NonNull
public String getName()
```
    The name is displayed in the structure tree and other ui.
    
    Returns:
    
    The name of this element.
  - getSelectionStartOffset
```
public int getSelectionStartOffset()
```
    The start of offset range where this element should be selected and revealed in document when selected in outline view.
    
    Returns:
    
    start offset of the selection
  - getSelectionEndOffset
```
public int getSelectionEndOffset()
```
    The end of offset range where this element should be selected and revealed in document when selected.
    
    Returns:
    
    end offset of the selection
  - getExpandedStartOffset
```
public int getExpandedStartOffset()
```
    The expanded range is offset range that is typically used to determine if the cursors inside the element to reveal in the element in the UI.
    
    Returns:
    
    start of the enclosed range
  - getExpandedEndOffset
```
public int getExpandedEndOffset()
```
    The expanded range is offset range that is typically used to determine if the cursors inside the element to reveal in the element in the UI.
    
    Returns:
    
    end of the enclosed range
  - getSelectionRange
```
public Range getSelectionRange()
```
    The selection range marks part of document that should be revealed and selected for an element.
    
    Returns:
    
    start offset of the selection
    
    Since:
    
    1.9
  - getExpandedRange
```
public Range getExpandedRange()
```
    The expanded range is offset range that is typically used to determine if the cursors inside the element to reveal in the element in the UI.
    
    Returns:
    
    expanded range.
    
    Since:
    
    1.9
  - getKind
```
public StructureElement.Kind getKind()
```
    Kind of this structure element.
    
    Returns:
    
    Kind of this symbol
  - getTags
```
public Set<StructureElement.Tag> getTags()
```
    Tags for this element.
    
    Returns:
    
    list of tags
  - getDetail
```
public String getDetail()
```
    More detail for this symbol, e.g the signature of a function. If not provided only the name is used.
    
    Returns:
    
    the detail text for this element
  - getChildren
```
public List<StructureElement> getChildren()
```
    Children of this element, e.g. method and fields of a class.
    
    Returns:
    
    list of sub elements.
  - getFile
```
@CheckForNull
public FileObject getFile()
```
    File which contains this element. If null, the file may be inaccessible; in that case, offsets will be also set to -1.
    
    Returns:
    
    owning file, or null
    
    Since:
    
    1.9

Class StructureElement

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getSelectionStartOffset

getSelectionEndOffset

getExpandedStartOffset

getExpandedEndOffset

getSelectionRange

getExpandedRange

getKind

getTags

getDetail

getChildren

getFile