Eclipse Plug-in Developer Guide (Galileo) - IMenuCreator (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.action
Interface IMenuCreator

All Known Implementing Classes:: ContextualLaunchAction, LaunchAsAction, LaunchShortcutsAction, RulerBreakpointTypesActionDelegate

public interface IMenuCreator

Interface for something that creates and disposes of SWT menus. Note that it is the responsibility of the implementor to dispose of SWT menus it creates.

Method Summary

void dispose ()
          Disposes the menu returned by getMenu.

Menu getMenu ( Control parent)
          Returns the SWT menu, created as a pop up menu parented by the given control.

Menu getMenu ( Menu parent)
          Returns an SWT menu created as a drop down menu parented by the given menu.

Method Detail

dispose

void dispose()

Disposes the menu returned by getMenu. Does nothing if there is no menu. This method will be executed only when the parent of the menu is disposed.

getMenu

Menu getMenu(
Control parent)

Returns the SWT menu, created as a pop up menu parented by the given control. In most cases, this menu can be created once, cached and reused when the pop-up/drop-down action occurs. If the menu must be dynamically created (i.e., each time it is popped up or dropped down), the old menu should be disposed of before replacing it with the new menu.

Parameters:: parent - the parent control
Returns:: the menu, or null if the menu could not be created

getMenu

Menu getMenu(
Menu parent)

Returns an SWT menu created as a drop down menu parented by the given menu. In most cases, this menu can be created once, cached and reused when the pop-up/drop-down action occurs. If the menu must be dynamically created (i.e., each time it is popped up or dropped down), the old menu should be disposed of before replacing it with the new menu.