Package com.intellij.ide.structureView.impl

Class StructureViewComposite

java.lang.Object

com.intellij.ide.structureView.impl.StructureViewComposite

All Implemented Interfaces:

StructureView, Disposable

public class StructureViewComposite
extends java.lang.Object
implements StructureView

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StructureViewComposite.StructureViewDescriptor

Nested classes/interfaces inherited from interface com.intellij.ide.structureView.StructureView

StructureView.Scrollable

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

Disposable.Parent

Constructor Summary

Constructors

Constructor and Description
StructureViewComposite(StructureViewComposite.StructureViewDescriptor... views)

Method Summary

Modifier and Type	Method and Description
void	centerSelectedRow()
void	disableStoreState()
void	dispose() Usually not invoked directly, see class javadoc.
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.
StructureView	getSelectedStructureView()
StructureViewComposite.StructureViewDescriptor []	getStructureViews()
StructureViewModel	getTreeModel()
boolean	isOutdated()
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StructureViewComposite

public StructureViewComposite(StructureViewComposite.StructureViewDescriptor... views)

Method Detail

isOutdated

public boolean isOutdated()

getSelectedStructureView

public StructureView getSelectedStructureView()

getFileEditor

public FileEditor getFileEditor()

Description copied from interface: StructureView

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

Specified by:

getFileEditor in interface StructureView

Returns:

the editor linked to the structure view.

navigateToSelectedElement

public boolean navigateToSelectedElement(boolean requestFocus)

Description copied from interface: StructureView

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

Specified by:

navigateToSelectedElement in interface StructureView

Parameters:

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

getComponent

public javax.swing.JComponent getComponent()

Description copied from interface: StructureView

Returns the Swing component representing the structure view.

Specified by:

getComponent in interface StructureView

Returns:

the structure view component.

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

centerSelectedRow

public void centerSelectedRow()

Specified by:

centerSelectedRow in interface StructureView

restoreState

public void restoreState()

Description copied from interface: StructureView

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.

Specified by:

restoreState in interface StructureView

See Also:

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

storeState

public void storeState()

Description copied from interface: StructureView

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.

Specified by:

storeState in interface StructureView

See Also:

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

disableStoreState

public void disableStoreState()

Specified by:

disableStoreState in interface StructureView

getStructureViews

public StructureViewComposite.StructureViewDescriptor [] getStructureViews()

getTreeModel

public StructureViewModel getTreeModel()

Specified by:

getTreeModel in interface StructureView