Package com.intellij.ide.navigationToolbar

Class NavBarPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.intellij.ide.navigationToolbar.NavBarPanel

All Implemented Interfaces:

DataProvider, Disposable, Queryable, PopupOwner, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class NavBarPanel
extends javax.swing.JPanel
implements DataProvider, PopupOwner, Disposable, Queryable

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

Disposable.Parent

Nested classes/interfaces inherited from interface com.intellij.openapi.ui.Queryable

Queryable.Contributor, Queryable.PrintInfo, Queryable.Util

Field Summary

Fields

Modifier and Type	Field and Description
protected Project	myProject

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

Constructor and Description
NavBarPanel(Project project, boolean docked)

Method Summary

Modifier and Type	Method and Description
void	addItem(NavBarItem item)
void	addNavBarItemFocusListener(java.awt.event.FocusListener l)
void	addNotify()
protected boolean	allowNavItemsFocus() Navigation bar entry point to determine if the keyboard/focus behavior should be compatible with screen readers.
void	clearItems()
protected NavBarModel	createModel()
void	dispose() Usually not invoked directly, see class javadoc.
protected void	doubleClick(java.lang.Object object)
void	enter()
void	escape()
protected void	fireNavBarItemFocusGained(java.awt.event.FocusEvent e)
protected void	fireNavBarItemFocusLost(java.awt.event.FocusEvent e)
java.awt.Point	getBestPopupPosition()
NavBarItem	getContextObject()
java.lang.Object	getData(java.lang.String dataId) Returns the object corresponding to the specified data identifier.
LightweightHint	getHint()
java.util.List<NavBarItem>	getItems()
NavBarModel	getModel()
NavBarUI	getNavBarUI()
NavBarPopup	getNodePopup()
java.awt.Dimension	getPreferredSize()
NavBarPresentation	getPresentation()
Project	getProject()
NavBarUpdateQueue	getUpdateQueue()
protected void	hideHint(boolean ok)
void	installActions(int index, NavBarItem component)
boolean	isDisposed()
protected boolean	isDisposeOnRemove()
boolean	isFocused()
boolean	isInFloatingMode()
boolean	isNodePopupActive()
boolean	isRebuildUiNeeded()
void	moveDown()
void	moveEnd()
void	moveHome()
void	moveLeft()
void	moveRight()
void	navigate()
protected void	navigateInsideBar(int sourceItemIndex, java.lang.Object object)
void	putInfo(java.util.Map<java.lang.String,java.lang.String> info)
void	rebuildAndSelectItem(java.util.function.Function<java.util.List<NavBarItem>,java.lang.Integer> indexToSelectCallback, boolean showPopup)
void	rebuildAndSelectTail(boolean requestFocus)
void	removeNavBarItemFocusListener(java.awt.event.FocusListener l)
void	removeNotify()
void	requestSelectedItemFocus()
protected void	scrollSelectionToVisible()
void	setContextComponent(java.awt.Component contextComponent)
void	setUI(javax.swing.plaf.PanelUI ui)
void	showHint(Editor editor, DataContext dataContext)
protected void	updateItems()
void	updateState(boolean show)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, 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, getMinimumSize, 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, 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

Field Detail

myProject

protected final Project myProject

Constructor Detail

NavBarPanel

public NavBarPanel(Project project,
                   boolean docked)

Method Detail

allowNavItemsFocus

protected boolean allowNavItemsFocus()

Navigation bar entry point to determine if the keyboard/focus behavior should be compatible with screen readers. This additional level of indirection makes it easier to figure out the various locations in the various navigation bar components that enable screen reader friendly behavior.

isFocused

public boolean isFocused()

addNavBarItemFocusListener

public void addNavBarItemFocusListener(java.awt.event.FocusListener l)

removeNavBarItemFocusListener

public void removeNavBarItemFocusListener(java.awt.event.FocusListener l)

fireNavBarItemFocusGained

protected void fireNavBarItemFocusGained(java.awt.event.FocusEvent e)

fireNavBarItemFocusLost

protected void fireNavBarItemFocusLost(java.awt.event.FocusEvent e)

createModel

protected NavBarModel createModel()

getNodePopup

public NavBarPopup getNodePopup()

isNodePopupActive

public boolean isNodePopupActive()

getHint

public LightweightHint getHint()

getPresentation

public NavBarPresentation getPresentation()

setContextComponent

public void setContextComponent(java.awt.Component contextComponent)

getContextObject

public NavBarItem getContextObject()

getItems

public java.util.List<NavBarItem> getItems()

addItem

public void addItem(NavBarItem item)

clearItems

public void clearItems()

setUI

public void setUI(javax.swing.plaf.PanelUI ui)

Overrides:

setUI in class javax.swing.JPanel

getUpdateQueue

public NavBarUpdateQueue getUpdateQueue()

escape

public void escape()

enter

public void enter()

moveHome

public void moveHome()

navigate

public void navigate()

moveDown

public void moveDown()

moveEnd

public void moveEnd()

getProject

public Project getProject()

getModel

public NavBarModel getModel()

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()

updateItems

protected void updateItems()

rebuildAndSelectItem

public void rebuildAndSelectItem(java.util.function.Function<java.util.List<NavBarItem>,java.lang.Integer> indexToSelectCallback,
                                 boolean showPopup)

rebuildAndSelectTail

public void rebuildAndSelectTail(boolean requestFocus)

requestSelectedItemFocus

public void requestSelectedItemFocus()

moveLeft

public void moveLeft()

moveRight

public void moveRight()

scrollSelectionToVisible

protected void scrollSelectionToVisible()

isInFloatingMode

public boolean isInFloatingMode()

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

isRebuildUiNeeded

public boolean isRebuildUiNeeded()

installActions

public void installActions(int index,
                           NavBarItem component)

doubleClick

protected void doubleClick(java.lang.Object object)

navigateInsideBar

protected void navigateInsideBar(int sourceItemIndex,
                                 java.lang.Object object)

hideHint

protected void hideHint(boolean ok)

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.

getBestPopupPosition

public java.awt.Point getBestPopupPosition()

Specified by:

getBestPopupPosition in interface PopupOwner

addNotify

public void addNotify()

Overrides:

addNotify in class javax.swing.JComponent

removeNotify

public void removeNotify()

Overrides:

removeNotify in class javax.swing.JComponent

isDisposeOnRemove

protected boolean isDisposeOnRemove()

updateState

public void updateState(boolean show)

showHint

public void showHint(Editor editor,
                     DataContext dataContext)

putInfo

public void putInfo(java.util.Map<java.lang.String,java.lang.String> info)

Specified by:

putInfo in interface Queryable

getNavBarUI

public NavBarUI getNavBarUI()