JFace/SWT: What is the best way to add a toolbar with Commands to a Section?

Question

I have a Section and want to add a toolbar to it. I'm able to do it programmatically using the Actions but the requirement is to do it as much declaratively (in plugin.xml) as I can. So I'd like to define a Command and a Handler for each toolbar button but I don't know how to add them to the section's toolbar. Is there any way to do it declaratively in plugin.xml? If not, how can I do it programmatically?

Thanks!

score 1 · Answer 1 · answered Feb 18 '14 at 11:46

1

I think you would have to write your own extension point to define what would go in the plugin.xml and then write code to access the extension point registry to get the declared extensions and create the toolbar from the information.

See Eclipse Extension Points and Extensions for some more details.

answered Feb 18 '14 at 11:46

greg-449

109,219
232
102
145

Thank you very much, that would be the last resort if everything else fails :) – janhink Feb 19 '14 at 07:23

sambi reddy · Answer 2 · 2014-02-19T17:02:21.797

1

You need to look at how to use org.eclipse.ui.menus extension point. It supports adding commands/widgets to menu/popup/toolbar/trim.

//contributing to local toolbar

ToolBarManager localToolBarmanager = new ToolBarManager();
IMenuService menuService = (IMenuService) PlatformUI.getWorkbench().getService(IMenuService.class);
menuService.populateContributionManager(localToolBarmanager,
    "toolbar:localtoolbar");  //id of your local toolbar
localToolBarmanager.createControl(control);

edited Feb 19 '14 at 17:02

answered Feb 18 '14 at 21:31

sambi reddy

3,065
1
13
10

Thank you, that is true. But I need to add commands to a toolbar which is neither a main toolbar nor a view's toolbar but a custom toolbar created programmatically. Can I do it somehow using this extension? – janhink Feb 19 '14 at 07:22
I just updated my answer.take a look. it should read contributions defined for menus extension with the local toolbar id given – sambi reddy Feb 19 '14 at 17:03

flavio.donze · Answer 3 · 2016-04-06T06:06:23.557

Here is a sample of how to create a toolbar for a section, make sure the toolbar is created before section.setClient().

protected void createToolbar(Section section) {
    ToolBarManager toolBarManager = new ToolBarManager(SWT.FLAT);
    toolBarManager.add(new Action("print") {
        @Override
        public void run() {
            System.out.println("PRINT");
        }
    });
    createSectionToolbar(section, toolBarManager);
}

/**
 * create a toolbar in the passed section
 * 
 * @param section
 * @param toolBarManager
 */
protected void createSectionToolbar(Section section, ToolBarManager toolBarManager) {
    Composite toolbarComposite = toolkit.createComposite(section);
    toolbarComposite.setBackground(null);
    toolBarManager.createControl(toolbarComposite);
    section.clientVerticalSpacing = 0;
    section.descriptionVerticalSpacing = 0;
    section.setTextClient(toolbarComposite);
}

If you want to add declared commands from the plugin.xml to the toolbar, have a look at CommandContributionItem.

toolBarManager.add(new CommandContributionItem(new CommandContributionItemParameter(getSite(), "id", "commandId", SWT.NONE)));

JFace/SWT: What is the best way to add a toolbar with Commands to a Section?

3 Answers3

Linked