Eclipse Platform
Release 3.3

org.eclipse.ui.menus
Class MenuUtil

java.lang.Object
  extended byorg.eclipse.ui.menus.MenuUtil

public class MenuUtil
extends Object

Provides utilities and constants for use with the new menus API.

Since:
3.3

Field Summary
static String ANY_POPUP
          -Any- Popup Menu
static String MAIN_MENU
          Main Menu
static String MAIN_TOOLBAR
          Main ToolBar (CoolBar)
static String TRIM_COMMAND1
          Top Left Trim Area
static String TRIM_COMMAND2
          Top Right Trim Area
static String TRIM_STATUS
          Bottom (Status) Trim Area
static String TRIM_VERTICAL1
          Left Vertical Trim Area
static String TRIM_VERTICAL2
          Right Vertical Trim Area
 
Constructor Summary
MenuUtil()
           
 
Method Summary
static String menuAddition(String id)
          Convenience method to create a standard menu addition The resulting string has the format: "menu:[id]?
static String menuAddition(String id, String location, String refId)
           
static String menuUri(String id)
           
static String toolbarAddition(String id)
          Convenience method to create a standard toolbar addition The resulting string has the format: "toolbar:[id]?
static String toolbarAddition(String id, String location, String refId)
           
static String toolbarUri(String id)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MAIN_MENU

public static final String MAIN_MENU
Main Menu

See Also:
Constant Field Values

MAIN_TOOLBAR

public static final String MAIN_TOOLBAR
Main ToolBar (CoolBar)

See Also:
Constant Field Values

ANY_POPUP

public static final String ANY_POPUP
-Any- Popup Menu

See Also:
Constant Field Values

TRIM_COMMAND1

public static final String TRIM_COMMAND1
Top Left Trim Area

See Also:
Constant Field Values

TRIM_COMMAND2

public static final String TRIM_COMMAND2
Top Right Trim Area

See Also:
Constant Field Values

TRIM_VERTICAL1

public static final String TRIM_VERTICAL1
Left Vertical Trim Area

See Also:
Constant Field Values

TRIM_VERTICAL2

public static final String TRIM_VERTICAL2
Right Vertical Trim Area

See Also:
Constant Field Values

TRIM_STATUS

public static final String TRIM_STATUS
Bottom (Status) Trim Area

See Also:
Constant Field Values
Constructor Detail

MenuUtil

public MenuUtil()
Method Detail

menuUri

public static String menuUri(String id)
Parameters:
id - The menu's id
Returns:
The lcoation URI for a menu with the given id

menuAddition

public static String menuAddition(String id,
                                  String location,
                                  String refId)
Parameters:
id - The id of the menu
location - The relative location specifier
refId - The id of the menu element to be relative to
Returns:
A location URI formatted with the given parameters

menuAddition

public static String menuAddition(String id)
Convenience method to create a standard menu addition The resulting string has the format: "menu:[id]?after=additions"

Parameters:
id - The id of the root element to contribute to
Returns:
The formatted string

toolbarUri

public static String toolbarUri(String id)
Parameters:
id - The toolbar's id
Returns:
The lcoation URI for a toolbar with the given id

toolbarAddition

public static String toolbarAddition(String id,
                                     String location,
                                     String refId)
Parameters:
id - The id of the toolbar
location - The relative location specifier
refId - The id of the toolbar element to be relative to
Returns:
A location URI formatted with the given parameters

toolbarAddition

public static String toolbarAddition(String id)
Convenience method to create a standard toolbar addition The resulting string has the format: "toolbar:[id]?after=additions"

Parameters:
id - The id of the root element to contribute to
Returns:
The formatted string

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.