Class UIEvents


  • public class UIEvents
    extends 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
    Restriction:
    This class is not intended to be subclassed by clients.
    Restriction:
    This class is not intended to be instantiated by clients.
    • Constructor Detail

      • UIEvents

        public UIEvents()
    • Method Detail

      • 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.
      • asIterable

        public static Iterable<?> asIterable​(Event event,
                                             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​(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
      • publishEvent

        public static boolean publishEvent​(String topic,
                                           Map<String,​Object> argMap)
        Publish the topic with the provided arguments to the global event bus. argMap MUST contain an EventTags.ELEMENT argument that is an MUIElement. the contained MUIElement will be used to determine the event bus to publish to.
        Parameters:
        topic - to broadcast
        argMap - arguments map with a minimum of a changedElement
        Returns:
        true if the event is published correctly, false otherwise