UIEvents

java.lang.Object
- org.eclipse.e4.ui.workbench.UIEvents

```
public class UIEvents
extends java.lang.Object
```
E4 UI events and event topic definitions. This file contains generated and hand crafted event topic constants. There are also hand crafted utility methods for constructing topic strings and publishing events. When the UI model changes org.eclipse.e4.ui.internal.workbench.swt.GenTopic should be run as an Eclipse application and the console results should be pasted into this file replacing the code below the "Place Generated Code Here" comment

Since:

1.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UIEvents.Application`
`static interface`	`UIEvents.ApplicationElement`
`static interface`	`UIEvents.BindingContext` GENERATED CODE!!
`static interface`	`UIEvents.Bindings`
`static interface`	`UIEvents.BindingTable`
`static interface`	`UIEvents.BindingTableContainer`
`static interface`	`UIEvents.Category`
`static interface`	`UIEvents.Command`
`static interface`	`UIEvents.CommandParameter`
`static interface`	`UIEvents.Context`
`static interface`	`UIEvents.Contribution`
`static interface`	`UIEvents.CoreExpression`
`static interface`	`UIEvents.Dirtyable`
`static interface`	`UIEvents.ElementContainer`
`static interface`	`UIEvents.EventTags` E4 UI Event argument attribute keys.
`static interface`	`UIEvents.EventTypes` E4 UI Event Types.
`static interface`	`UIEvents.GenericTile`
`static interface`	`UIEvents.GenericTrimContainer`
`static interface`	`UIEvents.HandledItem`
`static interface`	`UIEvents.Handler`
`static interface`	`UIEvents.HandlerContainer`
`static interface`	`UIEvents.ImperativeExpression`
`static interface`	`UIEvents.Input` Deprecated.
`static interface`	`UIEvents.Item`
`static interface`	`UIEvents.KeyBinding`
`static interface`	`UIEvents.KeySequence`
`static interface`	`UIEvents.Menu`
`static interface`	`UIEvents.MenuContribution`
`static interface`	`UIEvents.MenuContributions`
`static interface`	`UIEvents.MenuElement`
`static interface`	`UIEvents.OpaqueMenuItem`
`static interface`	`UIEvents.OpaqueMenuSeparator`
`static interface`	`UIEvents.OpaqueToolItem`
`static interface`	`UIEvents.Parameter`
`static interface`	`UIEvents.Part`
`static interface`	`UIEvents.PartDescriptor`
`static interface`	`UIEvents.PartDescriptorContainer`
`static interface`	`UIEvents.Perspective`
`static interface`	`UIEvents.Placeholder`
`static interface`	`UIEvents.RenderedMenu`
`static interface`	`UIEvents.RenderedMenuItem`
`static interface`	`UIEvents.RenderedToolBar`
`static interface`	`UIEvents.SnippetContainer`
`static interface`	`UIEvents.StringToObjectMap`
`static interface`	`UIEvents.StringToStringMap`
`static interface`	`UIEvents.ToolBarContribution`
`static interface`	`UIEvents.ToolBarContributions`
`static interface`	`UIEvents.ToolItem`
`static interface`	`UIEvents.TrimBar`
`static interface`	`UIEvents.TrimContribution`
`static interface`	`UIEvents.TrimContributions`
`static interface`	`UIEvents.TrimmedWindow`
`static interface`	`UIEvents.UIElement`
`static interface`	`UIEvents.UILabel`
`static interface`	`UIEvents.UILifeCycle` E4 UI life cycle events.
`static interface`	`UIEvents.Window`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ALL_ELEMENT_ID` Special id passed to force all elements to be checked
`static java.lang.String`	`ALL_SUB_TOPICS` Wild card character for matching all sub topics
`static java.lang.String`	`REQUEST_ENABLEMENT_UPDATE_TOPIC` Event sent when a enabled update is requested for tool-items.
`static java.lang.String`	`TOPIC_SEP` Topic separator character
`static java.lang.String`	`UIModelTopicBase` Name element for all E4 UI model events (these are generated by GenTopic)
`static java.lang.String`	`UIRendererTopicBase` Name element for E4 Renderer events
`static java.lang.String`	`UITopicBase` Base name of all E4 UI events

Constructor Summary

Constructors
Constructor and Description

UIEvents()

Constructors
Constructor and Description
`UIEvents()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static java.lang.Iterable<?>`	`asIterable(Event event, java.lang.String propertyName)` Return the provided event property as an iterable.
`static java.lang.String`	`buildTopic(java.lang.String topic)` Deprecated.
`static java.lang.String`	`buildTopic(java.lang.String topic, java.lang.String attrName)` Deprecated.
`static java.lang.String`	`buildTopic(java.lang.String topic, java.lang.String attrName, java.lang.String eventType)` Deprecated.
`static boolean`	`contains(Event event, java.lang.String propertyName, java.lang.Object o)` Return true if the specified property contains `o`.
`static boolean`	`isADD(Event event)`
`static boolean`	`isCREATE(Event event)`
`static boolean`	`isREMOVE(Event event)`
`static boolean`	`isSET(Event event)`
`static boolean`	`publishEvent(java.lang.String topic, MUIElement changedElement)` Publish the topic to the changedElements global event bus.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TOPIC_SEP
```
public static final java.lang.String TOPIC_SEP
```
    Topic separator character
    
    See Also:
    
    Constant Field Values
  - ALL_SUB_TOPICS
