org.eclipse.e4.ui.internal.workbench

Class OpaqueElementUtil

java.lang.Object

org.eclipse.e4.ui.internal.workbench.OpaqueElementUtil

public class OpaqueElementUtil
extends java.lang.Object

Utility class that encapsulates the representation of 'opaque' menu and tool bar elements in the model.

Constructor Summary

Constructors

Constructor and Description
OpaqueElementUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	clearOpaqueItem(MUIElement uiElement) Remove the 'opaque item' from the UI Element
static MMenu	createOpaqueMenu() Create an opaque menu
static MMenuItem	createOpaqueMenuItem() Create an opaque menu item
static MMenuSeparator	createOpaqueMenuSeparator() Create an opaque menu separator
static MToolItem	createOpaqueToolItem() Create an opaque tool item
static java.lang.Object	getOpaqueItem(MUIElement uiElement) Get the 'opaque item' associated with the UI Element.
static boolean	isOpaqueMenu(MUIElement item) Tests whether a menu element is an opaque menue
static boolean	isOpaqueMenuItem(MUIElement item) Tests whether a menu element is an opaque menu item
static boolean	isOpaqueMenuSeparator(MUIElement item) Tests whether a menu element is an opaque menu separator
static boolean	isOpaqueToolItem(MUIElement uiElement) Tests whether a UI element is an 'opaque' tool item
static void	setOpaqueItem(MUIElement uiElement, java.lang.Object opaqueItem) Set the 'opaque item' associated with the UI Element.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpaqueElementUtil

public OpaqueElementUtil()

Method Detail

clearOpaqueItem

public static java.lang.Object clearOpaqueItem(MUIElement uiElement)

Remove the 'opaque item' from the UI Element

Parameters:

uiElement - the UI element

Returns:

the removed 'opaque item' or null

createOpaqueMenu

public static MMenu createOpaqueMenu()

Create an opaque menu

Returns:

a new opaque menu

createOpaqueMenuItem

public static MMenuItem createOpaqueMenuItem()

Create an opaque menu item

Returns:

a new opaque menu item.

createOpaqueMenuSeparator

public static MMenuSeparator createOpaqueMenuSeparator()

Create an opaque menu separator

Returns:

a new opaque menu separator

createOpaqueToolItem

public static MToolItem createOpaqueToolItem()

Create an opaque tool item

Returns:

a new opaque tool item.

getOpaqueItem

public static java.lang.Object getOpaqueItem(MUIElement uiElement)

Get the 'opaque item' associated with the UI Element.

Parameters:

uiElement - a UI element

Returns:

the opaque item or null

isOpaqueMenu

public static boolean isOpaqueMenu(MUIElement item)

Tests whether a menu element is an opaque menue

Parameters:

item -

Returns:

true if the element is an 'opaque' menu

isOpaqueMenuItem

public static boolean isOpaqueMenuItem(MUIElement item)

Tests whether a menu element is an opaque menu item

Parameters:

item - a menu item.

Returns:

true if the menu element is an 'opaque' menu item

isOpaqueMenuSeparator

public static boolean isOpaqueMenuSeparator(MUIElement item)

Tests whether a menu element is an opaque menu separator

Parameters:

item - a menu item.

Returns:

true if the menu element is an 'opaque' separator

isOpaqueToolItem

public static boolean isOpaqueToolItem(MUIElement uiElement)

Tests whether a UI element is an 'opaque' tool item

Parameters:

uiElement - a UI element.

Returns:

true if the tool item is 'opaque'

setOpaqueItem

public static void setOpaqueItem(MUIElement uiElement,
                                 java.lang.Object opaqueItem)

Set the 'opaque item' associated with the UI Element.

Parameters:

uiElement - the UI Element.

opaqueItem - the opaque item.