oracle.ide.controls

Class Toolbar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JToolBar

oracle.ide.controls.Toolbar

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants, ThemedToolBar

Direct Known Subclasses:

CodeEditor.CEToolbar

public class Toolbar
extends javax.swing.JToolBar
implements ThemedToolBar

The Toolbar class is a replacement for JToolBar specialized for use in the IDE.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JToolBar.AccessibleJToolBar, javax.swing.JToolBar.Separator

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

Field Summary

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
Toolbar() Creates an empty toolbar.

Method Summary

Modifier and Type	Method and Description
java.awt.Component	add(java.awt.Component comp, int index) With the uptake of the NetBeans windowing system, menu, and toolbar, we no longer support adding a component at a given index when adding to the main window toolbar.
void	add(java.awt.Component comp, java.lang.Object constraints, int index) With the uptake of the NetBeans windowing system, menu, and toolbar, we no longer support adding a component at a given index when adding to the main window toolbar.
ToolButton	add(ToggleAction action) Adds a new button to the toolbar.
ActionMenuToolButton	addActionMenuButton(javax.swing.Action action) Adds a new menu button to the toolbar.
java.awt.Component	addComponent(java.awt.Component component, int index) Adds the specified component to this toolbar at the given position.
void	addFiller() Adds a small blank space filler to the toolbar.
protected void	addImpl(java.awt.Component comp, java.lang.Object constraints, int index)
protected void	addImpl2(java.awt.Component comp, java.lang.Object constraints, int index)
MenuToolButton	addMenuButton(ToggleAction[] actions) Adds a new menu button to the toolbar.
void	addNotify()
RadioToolButton	addRadioButton(ToggleAction action, javax.swing.ButtonGroup bgroup) Adds a RadioToolButton to the toolbar.
void	addSeparator() Adds a new separator to the toolbar.
ToggleToolButton	addToggleButton(ToggleAction action) Adds a toggling button to the toolbar.
static void	addToolbarFilter(ActionFilter filter)
static java.lang.String	buildToolTip(javax.swing.Action action)
void	dispose() Sets the action of each AbstractButton contained within the toolbar to null to avoid memory leaks.
void	forcePrimaryViewToolbar(boolean primaryViewToolbar) Forces this toolbar to either use or not use the primary view toolbar visual style in theme mode.
javax.swing.Action[]	getActions()
protected boolean	isActionAccepted(javax.swing.Action action) Indicates whether an action can be aded to the toolbar.
boolean	isActiveToolbar() For an application that can have active and inactive parts of the UI (like an IDE), the active view is the area in which the user is currently working in (usually it has focus).
protected boolean	isActiveViewToolbar() Determines whether this toolbar is the active view toolbar.
boolean	isLabelVisible() Deprecated. No replacement.
boolean	isPrimaryToolbar() Views can sometimes have more than one toolbar.
java.awt.Component	newFiller() Create filler for use in a toolbar
javax.swing.JToolBar.Separator	newSeparator() Creates a new separator for use in the toolbar.
void	paintComponent(java.awt.Graphics g)
protected void	processMouseEvent(java.awt.event.MouseEvent e)
void	remove(java.awt.Component comp)
void	remove(int index)
void	removeAll()
void	removeNotify()
static void	removeToolbarFilter(ActionFilter filter)
void	setLabelVisible(boolean labelVisible) Deprecated. Not recommended. Can be replaced with putClientProperty("hideActionText", Boolean) on individual toolbar buttons.
void	setPrimaryViewToolbar(boolean primaryViewToolbar) Sets whether this toolbar is the primary toolbar of a view.
void	setSecondaryViewToolbar(boolean secondaryViewToolbar) Sets whether this toolbar is the secondary toolbar of a view.

Methods inherited from class javax.swing.JToolBar

add, addSeparator, createActionChangeListener, createActionComponent, getAccessibleContext, getComponentAtIndex, getComponentIndex, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, isRollover, paintBorder, paramString, setBorderPainted, setFloatable, setLayout, setMargin, setOrientation, setRollover, 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, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, 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, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, 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, addContainerListener, 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, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

