Package com.intellij.openapi.actionSystem

Interface ActionToolbar

All Known Implementing Classes:

ActionToolbarImpl

public interface ActionToolbar

Represents a toolbar with a visual presentation.

See Also:

ActionManager.createActionToolbar(String, ActionGroup, boolean)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ActionToolbar.LayoutPolicy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_TOOLBAR_PROPERTY_KEY
static int	AUTO_LAYOUT_POLICY This is experimental layout policy which allow toolbar auto-hide and show buttons that don't fit into actual side
static java.awt.Dimension	DEFAULT_MINIMUM_BUTTON_SIZE This is default minimum size of the toolbar button
static java.awt.Dimension	NAVBAR_MINIMUM_BUTTON_SIZE
static int	NOWRAP_LAYOUT_POLICY This is default layout policy for the toolbar.
static int	WRAP_LAYOUT_POLICY This is experimental layout policy which allow toolbar to wrap components in multiple rows.

Method Summary

Modifier and Type	Method and Description
void	adjustTheSameSize(boolean value) If the value is true then the all button on toolbar are the same size.
java.util.List<AnAction>	getActions()
javax.swing.JComponent	getComponent()
int	getLayoutPolicy()
int	getMaxButtonHeight()
DataContext	getToolbarDataContext()
boolean	hasVisibleActions()
void	setLayoutPolicy(int layoutPolicy) Sets new component layout policy.
void	setMiniMode(boolean minimalMode)
void	setMinimumButtonSize(java.awt.Dimension size) Sets minimum size of toolbar button.
void	setOrientation(int orientation) Sets toolbar orientation
void	setReservePlaceAutoPopupIcon(boolean reserve)
void	setSecondaryActionsIcon(javax.swing.Icon icon)
void	setSecondaryActionsIcon(javax.swing.Icon icon, boolean hideDropdownIcon)
void	setSecondaryActionsTooltip(java.lang.String secondaryActionsTooltip)
default void	setShowSeparatorTitles(boolean showSeparatorTitles) Enables showing titles of separators as labels in the toolbar (off by default).
void	setTargetComponent(javax.swing.JComponent component) Will be used for data-context retrieval.
void	updateActionsImmediately() Forces update of the all actions in the toolbars.

Field Detail

ACTION_TOOLBAR_PROPERTY_KEY

static final java.lang.String ACTION_TOOLBAR_PROPERTY_KEY

See Also:

Constant Field Values

NOWRAP_LAYOUT_POLICY

static final int NOWRAP_LAYOUT_POLICY

This is default layout policy for the toolbar. It defines that all toolbar component are in one row / column and they are not wrapped when toolbar is small

See Also:

Constant Field Values

WRAP_LAYOUT_POLICY

static final int WRAP_LAYOUT_POLICY

This is experimental layout policy which allow toolbar to wrap components in multiple rows.

See Also:

Constant Field Values

AUTO_LAYOUT_POLICY

static final int AUTO_LAYOUT_POLICY

This is experimental layout policy which allow toolbar auto-hide and show buttons that don't fit into actual side

See Also:

Constant Field Values

DEFAULT_MINIMUM_BUTTON_SIZE

static final java.awt.Dimension DEFAULT_MINIMUM_BUTTON_SIZE

This is default minimum size of the toolbar button

NAVBAR_MINIMUM_BUTTON_SIZE

static final java.awt.Dimension NAVBAR_MINIMUM_BUTTON_SIZE

Method Detail

getComponent

javax.swing.JComponent getComponent()

Returns:

component which represents the tool bar on UI

getLayoutPolicy

int getLayoutPolicy()

Returns:

current layout policy

See Also:

NOWRAP_LAYOUT_POLICY, WRAP_LAYOUT_POLICY

setLayoutPolicy

void setLayoutPolicy(int layoutPolicy)

Sets new component layout policy. Method accepts WRAP_LAYOUT_POLICY and NOWRAP_LAYOUT_POLICY values.

adjustTheSameSize

void adjustTheSameSize(boolean value)

If the value is true then the all button on toolbar are the same size. It very useful when you create "Outlook" like toolbar. Currently this method can be considered as hot fix.

setMinimumButtonSize

void setMinimumButtonSize(java.awt.Dimension size)

Sets minimum size of toolbar button. By default all buttons at toolbar has 25x25 pixels size.

Throws:

java.lang.IllegalArgumentException - if size is null

setOrientation

void setOrientation(int orientation)

Sets toolbar orientation

See Also:

SwingConstants.HORIZONTAL, SwingConstants.VERTICAL

getMaxButtonHeight

int getMaxButtonHeight()

Returns:

maximum button height

updateActionsImmediately

void updateActionsImmediately()

Forces update of the all actions in the toolbars. Actions, however, normally updated automatically every 500 ms.

hasVisibleActions

boolean hasVisibleActions()

setTargetComponent

void setTargetComponent(javax.swing.JComponent component)

Will be used for data-context retrieval.

setReservePlaceAutoPopupIcon

void setReservePlaceAutoPopupIcon(boolean reserve)

setSecondaryActionsTooltip

void setSecondaryActionsTooltip(java.lang.String secondaryActionsTooltip)

setSecondaryActionsIcon

void setSecondaryActionsIcon(javax.swing.Icon icon)

setSecondaryActionsIcon

void setSecondaryActionsIcon(javax.swing.Icon icon,
                             boolean hideDropdownIcon)

getActions

java.util.List<AnAction> getActions()

setMiniMode

void setMiniMode(boolean minimalMode)

getToolbarDataContext

DataContext getToolbarDataContext()

setShowSeparatorTitles

default void setShowSeparatorTitles(boolean showSeparatorTitles)

Enables showing titles of separators as labels in the toolbar (off by default).