```
public static final java.lang.String ALL_SUB_TOPICS
```
    Wild card character for matching all sub topics
    
    See Also:
    
    Constant Field Values
  - UITopicBase
```
public static final java.lang.String UITopicBase
```
    Base name of all E4 UI events
    
    See Also:
    
    Constant Field Values
  - UIModelTopicBase
```
public static final java.lang.String UIModelTopicBase
```
    Name element for all E4 UI model events (these are generated by GenTopic)
    
    See Also:
    
    Constant Field Values
  - UIRendererTopicBase
```
public static final java.lang.String UIRendererTopicBase
```
    Name element for E4 Renderer events
    
    Since:
    
    1.1
    
    See Also:
    
    Constant Field Values
  - REQUEST_ENABLEMENT_UPDATE_TOPIC
```
public static final java.lang.String REQUEST_ENABLEMENT_UPDATE_TOPIC
```
    Event sent when a enabled update is requested for tool-items.
    As a value you may pass in to the IEventBroker#DATA:
    - the special value ALL_ELEMENT_ID to request changes of all applicable elements (the default)
    - the MApplicationElement#getElementId() of the element to check
    - instance of Selector
    Since:
    
    1.1
    
    See Also:
    
    Constant Field Values
  - ALL_ELEMENT_ID
```
public static final java.lang.String ALL_ELEMENT_ID
```
    Special id passed to force all elements to be checked
    
    Since:
    
    1.1
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UIEvents
```
public UIEvents()
```
- Method Detail
  - isADD
```
public static boolean isADD(Event event)
```
    Parameters:
    
    event - An OSGI event representing a UIEvent
    
    Returns:
    
    true if it is an add event (i.e., UIEvents.EventTypes.ADD or UIEvents.EventTypes.ADD_MANY), or false otherwise.
    
    See Also:
    
    UIEvents.EventTags.NEW_VALUE, asIterable(Event, String)
  - isREMOVE
```
public static boolean isREMOVE(Event event)
```
    Parameters:
    
    event - An OSGI event representing a UIEvent
    
    Returns:
    
    true if it is a remove event (i.e., UIEvents.EventTypes.REMOVE or UIEvents.EventTypes.REMOVE_MANY), or false otherwise.
    
    See Also:
    
    UIEvents.EventTags.OLD_VALUE, asIterable(Event, String)
  - isSET
```
public static boolean isSET(Event event)
```
    Parameters:
    
    event - An OSGI event representing a UIEvent
    
    Returns:
    
    true if it is a set event, false otherwise.
  - isCREATE
```
public static boolean isCREATE(Event event)
```
    Parameters:
    
    event - An OSGI event representing a UIEvent
    
    Returns:
    
    true if it is a create event, false otherwise.
  - contains
```
public static boolean contains(Event event,
                               java.lang.String propertyName,
                               java.lang.Object o)
```
    Return true if the specified property contains o. Intended as a helper function for UIEvents.EventTypes.ADD, UIEvents.EventTypes.ADD_MANY, UIEvents.EventTypes.REMOVE, and UIEvents.EventTypes.REMOVE_MANY. If the property is not a container (e.g., a collection or array), then return true then if container is equal to o.
    
    Parameters:
    
    event - the event
    
    propertyName - the property name
    
    o - the object to check for containment
    
    Returns:
    
    true if the property value contains o or is equal to o
  - asIterable
```
public static java.lang.Iterable<?> asIterable(Event event,
                                               java.lang.String propertyName)
```
    Return the provided event property as an iterable. If already a collection, return the collection.
    
    Parameters:
    
    event - the event object
    
    propertyName - the name of the property
    
    Returns:
    
    an iterable collection over the property elements
  - publishEvent
```
public static boolean publishEvent(java.lang.String topic,
                                   MUIElement changedElement)
```
    Publish the topic to the changedElements global event bus. The changedElement is added the the EventTags.ELEMENT tag.
    
    Parameters:
    
    topic - to broadcast
    
    changedElement - the element that changed
    
    Returns:
    
    true if the event is published correctly, false otherwise
  - buildTopic
```
@Deprecated
public static java.lang.String buildTopic(java.lang.String topic)
```
    Deprecated.
  - buildTopic
```
@Deprecated
public static java.lang.String buildTopic(java.lang.String topic,
                                                      java.lang.String attrName)
```
    Deprecated.
  - buildTopic
```
@Deprecated
public static java.lang.String buildTopic(java.lang.String topic,
                                                      java.lang.String attrName,
                                                      java.lang.String eventType)
```
    Deprecated.

Class UIEvents

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TOPIC_SEP

ALL_SUB_TOPICS

UITopicBase

UIModelTopicBase

UIRendererTopicBase

REQUEST_ENABLEMENT_UPDATE_TOPIC

ALL_ELEMENT_ID

Constructor Detail

UIEvents

Method Detail

isADD

isREMOVE

isSET

isCREATE

contains

asIterable

publishEvent

buildTopic

buildTopic

buildTopic