Constructor Detail

Toolbar

public Toolbar()

Creates an empty toolbar.

Method Detail

forcePrimaryViewToolbar

public void forcePrimaryViewToolbar(boolean primaryViewToolbar)

Forces this toolbar to either use or not use the primary view toolbar visual style in theme mode. Normally, the IDE will determine whether a toolbar is the primary toolbar of a viwe automatically. If it is unable to detect this for a particular toolbar (or the default detection is wrong), you can call this method to force the visual style on or off.

Parameters:

primaryViewToolbar - if true, this toolbar will be rendered using themes if themes are switched on.

Since:

11.0

paintComponent

public void paintComponent(java.awt.Graphics g)

Overrides:

paintComponent in class javax.swing.JComponent

setPrimaryViewToolbar

public void setPrimaryViewToolbar(boolean primaryViewToolbar)

Sets whether this toolbar is the primary toolbar of a view. This switches on a visual style used only for primary view toolbars.

This method is normally called automatically by the IDE framework for toolbars that are installed into views. To programmatically force a toolbar to either use or not use the visual style, call the forcePrimaryViewToolbar( boolean ) method.

Parameters:

primaryViewToolbar - if true, this toolbar will act as if it is the primary toolbar in the view, ignoring the normal algorithm for detecting this automatically.

Since:

11.0

setSecondaryViewToolbar

public void setSecondaryViewToolbar(boolean secondaryViewToolbar)

Sets whether this toolbar is the secondary toolbar of a view. This switches on a visual style used only for secondary view toolbars.

Parameters:

secondaryViewToolbar - if true, this toolbar will act as if it is the secondary toolbar in the view.

Since:

11.0

add

public final ToolButton add(ToggleAction action)

Adds a new button to the toolbar. If the action is an IdeAction whose command name has been hidden by shaping, using the menu-customization hook, the button will not be added to the toolbar.

Parameters:

action - the action that gets executed when the button is clicked

Returns:

a newly created toolbar button

add

public java.awt.Component add(java.awt.Component comp,
                              int index)

With the uptake of the NetBeans windowing system, menu, and toolbar, we no longer support adding a component at a given index when adding to the main window toolbar. Register your toolbar declaratively for control over its location and grouping.

Overrides:

add in class java.awt.Container

Since:

12.0

add

public void add(java.awt.Component comp,
                java.lang.Object constraints,
                int index)

With the uptake of the NetBeans windowing system, menu, and toolbar, we no longer support adding a component at a given index when adding to the main window toolbar. Register your toolbar declaratively for control over its location and grouping.

Overrides:

add in class java.awt.Container

Since:

12.0

addToggleButton

public final ToggleToolButton addToggleButton(ToggleAction action)

Adds a toggling button to the toolbar. If the action is an IdeAction whose command name has been hidden by shaping, using the menu-customization hook, the button will not be added to the toolbar.

Parameters:

action - the action that gets executed when the button is clicked

Returns:

a newly created toolbar button

addRadioButton

public final RadioToolButton addRadioButton(ToggleAction action,
                                            javax.swing.ButtonGroup bgroup)

Adds a RadioToolButton to the toolbar. If the action is an IdeAction whose command name has been hidden by shaping, using the menu-customization hook, the button will not be added to the toolbar.

Parameters:

action - the action that gets executed when the button is clicked

bgroup - the button group to which the action belongs

Returns:

a newly created toolbar button

addMenuButton

public final MenuToolButton addMenuButton(ToggleAction[] actions)

Adds a new menu button to the toolbar. If any of the actions is an IdeAction whose command name has been hidden by shaping, using the menu-customization hook, the action will not be added to the menu button. If all of the actions are hidden, the MenuToolButton will not be added to the toolbar.

Parameters:

actions - the actions that are shown in a popup menu when the toolbar button is clicked

Returns:

a newly created toolbar button

addActionMenuButton

public final ActionMenuToolButton addActionMenuButton(javax.swing.Action action)

Adds a new menu button to the toolbar. If the action is an IdeAction whose command name has been hidden by shaping, using the menu-customization hook, the MenuToolButton will not be added to the toolbar.

