Package com.intellij.ide.structureView

Interface StructureView

All Superinterfaces:

Disposable

All Known Subinterfaces:

StructureView.Scrollable

All Known Implementing Classes:

PropertiesFileStructureViewComponent, PropertiesGroupingStructureViewComponent, ResourceBundleStructureViewComponent, StructureViewComponent, StructureViewComposite

public interface StructureView
extends Disposable

Defines the implementation of a custom structure view or file structure popup component. The structure view is linked to a file editor and displays the structure of the file contained in that editor.

See Also:

StructureViewBuilder.createStructureView(com.intellij.openapi.fileEditor.FileEditor, com.intellij.openapi.project.Project), TreeBasedStructureViewBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StructureView.Scrollable

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Method Summary

Modifier and Type	Method and Description
void	centerSelectedRow()
default void	disableStoreState()
javax.swing.JComponent	getComponent() Returns the Swing component representing the structure view.
FileEditor	getFileEditor() Returns the editor whose structure is displayed in the structure view.
StructureViewModel	getTreeModel()
boolean	navigateToSelectedElement(boolean requestFocus) Selects the element which corresponds to the current cursor position in the editor linked to the structure view.
void	restoreState() Restores the state of the structure view (the expanded and selected elements) from the user data of the file editor to which it is linked.
void	storeState() Stores the state of the structure view (the expanded and selected elements) in the user data of the file editor to which it is linked.

Methods inherited from interface com.intellij.openapi.Disposable

dispose

Method Detail

getFileEditor

FileEditor getFileEditor()

Returns the editor whose structure is displayed in the structure view.

Returns:

the editor linked to the structure view.

navigateToSelectedElement

boolean navigateToSelectedElement(boolean requestFocus)

Selects the element which corresponds to the current cursor position in the editor linked to the structure view.

Parameters:

requestFocus - if true, the structure view component also grabs the focus.

getComponent

javax.swing.JComponent getComponent()

Returns the Swing component representing the structure view.

Returns:

the structure view component.

centerSelectedRow

void centerSelectedRow()

restoreState

void restoreState()

Restores the state of the structure view (the expanded and selected elements) from the user data of the file editor to which it is linked.

See Also:

UserDataHolder.getUserData(com.intellij.openapi.util.Key)

storeState

void storeState()

Stores the state of the structure view (the expanded and selected elements) in the user data of the file editor to which it is linked.

See Also:

UserDataHolder.putUserData(com.intellij.openapi.util.Key, Object)

disableStoreState

default void disableStoreState()

getTreeModel

StructureViewModel getTreeModel()