Package com.intellij.ide.structureView.newStructureView

Class StructureViewComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.intellij.ui.components.JBPanel<JBPanelWithEmptyText>

com.intellij.ui.components.JBPanelWithEmptyText

com.intellij.openapi.ui.SimpleToolWindowPanel

com.intellij.ide.structureView.newStructureView.StructureViewComponent

All Implemented Interfaces:

TreeActionsOwner, StructureView, StructureView.Scrollable, DataProvider, Disposable, QuickActionProvider, JBComponent<JBPanelWithEmptyText>, ComponentWithEmptyText, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

PropertiesGroupingStructureViewComponent

public class StructureViewComponent
extends SimpleToolWindowPanel
implements TreeActionsOwner, DataProvider, StructureView.Scrollable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

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

Field Summary

Fields inherited from class com.intellij.openapi.ui.SimpleToolWindowPanel

myVertical

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.intellij.ui.switcher.QuickActionProvider

KEY

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
StructureViewComponent(FileEditor editor, StructureViewModel structureViewModel, Project project, boolean showRootNode)

Method Summary

Modifier and Type	Method and Description
protected void	addGroupByActions(DefaultActionGroup result)
void	centerSelectedRow()
static void	clearStructureViewState(Project project)
protected ActionGroup	createActionGroup()
static TreeElementWrapper	createWrapper(Project project, TreeElement value, TreeModel treeModel)
void	disableStoreState()
void	dispose() Usually not invoked directly, see class javadoc.
Promise<AbstractTreeNode<?>>	expandPathToElement(java.lang.Object element)
java.awt.Dimension	getCurrentSize()
java.lang.Object	getData(java.lang.String dataId) Returns the object corresponding to the specified data identifier.
FileEditor	getFileEditor() Returns the editor whose structure is displayed in the structure view.
java.lang.String	getHelpID()
Project	getProject()
static JBIterable<java.lang.Object>	getSelectedValues(javax.swing.JTree tree)
javax.swing.JTree	getTree()
StructureViewModel	getTreeModel()
boolean	isActionActive(java.lang.String name)
boolean	isDisposed()
boolean	navigateToSelectedElement(boolean requestFocus) Selects the element which corresponds to the current cursor position in the editor linked to the structure view.
void	queueUpdate()
void	rebuild()
<any>	rebuildAndUpdate()
static void	registerAutoExpandListener(javax.swing.JTree tree, StructureViewModel structureViewModel)
static void	registerPsiListener(Project project, Disposable disposable, java.lang.Runnable onChange)
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.
Promise<javax.swing.tree.TreePath>	select(java.lang.Object element, boolean requestFocus)
void	setActionActive(java.lang.String name, boolean state)
void	setReferenceSizeWhileInitializing(java.awt.Dimension size)
protected boolean	showScrollToFromSourceActions()
void	showToolbar()
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.
static java.lang.Object	unwrapNavigatable(java.lang.Object o)
static java.lang.Object	unwrapValue(java.lang.Object o)
static java.lang.Object	unwrapWrapper(java.lang.Object o)

Methods inherited from class com.intellij.openapi.ui.SimpleToolWindowPanel

getActions, getComponent, getContent, getToolbar, isToolbarVisible, isVertical, paintComponent, setContent, setProvideQuickActions, setToolbar, setVertical

Methods inherited from class com.intellij.ui.components.JBPanelWithEmptyText

getComponentGraphics, getEmptyText, withEmptyText

Methods inherited from class com.intellij.ui.components.JBPanel

andOpaque, andTransparent, getMaximumSize, getMinimumSize, getPreferredSize, withBackground, withBorder, withFont, withMaximumHeight, withMaximumWidth, withMinimumHeight, withMinimumWidth, withPreferredHeight, withPreferredSize, withPreferredWidth

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.ide.structureView.StructureView

getComponent

Methods inherited from interface com.intellij.ui.switcher.QuickActionProvider

getName, isCycleRoot

Constructor Detail

StructureViewComponent

public StructureViewComponent(FileEditor editor,
                              StructureViewModel structureViewModel,
                              Project project,
                              boolean showRootNode)

Method Detail

registerAutoExpandListener

public static void registerAutoExpandListener(javax.swing.JTree tree,
                                              StructureViewModel structureViewModel)

showScrollToFromSourceActions

protected boolean showScrollToFromSourceActions()

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.

showToolbar

public void showToolbar()

registerPsiListener

public static void registerPsiListener(Project project,
                                       Disposable disposable,
                                       java.lang.Runnable onChange)

getProject

public Project getProject()

getTree

public javax.swing.JTree getTree()

queueUpdate

public void queueUpdate()

rebuild

public void rebuild()

getSelectedValues

public static JBIterable<java.lang.Object> getSelectedValues(javax.swing.JTree tree)

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

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)

createActionGroup

protected ActionGroup createActionGroup()

addGroupByActions

protected void addGroupByActions(DefaultActionGroup result)

expandPathToElement

public Promise<AbstractTreeNode<?>> expandPathToElement(java.lang.Object element)

select

public Promise<javax.swing.tree.TreePath> select(java.lang.Object element,
                                                 boolean requestFocus)

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

isDisposed

public boolean isDisposed()

centerSelectedRow

public void centerSelectedRow()

Specified by:

centerSelectedRow in interface StructureView

setActionActive

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

Specified by:

setActionActive in interface TreeActionsOwner

isActionActive

public boolean isActionActive(java.lang.String name)

Specified by:

isActionActive in interface TreeActionsOwner

clearStructureViewState

public static void clearStructureViewState(Project project)

getData

public java.lang.Object getData(java.lang.String dataId)

Description copied from interface: DataProvider

Returns the object corresponding to the specified data identifier. Some of the supported data identifiers are defined in the PlatformDataKeys class.

Specified by:

getData in interface DataProvider

Overrides:

getData in class SimpleToolWindowPanel

Parameters:

dataId - the data identifier for which the value is requested.

Returns:

the value, or null if no value is available in the current context for this identifier.

getTreeModel

public StructureViewModel getTreeModel()

Specified by:

getTreeModel in interface StructureView

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.

rebuildAndUpdate

public <any> rebuildAndUpdate()

getHelpID

public java.lang.String getHelpID()

getCurrentSize

public java.awt.Dimension getCurrentSize()

Specified by:

getCurrentSize in interface StructureView.Scrollable

setReferenceSizeWhileInitializing

public void setReferenceSizeWhileInitializing(java.awt.Dimension size)

Specified by:

setReferenceSizeWhileInitializing in interface StructureView.Scrollable

unwrapValue

public static java.lang.Object unwrapValue(java.lang.Object o)

unwrapNavigatable

public static java.lang.Object unwrapNavigatable(java.lang.Object o)

unwrapWrapper

public static java.lang.Object unwrapWrapper(java.lang.Object o)

createWrapper

public static TreeElementWrapper createWrapper(Project project,
                                               TreeElement value,
                                               TreeModel treeModel)