Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui
Class SubActionBars

java.lang.Object
  org.eclipse.ui.SubActionBars

All Implemented Interfaces:

IActionBars

Direct Known Subclasses:

SubActionBars2

public class SubActionBars

extends Object

implements IActionBars

Generic implementation of the IActionBars interface.

Field Summary

static String

P_ACTION_HANDLERS Property constant for changes to action handlers.

Constructor Summary

SubActionBars(IActionBars parent)
Construct a new SubActionBars object.

Method Summary

void	activate() Activate the contributions.
void	activate(boolean forceVisibility) Activate the contributions.
void	addPropertyChangeListener(IPropertyChangeListener listener) Adds a property change listener.
protected void	basicSetActive(boolean active) Sets the active flag.
void	clearGlobalActionHandlers() Clear the global action handlers.
protected SubMenuManager	createSubMenuManager(IMenuManager parent) Returns a new sub menu manager.
protected SubToolBarManager	createSubToolBarManager(IToolBarManager parent) Returns a new sub toolbar manager.
void	deactivate() Deactivate the contributions.
void	deactivate(boolean forceHide) Deactivate the contributions.
void	dispose() Dispose the contributions.
protected void	fireActionHandlersChanged() Notifies any property change listeners if the global action handlers have changed
protected void	firePropertyChange(PropertyChangeEvent event) Notifies any property change listeners that a property has changed.
protected boolean	getActive() Return whether the manager is currently active or not.
IAction	getGlobalActionHandler(String actionID) Get the handler for a window action.
Map	getGlobalActionHandlers() Returns the complete list of active global action handlers.
IMenuManager	getMenuManager() Returns the abstract menu manager.
protected IActionBars	getParent() Return the parent action bar manager.
IStatusLineManager	getStatusLineManager() Returns the status line manager.
IToolBarManager	getToolBarManager() Returns the tool bar manager.
protected boolean	isSubMenuManagerCreated() Return whether the sub menu manager has been created yet.
protected boolean	isSubStatusLineManagerCreated() Return whether the sub status line manager has been created yet.
protected boolean	isSubToolBarManagerCreated() Return whether the sub toolbar manager has been created yet.
void	partChanged(IWorkbenchPart part) Notification that the target part for the action bars has changed.
void	removePropertyChangeListener(IPropertyChangeListener listener) Removes the given property change listener.
protected void	setActive(boolean set) Activate / deactivate the contributions.
void	setGlobalActionHandler(String actionID, IAction handler) Add a handler for a window action.
void	updateActionBars() Commits all UI changes.

Methods inherited from class java.lang.Object

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

Field Detail

P_ACTION_HANDLERS

public static final String P_ACTION_HANDLERS

Property constant for changes to action handlers.

See Also:

Constant Field Values

Constructor Detail

SubActionBars

public SubActionBars(IActionBars parent)

Construct a new SubActionBars object.

Method Detail

activate

public void activate()

Activate the contributions.

activate

public void activate(boolean forceVisibility)

Activate the contributions.

Workaround for toolbar layout flashing when editors contribute large amounts of items. In this case we want to force the items to be visible/hidden only when required, otherwise just change the enablement state.

addPropertyChangeListener

public void addPropertyChangeListener(IPropertyChangeListener listener)

Adds a property change listener. Has no effect if an identical listener is already registered.

Parameters:

listener - a property change listener

clearGlobalActionHandlers

public void clearGlobalActionHandlers()

Clear the global action handlers.

Specified by:

clearGlobalActionHandlers in interface IActionBars

createSubMenuManager

protected SubMenuManager createSubMenuManager(IMenuManager parent)

Returns a new sub menu manager.

Parameters:

parent - the parent menu manager

Returns:

the menu manager

createSubToolBarManager

protected SubToolBarManager createSubToolBarManager(IToolBarManager parent)

Returns a new sub toolbar manager.

Parameters:

parent - the parent toolbar manager

Returns:

the tool bar manager

deactivate

public void deactivate()

Deactivate the contributions.

deactivate

public void deactivate(boolean forceHide)

Deactivate the contributions.

Workaround for menubar/toolbar layout flashing when editors have many contributions. In this case we want to force the contributions to be visible/hidden only when required, otherwise just change the enablement state.

dispose

public void dispose()

Dispose the contributions.

firePropertyChange

protected void firePropertyChange(PropertyChangeEvent event)

Notifies any property change listeners that a property has changed. Only listeners registered at the time this method is called are notified.

Parameters:

event - the property change event

See Also:

IPropertyChangeListener.propertyChange(org.eclipse.jface.util.PropertyChangeEvent)

fireActionHandlersChanged

protected void fireActionHandlersChanged()

Notifies any property change listeners if the global action handlers have changed

getActive

protected final boolean getActive()

Return whether the manager is currently active or not.

getGlobalActionHandler

public IAction getGlobalActionHandler(String actionID)

Get the handler for a window action.

Specified by:

getGlobalActionHandler in interface IActionBars

Parameters:

actionID - an action ID declared in the registry

Returns:

an action handler which implements the action ID, or null if none is registered.

See Also:

IWorkbenchActionConstants, IActionBars.setGlobalActionHandler(String, IAction)

getGlobalActionHandlers

public Map getGlobalActionHandlers()

Returns the complete list of active global action handlers. If there are no global action handlers registered return null.

getMenuManager

public IMenuManager getMenuManager()

Returns the abstract menu manager. If items are added or removed from the manager be sure to call updateActionBars.

Specified by:

getMenuManager in interface IActionBars

Returns:

the menu manager

getParent

protected final IActionBars getParent()

Return the parent action bar manager.

getStatusLineManager

public IStatusLineManager getStatusLineManager()

Returns the status line manager. If items are added or removed from the manager be sure to call updateActionBars.

Specified by:

getStatusLineManager in interface IActionBars

Returns:

the status line manager

getToolBarManager

public IToolBarManager getToolBarManager()

Returns the tool bar manager. If items are added or removed from the manager be sure to call updateActionBars.

Specified by:

getToolBarManager in interface IActionBars

Returns:

the tool bar manager

isSubMenuManagerCreated

protected final boolean isSubMenuManagerCreated()

Return whether the sub menu manager has been created yet.

isSubToolBarManagerCreated

protected final boolean isSubToolBarManagerCreated()

Return whether the sub toolbar manager has been created yet.

isSubStatusLineManagerCreated

protected final boolean isSubStatusLineManagerCreated()

Return whether the sub status line manager has been created yet.

partChanged

public void partChanged(IWorkbenchPart part)

Notification that the target part for the action bars has changed.

removePropertyChangeListener

public void removePropertyChangeListener(IPropertyChangeListener listener)

Removes the given property change listener. Has no effect if an identical listener is not registered.

Parameters:

listener - a property change listener

basicSetActive

protected final void basicSetActive(boolean active)

Sets the active flag. Clients should not call this method directly unless they are overriding the setActive() method.

setActive

protected void setActive(boolean set)

Activate / deactivate the contributions.

setGlobalActionHandler

public void setGlobalActionHandler(String actionID,
                                   IAction handler)

Add a handler for a window action.

Specified by:

setGlobalActionHandler in interface IActionBars

Parameters:

actionID - an action ID declared in the registry

handler - an action which implements the action ID. null may be passed to deregister a handler.

See Also:

IWorkbenchActionConstants

updateActionBars

public void updateActionBars()

Commits all UI changes. This should be called after additions or subtractions have been made to a menu, status line, or toolbar.

Specified by:

updateActionBars in interface IActionBars