Parameters:

action - the action to add to the popup toolbar button

Returns:

a toolbar button

newSeparator

public final javax.swing.JToolBar.Separator newSeparator()

Creates a new separator for use in the toolbar.

newFiller

public final java.awt.Component newFiller()

Create filler for use in a toolbar

Returns:

filler

addSeparator

public final void addSeparator()

Adds a new separator to the toolbar.

Overrides:

addSeparator in class javax.swing.JToolBar

addFiller

public final void addFiller()

Adds a small blank space filler to the toolbar.

addComponent

public java.awt.Component addComponent(java.awt.Component component,
                                       int index)

Adds the specified component to this toolbar at the given position.

Parameters:

component - the component to be added

index - the position at which to insert the component, or -1 to insert the component at the end

Returns:

the parameter component

setLabelVisible

@Deprecated
public void setLabelVisible(boolean labelVisible)

Deprecated. Not recommended. Can be replaced with putClientProperty("hideActionText", Boolean) on individual toolbar buttons.

isLabelVisible

@Deprecated
public boolean isLabelVisible()

Deprecated. No replacement.

getActions

public javax.swing.Action[] getActions()

dispose

public void dispose()

Sets the action of each AbstractButton contained within the toolbar to null to avoid memory leaks.

remove

public void remove(java.awt.Component comp)

Overrides:

remove in class java.awt.Container

remove

public void remove(int index)

Overrides:

remove in class java.awt.Container

removeAll

public void removeAll()

Overrides:

removeAll in class java.awt.Container

addImpl

protected void addImpl(java.awt.Component comp,
                       java.lang.Object constraints,
                       int index)

Overrides:

addImpl in class javax.swing.JToolBar

addImpl2

protected void addImpl2(java.awt.Component comp,
                        java.lang.Object constraints,
                        int index)

processMouseEvent

protected void processMouseEvent(java.awt.event.MouseEvent e)

Overrides:

processMouseEvent in class javax.swing.JComponent

isActiveToolbar

public boolean isActiveToolbar()

Description copied from interface: ThemedToolBar

For an application that can have active and inactive parts of the UI (like an IDE), the active view is the area in which the user is currently working in (usually it has focus).

Specified by:

isActiveToolbar in interface ThemedToolBar

Returns:

true if the toolbar is currently in the active view.

isPrimaryToolbar

public boolean isPrimaryToolbar()

Description copied from interface: ThemedToolBar

Views can sometimes have more than one toolbar. Primary toolbars may be painted differently from secondary toolbars.

Specified by:

isPrimaryToolbar in interface ThemedToolBar

Returns:

true if the toolbar is the primary toolbar.

isActiveViewToolbar

protected boolean isActiveViewToolbar()

Determines whether this toolbar is the active view toolbar. The active view toolbar has a special visual style applied to it in theme mode.

This implementation checks the active view using IdeMainWindow.getLastActiveView(). If this toolbar instance is the toolbar of that view, then this method returns true.

Subclasses may want to override this to provide a custom implementation, particularly if the toolbar is not returned by the View.getToolbar() or Editor.getScrollableTopMargin() methods.

Returns:

true if this toolbar is a toolbar in the active view.

Since:

11.0

addNotify

public void addNotify()

Overrides:

addNotify in class javax.swing.JComponent

removeNotify

public void removeNotify()

Overrides:

removeNotify in class javax.swing.JComponent

addToolbarFilter

public static void addToolbarFilter(ActionFilter filter)

removeToolbarFilter

public static void removeToolbarFilter(ActionFilter filter)

isActionAccepted

protected final boolean isActionAccepted(javax.swing.Action action)

Indicates whether an action can be aded to the toolbar. This method tests whether the action is an IdeAction whose command name has been hidden using the menu-customization hook. If the action is not hidden, this method returns true, otherwise, it returns false.

Parameters:

action - The action to add to the toolbar.

Returns:

true if the action can be added to the toolbar, false if the action has been hidden.

buildToolTip

public static java.lang.String buildToolTip(javax.swing.Action action)