Package com.intellij.ui

Class FinderRecursivePanel<T>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.intellij.openapi.ui.Splitter

com.intellij.ui.JBSplitter

com.intellij.ui.OnePixelSplitter

com.intellij.ui.FinderRecursivePanel<T>

Type Parameters:

T - List item type. Must implement equals()/hashCode() correctly.

All Implemented Interfaces:

DataProvider, Disposable, Splittable, UserDataHolder, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public abstract class FinderRecursivePanel<T>
extends OnePixelSplitter
implements DataProvider, UserDataHolder, Disposable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	FinderRecursivePanel.DisposablePanel FinderRecursivePanel disposes right component on selection change if it is disposable.

Nested classes/interfaces inherited from class com.intellij.openapi.ui.Splitter

Splitter.DividerImpl, Splitter.DividerPositionStrategy, Splitter.LackOfSpaceStrategy

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.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
protected JBList<T>	myList
protected CollectionListModel<T>	myListModel

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

myDivider, myProportion, PROP_ORIENTATION, PROP_PROPORTION

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FinderRecursivePanel(FinderRecursivePanel<?> parent)
protected	FinderRecursivePanel(Project project, FinderRecursivePanel<?> parent, java.lang.String groupId)
protected	FinderRecursivePanel(Project project, java.lang.String groupId)

Method Summary

Modifier and Type	Method and Description
protected javax.swing.JComponent	createDefaultRightComponent()
protected javax.swing.JComponent	createLeftComponent()
protected JBList<T>	createList()
protected javax.swing.ListCellRenderer<T>	createListCellRenderer()
protected javax.swing.JComponent	createRightComponent(T t)
void	dispose() Usually not invoked directly, see class javadoc.
protected void	doCustomizeCellRenderer(SimpleColoredComponent comp, javax.swing.JList list, T value, int index, boolean selected, boolean hasFocus)
void	doLayout()
protected VirtualFile	getContainingFile(T t) To determine item list background color (if enabled).
protected AnAction[]	getCustomListActions()
java.lang.Object	getData(java.lang.String dataId) Returns the object corresponding to the specified data identifier.
protected int	getFirstComponentPreferredSize()
protected java.lang.String	getGroupId()
protected javax.swing.Icon	getItemIcon(T t)
protected abstract java.lang.String	getItemText(T t)
protected java.lang.String	getItemTooltipText(T t) Returns tooltip text for the given list item or null if no tooltip is available.
protected java.lang.String	getListEmptyText()
protected abstract java.util.List<T>	getListItems() Called in read action.
FinderRecursivePanel<?>	getParentPanel()
Project	getProject()
T	getSelectedValue()
<U> U	getUserData(Key<U> key)
protected abstract boolean	hasChildren(T t)
protected boolean	hasFixedSizeListElements() Whether this list contains "fixed size" elements.
void	initPanel()
protected boolean	isDisposed()
protected boolean	isEditable()
boolean	isMergeListItemsRunning()
protected boolean	isNonBlockingLoad()
protected boolean	isRootPanel()
protected void	mergeListItems(CollectionListModel<T> listModel, javax.swing.JList<? extends T> list, java.util.List<? extends T> newItems)
protected boolean	performEditAction()
<U> void	putUserData(Key<U> key, U value) Add a new user data value to this object.
protected void	setMergeListItemsRunning(boolean isListMergeRunning)
protected void	setNonBlockingLoad(boolean nonBlockingLoad)
void	updatePanel()
void	updateRightComponent(boolean force)
void	updateSelectedPath(java.lang.Object... pathToSelect) Performs recursive update selecting given values.

Methods inherited from class com.intellij.ui.OnePixelSplitter

createDivider, getBlindZone, init, setBlindZone

Methods inherited from class com.intellij.ui.JBSplitter

addNotify, getSplitterProportionKey, loadProportion, saveProportion, setAndLoadSplitterProportionKey, setProportion, setSplitterProportionKey

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

add, asComponent, getDivider, getDividerPositionStrategy, getDividerWidth, getFirstComponent, getLackOfSpaceStrategy, getMinimumSize, getMinProportion, getOrientation, getOtherComponent, getPreferredSize, getProportion, getProportionForFirstSize, getProportionForSecondSize, getSecondComponent, isHonorMinimumSize, isShowDividerControls, isShowDividerIcon, isVertical, isVisible, reshape, setAllowSwitchOrientationByMouseClick, setDividerPositionStrategy, setDividerWidth, setDragging, setFirstComponent, setHonorComponentsMinimumSize, setLackOfSpaceStrategy, setOrientation, setResizeEnabled, setSecondComponent, setShowDividerControls, setShowDividerIcon, skipNextLayout, swapComponents

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, 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, paintComponent, 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, 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, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, 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, 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

