Package com.intellij.ide.structureView.impl

Class StructureViewFactoryImpl

java.lang.Object

com.intellij.ide.structureView.StructureViewFactory

com.intellij.ide.structureView.StructureViewFactoryEx

com.intellij.ide.structureView.impl.StructureViewFactoryImpl

All Implemented Interfaces:

PersistentStateComponent<StructureViewFactoryImpl.State>

public final class StructureViewFactoryImpl
extends StructureViewFactoryEx
implements PersistentStateComponent<StructureViewFactoryImpl.State>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StructureViewFactoryImpl.State

Constructor Summary

Constructors

Constructor and Description
StructureViewFactoryImpl(Project project)

Method Summary

Modifier and Type	Method and Description
void	cleanupForNextTest()
java.util.Collection<java.lang.String>	collectActiveActions()
StructureView	createStructureView(FileEditor fileEditor, StructureViewModel treeModel, Project project) Creates a structure view component instance for the specified editor.
StructureView	createStructureView(FileEditor fileEditor, StructureViewModel treeModel, Project project, boolean showRootNode) Creates a structure view component instance for the specified editor.
java.util.Collection<StructureViewExtension>	getAllExtensions(java.lang.Class<? extends PsiElement> type)
StructureViewFactoryImpl.State	getState()
StructureViewWrapper	getStructureViewWrapper()
void	initToolWindow(ToolWindowEx toolWindow)
boolean	isActionActive(java.lang.String name)
void	loadState(StructureViewFactoryImpl.State state) This method is called when new component state is loaded.
void	runWhenInitialized(java.lang.Runnable runnable)
void	setActiveAction(java.lang.String name, boolean state)

Methods inherited from class com.intellij.ide.structureView.StructureViewFactoryEx

getInstanceEx

Methods inherited from class com.intellij.ide.structureView.StructureViewFactory

getInstance

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.components.PersistentStateComponent

initializeComponent, noStateLoaded

Constructor Detail

StructureViewFactoryImpl

public StructureViewFactoryImpl(Project project)

Method Detail

getStructureViewWrapper

public StructureViewWrapper getStructureViewWrapper()

Specified by:

getStructureViewWrapper in class StructureViewFactoryEx

getState

public StructureViewFactoryImpl.State getState()

Specified by:

getState in interface PersistentStateComponent<StructureViewFactoryImpl.State>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

loadState

public void loadState(StructureViewFactoryImpl.State state)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<StructureViewFactoryImpl.State>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

initToolWindow

public void initToolWindow(ToolWindowEx toolWindow)

getAllExtensions

public java.util.Collection<StructureViewExtension> getAllExtensions(java.lang.Class<? extends PsiElement> type)

Specified by:

getAllExtensions in class StructureViewFactoryEx

setActiveAction

public void setActiveAction(java.lang.String name,
                            boolean state)

Specified by:

setActiveAction in class StructureViewFactoryEx

collectActiveActions

public java.util.Collection<java.lang.String> collectActiveActions()

isActionActive

public boolean isActionActive(java.lang.String name)

Specified by:

isActionActive in class StructureViewFactoryEx

runWhenInitialized

public void runWhenInitialized(java.lang.Runnable runnable)

Specified by:

runWhenInitialized in class StructureViewFactoryEx

createStructureView

public StructureView createStructureView(FileEditor fileEditor,
                                         StructureViewModel treeModel,
                                         Project project)

Description copied from class: StructureViewFactory

Creates a structure view component instance for the specified editor.

Specified by:

createStructureView in class StructureViewFactory

Parameters:

fileEditor - the editor to which the structure view is linked.

treeModel - the model defining the data shown in the structure view.

project - the project containing the file for which the structure view is requested.

Returns:

the structure view instance.

createStructureView

public StructureView createStructureView(FileEditor fileEditor,
                                         StructureViewModel treeModel,
                                         Project project,
                                         boolean showRootNode)

Description copied from class: StructureViewFactory

Creates a structure view component instance for the specified editor.

Specified by:

createStructureView in class StructureViewFactory

Parameters:

fileEditor - the editor to which the structure view is linked.

treeModel - the model defining the data shown in the structure view.

project - the project containing the file for which the structure view is requested.

showRootNode - pass false if root node of the structure built should not actually be shown in result tree.

Returns:

the structure view instance.

cleanupForNextTest

public void cleanupForNextTest()