Jump to: navigation, search

Difference between revisions of "Eclipse4/UI/Event/Migration"

m
Line 20: Line 20:
  
 
In essence the string returned by the old
 
In essence the string returned by the old
 
+
<source lang="java">
 
UIEvents.buildTopic(UIEvents.UILabel.TOPIC, UIEvents.UILabel.LABEL)
 
UIEvents.buildTopic(UIEvents.UILabel.TOPIC, UIEvents.UILabel.LABEL)
 
+
</source>
 
is equal to
 
is equal to
 
+
<source lang="java">
 
UIEvents.UILabel.TOPIC_LABEL
 
UIEvents.UILabel.TOPIC_LABEL
 +
</source>
  
 
So a subscribe now looks like:
 
So a subscribe now looks like:
Line 32: Line 33:
 
</source>
 
</source>
  
or you can now use dependency injection
+
or better yet, you can use dependency injection
  
 +
<source lang="java">
 
@Inject @Optional
 
@Inject @Optional
 
private void closeHandler(@UIEventTopic(UIEvents.UILabel.TOPIC_LABEL) Event event) {}
 
private void closeHandler(@UIEventTopic(UIEvents.UILabel.TOPIC_LABEL) Event event) {}
 +
</source>
  
 
== Action Required ==
 
== Action Required ==
  
The three UIEvents.buildTopic() methods and all the UIEvents TOPIC constants have been deprecated in M4 and will be deleted before M5 ships.  If you where using UIEvents.buildTopic(UIEvents.blah.TOPIC) please replace this with direct use of the constant UIEvents.blah.TOPIC_ALL
+
The three  
 +
<source lang="java">
 +
UIEvents.buildTopic()
 +
</source>
 +
methods and all the UIEvents TOPIC constants have been deprecated in M4 and will be deleted before M5 is released.  If you where using a call similar to
 +
<source lang="java">
 +
UIEvents.buildTopic(UIEvents.UILabel.TOPIC)  
 +
</source>
 +
please replace this with direct use of the constant  
 +
<source lang="java">
 +
UIEvents.UILabel.TOPIC_ALL
 +
</source>
  
 
If you where using UIEvents.buildTopic(UIEvents.blah.TOPIC, UIEvents.blah.someAttribute) please repalce this with the direct use of the constant UIEvents.blah.TOPIC_someAttribute
 
If you where using UIEvents.buildTopic(UIEvents.blah.TOPIC, UIEvents.blah.someAttribute) please repalce this with the direct use of the constant UIEvents.blah.TOPIC_someAttribute

Revision as of 16:57, 2 December 2011

Take a look at Eclipse4/RCP/Event Model for a description on the Eclipse UI Event model in general.

Rational for Change

Up until the end of M4 the topic strings used to subscribe to UI events where constructed at run time using the UIEvents.buildTopic() methods like this:

eventBroker.subscribe(UIEvents.buildTopic(UIEvents.UILabel.TOPIC, UIEvents.UILabel.LABEL), handler);

This has the following disadvantages:

  • Long complicated looking code to do simple subscribes
  • Prevents us from using the cleaner @UIEventTopic() dependency injection technique for subscribing to ui events
  • Creating more run time garbage through string concatenation
  • Possibly confusing clients by making them think our eventing model is more complicated than it actually is

Change

New UI Event TOPIC_* constants with fully qualified values where created for making event subscriptions.

In essence the string returned by the old

UIEvents.buildTopic(UIEvents.UILabel.TOPIC, UIEvents.UILabel.LABEL)

is equal to

UIEvents.UILabel.TOPIC_LABEL

So a subscribe now looks like:

eventBroker.subscribe(UIEvents.UILabel.TOPIC_LABEL)

or better yet, you can use dependency injection

@Inject @Optional
private void closeHandler(@UIEventTopic(UIEvents.UILabel.TOPIC_LABEL) Event event) {}

Action Required

The three

UIEvents.buildTopic()

methods and all the UIEvents TOPIC constants have been deprecated in M4 and will be deleted before M5 is released. If you where using a call similar to

UIEvents.buildTopic(UIEvents.UILabel.TOPIC)

please replace this with direct use of the constant

UIEvents.UILabel.TOPIC_ALL

If you where using UIEvents.buildTopic(UIEvents.blah.TOPIC, UIEvents.blah.someAttribute) please repalce this with the direct use of the constant UIEvents.blah.TOPIC_someAttribute

Subscribing to a particular tag change of a particular attribute through the use of UIEvents.buildTopic(UIEvents.blah.TOPIC, UIEvents.blah.someAttribute, UIEvents.someTag) is no longer supported. In practice it turned out this pattern was never used. Typical event handlers are interested in all changes to a given attribute. Some particular change to some particular attribute was too fine grained a filtering for general use and the over all gains of the new strategy where deemed to outweigh the usefulness of this unused pattern.


methods have been deprecated