Field Detail

myList

protected JBList<T> myList

myListModel

protected final CollectionListModel<T> myListModel

Constructor Detail

FinderRecursivePanel

protected FinderRecursivePanel(FinderRecursivePanel<?> parent)

FinderRecursivePanel

protected FinderRecursivePanel(Project project,
                               java.lang.String groupId)

FinderRecursivePanel

protected FinderRecursivePanel(Project project,
                               FinderRecursivePanel<?> parent,
                               java.lang.String groupId)

Method Detail

isNonBlockingLoad

protected boolean isNonBlockingLoad()

setNonBlockingLoad

protected void setNonBlockingLoad(boolean nonBlockingLoad)

initPanel

public void initPanel()

getListItems

protected abstract java.util.List<T> getListItems()

Called in read action.

Returns:

Items for list.

getListEmptyText

protected java.lang.String getListEmptyText()

getItemText

protected abstract java.lang.String getItemText(T t)

getItemIcon

protected javax.swing.Icon getItemIcon(T t)

getItemTooltipText

protected java.lang.String getItemTooltipText(T t)

Returns tooltip text for the given list item or null if no tooltip is available.

This method is invoked by panel's list cell render in order to set a tooltip text for the list cell render component. It is invoked before doCustomizeCellRenderer(SimpleColoredComponent, JList, Object, int, boolean, boolean), thus the tooltip may still be reset in doCustomizeCellRenderer.

Parameters:

t - the list item

Returns:

the text to display in a tooltip for the given list item

hasChildren

protected abstract boolean hasChildren(T t)

getContainingFile

protected VirtualFile getContainingFile(T t)

To determine item list background color (if enabled).

Parameters:

t - Current item.

Returns:

Containing file.

isEditable

protected boolean isEditable()

createRightComponent

protected javax.swing.JComponent createRightComponent(T t)

createDefaultRightComponent

protected javax.swing.JComponent createDefaultRightComponent()

createLeftComponent

protected javax.swing.JComponent createLeftComponent()

createList

protected JBList<T> createList()

getCustomListActions

protected AnAction[] getCustomListActions()

performEditAction

protected boolean performEditAction()

createListCellRenderer

protected javax.swing.ListCellRenderer<T> createListCellRenderer()

doCustomizeCellRenderer

protected void doCustomizeCellRenderer(SimpleColoredComponent comp,
                                       javax.swing.JList list,
                                       T value,
                                       int index,
                                       boolean selected,
                                       boolean hasFocus)

hasFixedSizeListElements

protected boolean hasFixedSizeListElements()

Whether this list contains "fixed size" elements.

Returns:

true.

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

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.

getUserData

public <U> U getUserData(Key<U> key)

Specified by:

getUserData in interface UserDataHolder

Returns:

a user data value associated with this object. Doesn't require read action.

putUserData

public <U> void putUserData(Key<U> key,
                            U value)

Description copied from interface: UserDataHolder

Add a new user data value to this object. Doesn't require write action.

Specified by:

putUserData in interface UserDataHolder

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

Overrides:

dispose in class Splitter

isDisposed

protected boolean isDisposed()

Returns:

true if already disposed.

getSelectedValue

public T getSelectedValue()

updateSelectedPath

public void updateSelectedPath(java.lang.Object... pathToSelect)

Performs recursive update selecting given values.

Parameters:

pathToSelect - Values to select.

getProject

public Project getProject()

getParentPanel

public FinderRecursivePanel<?> getParentPanel()

getGroupId

protected java.lang.String getGroupId()

updatePanel

public void updatePanel()

mergeListItems

protected void mergeListItems(CollectionListModel<T> listModel,
                              javax.swing.JList<? extends T> list,
                              java.util.List<? extends T> newItems)

isMergeListItemsRunning

public boolean isMergeListItemsRunning()

setMergeListItemsRunning

protected void setMergeListItemsRunning(boolean isListMergeRunning)

updateRightComponent

public void updateRightComponent(boolean force)

isRootPanel

protected boolean isRootPanel()

doLayout

public void doLayout()

Overrides:

doLayout in class Splitter

getFirstComponentPreferredSize

protected int getFirstComponentPreferredSize()