Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Riena Migrating to 2.0 from 1.2
Contents
- 1 Introduction
- 2 Incompatibilities
- 2.1 ITextRidget - Removed getAlignment() and setAlignment(int) methods
- 2.2 SimpleNavigationNodeProvider - Removed register methods
- 2.3 INavigationNodeView without controller as generic argument
- 2.4 SubModuleController & IWindowRidget - Removed getDefaultButton() and setDefaultButton(...) methods
- 2.5 SwtApplication getBundle()
- 3 Adopting 2.0 mechanisms and API
- 4 None-API Changes
Introduction
Explains how to migrate to Riena 2.0 from 1.2.
While every effort was made to avoid breakage, there are a few areas of incompatibility or new APIs that should be adopted by clients. This page describes those areas and provides migration instructions.
Incompatibilities
ITextRidget - Removed getAlignment() and setAlignment(int) methods
SWT does not support changing the alignment after creating a Text widget. In 1.2 all occurrences of these methods have intentionally thrown an UnsupportedOperationException. These methods have been removed in 2.0. (bug 239979)
The following methods have been removed:
- register(ISubApplicationNodeExtension, INavigationAssembler assembler)
- register(IModuleGroupNodeExtension, INavigationAssembler assembler)
- register(IModuleNodeExtension, INavigationAssembler assembler)
- register(ISubModuleNodeExtension, INavigationAssembler assembler)
In the old implementation of SimpleNavigationNodeProvider these methods do nothing.
INavigationNodeView does not longer needs a controller as generic argument (but still a INavigationNode). The information about the controller was never used. (bug 288045)
So all sub classes of INavigationNodeView (e.g. SubModuleView) are a little bit simpler.
Old implementation of INavigationNodeView (or SubModuleView) can simply remove the generic argument of the controller.
SubModuleController & IWindowRidget - Removed getDefaultButton() and setDefaultButton(...) methods
The above methods have been removed. They did not work consistently and did support only a single default button. Use SubModuleController.addDefaultAction(IRidget focusRidget, IActionRidget action) instead. For an example showing how to use this new API refer to DefaultButtonSubModule{View,Controller}. (bug 291708)
SwtApplication getBundle()
Any subclass of SwtApplication needed to implement the abstract method getBundle(). However that method was never called. We have removed that method from the class. Leaving your code is no problem, but is also no benefit.
Adopting 2.0 mechanisms and API
TBD
None-API Changes
The generating of the hash code of the class NavigationNode has changed. The property label is not longer used for the generation. So the only important property is the nodeId.
Corresponding to this the equals method also ignores the property label.
Because of that ensure that every node has a NavigationNodeId.