Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "RAP/Custom Widgets"
< RAP
(→RAP-native Custom Widget) |
|||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | There are several ways to create custom widgets for RAP. This article is not a guide on how to create them, but | + | There are several ways to create custom widgets for RAP. This article is not a guide on how to create them, but links to the relevant resources and covers some current issues.<br> |
| − | == SWT-Style | + | == SWT-Style Custom Widgets<br> == |
Those are custom widgets like they are created in SWT. There are two types: Compound widgets and Self-drawing widgets. | Those are custom widgets like they are created in SWT. There are two types: Compound widgets and Self-drawing widgets. | ||
| Line 9: | Line 9: | ||
This guide by the creators of SWT pre-dates RAP, but is still valid for current SWT/RAP versions. The chapters about native-code can be ignored. | This guide by the creators of SWT pre-dates RAP, but is still valid for current SWT/RAP versions. The chapters about native-code can be ignored. | ||
| − | *[http://eclipse.org/rap/developers-guide/devguide.php?topic= | + | *[http://eclipse.org/rap/developers-guide/devguide.php?topic=advanced/custom-widget.html#compound The RAP Developers Guide on Compund and Self-drawing widgets]<br> |
The current RAP developers guide covers some RAP-specific aspects of such custom-widgets. | The current RAP developers guide covers some RAP-specific aspects of such custom-widgets. | ||
| − | + | '''Related Issues''' | |
| − | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=321274 Bug 321274 - Compound Custom Widget Focus | + | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=321274 Bug 321274] - Compound Custom Widget Focus<br> |
| − | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=370328 Bug 370328 - [Canvas] Text has wrong z-index | + | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=370328 Bug 370328] - [Canvas] - Text has wrong z-index<br> |
| − | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=375615 Bug 375615 - [GC] Drawing order of image is not correct | + | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=375615 Bug 375615] - [GC] - Drawing order of image is not correct<br> |
| − | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=370313 Bug 370313 - [Canvas] Tweak canvas performance in IE7/8 | + | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=370313 Bug 370313] - [Canvas] - Tweak canvas performance in IE7/8<br> |
| − | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=361615 Bug 361615 - [Canvas] Implement SWT.NO_BACKGROUND to avoid clearing the canvas rectangle]<br> | + | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=361615 Bug 361615] - [Canvas] - Implement SWT.NO_BACKGROUND to avoid clearing the canvas rectangle<br> |
| + | |||
| + | == Browser-based Custom Widgets == | ||
| + | These widgets use HTML and JavaScript, but are not based on RAP-internals. They can be compatible with SWT applications. | ||
| + | |||
| + | *[http://eclipse.org/rap/developers-guide/devguide.php?topic=advanced/custom-widget.html#browser The RAP Developers Guide on Browser-based Custom Widgets]<br> | ||
| + | |||
| + | The current RAP developers guide gives an overview of the techniques that can be used to create such custom widgets and links to several examples. | ||
| + | |||
| + | '''Related Issues''' | ||
| + | *'''[https://bugs.eclipse.org/bugs/show_bug.cgi?id=375352 Bug 375352] - [Browser] Browser#execute does not work with simple lifecycle'''<br> | ||
| + | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=363811 Bug 363811] - [Browser] certain characters in browser function name crash client<br> | ||
| + | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=374244 Bug 374244] - SWTException during Browser.evaluate() when trying to retrieve size of browser content<br> | ||
| + | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=371132 Bug 371132] - [BrowserFunction] - Support calls to browser function while another browser function is pending<br> | ||
| + | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=371133 Bug 371133] - [Browser] - Support multiple script executions<br> | ||
| + | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=323803 Bug 323803] - [ipad] Browser-widget/iframe broken<br> | ||
| + | |||
| + | == ClientScripting-based Custom Widget == | ||
| + | ClientScripting is an Incubator Projects suitable to create RAP custom widgets. It requires at least RAP 1.5. | ||
| + | |||
| + | *[http://eclipse.org/rap/developers-guide/devguide.php?topic=advanced/custom-widget.html#clientscripting The RAP Developers Guide on ClientScripting-based Custom Widgets]<br> | ||
| + | The current RAP developers guide explaining when ClientScripting is a good solution for creating custom widgets. | ||
| + | *[http://wiki.eclipse.org/RAP/ClientScripting ClientScripting in the RAP Wiki]<br> | ||
| + | Detailed and up-to-date explanation of ClientScripting features. | ||
| + | |||
| + | '''Related Issues''' | ||
| + | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=371089 Bug 371089] - [ClientScripting] - Synchronize user data from server to client<br> | ||
| + | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=371071 Bug 371071] - [ClientScripting] [VerifyEvent] VerifyEvent not fired on programmatic changes<br> | ||
| + | |||
| + | == RAP-native Custom Widget == | ||
| + | Custom widgets based in the internal RAP architecture, like the widgets in the core-framework do. Will not run in an SWT-application. | ||
| + | |||
| + | === RAP 1.x === | ||
| + | |||
| + | *[http://eclipse.org/rap/developers-guide/devguide.php?topic=rwt/custom-widget.html#native The RAP Developers Guide on native Custom Widgets]<br> | ||
| + | |||
| + | The current RAP developers guide only compares it to the alternative methods. | ||
| + | |||
| + | *[http://help.eclipse.org/indigo/topic/org.eclipse.rap.help/help/html/advanced/custom-widget.html The RAP 1.4 Developers Guide on native Custom Widgets]<br> | ||
| + | |||
| + | The RAP 1.4 contains the detailed guide to creating native Custom Widgets. Its based on the older GoogleMaps widget for RAP. Some information may be slightly out of date for RAP 1.5. | ||
| + | |||
| + | '''Related Issues''' | ||
| + | *'''[https://bugs.eclipse.org/bugs/show_bug.cgi?id=379325 Bug 379325] - custom widget "Could not process server response"'''<br> | ||
| + | ''IMPORTANT'': Your qooxdoo class must no longer extend "CanvasLayout" but "org.eclipse.swt.widgets.Composite".! | ||
| + | *[https://bugs.eclipse.org/bugs/show_bug.cgi?id=324434 Bug 324434] - [Client] Define a minimal JavaScript API for custom widgets <br> | ||
| + | |||
| + | === RAP 2.x === | ||
Revision as of 09:23, 24 October 2012
There are several ways to create custom widgets for RAP. This article is not a guide on how to create them, but links to the relevant resources and covers some current issues.
Contents
SWT-Style Custom Widgets
Those are custom widgets like they are created in SWT. There are two types: Compound widgets and Self-drawing widgets.
This guide by the creators of SWT pre-dates RAP, but is still valid for current SWT/RAP versions. The chapters about native-code can be ignored.
The current RAP developers guide covers some RAP-specific aspects of such custom-widgets.
Related Issues
- Bug 321274 - Compound Custom Widget Focus
- Bug 370328 - [Canvas] - Text has wrong z-index
- Bug 375615 - [GC] - Drawing order of image is not correct
- Bug 370313 - [Canvas] - Tweak canvas performance in IE7/8
- Bug 361615 - [Canvas] - Implement SWT.NO_BACKGROUND to avoid clearing the canvas rectangle
Browser-based Custom Widgets
These widgets use HTML and JavaScript, but are not based on RAP-internals. They can be compatible with SWT applications.
The current RAP developers guide gives an overview of the techniques that can be used to create such custom widgets and links to several examples.
Related Issues
- Bug 375352 - [Browser] Browser#execute does not work with simple lifecycle
- Bug 363811 - [Browser] certain characters in browser function name crash client
- Bug 374244 - SWTException during Browser.evaluate() when trying to retrieve size of browser content
- Bug 371132 - [BrowserFunction] - Support calls to browser function while another browser function is pending
- Bug 371133 - [Browser] - Support multiple script executions
- Bug 323803 - [ipad] Browser-widget/iframe broken
ClientScripting-based Custom Widget
ClientScripting is an Incubator Projects suitable to create RAP custom widgets. It requires at least RAP 1.5.
The current RAP developers guide explaining when ClientScripting is a good solution for creating custom widgets.
Detailed and up-to-date explanation of ClientScripting features.
Related Issues
- Bug 371089 - [ClientScripting] - Synchronize user data from server to client
- Bug 371071 - [ClientScripting] [VerifyEvent] VerifyEvent not fired on programmatic changes
RAP-native Custom Widget
Custom widgets based in the internal RAP architecture, like the widgets in the core-framework do. Will not run in an SWT-application.
RAP 1.x
The current RAP developers guide only compares it to the alternative methods.
The RAP 1.4 contains the detailed guide to creating native Custom Widgets. Its based on the older GoogleMaps widget for RAP. Some information may be slightly out of date for RAP 1.5.
Related Issues
- Bug 379325 - custom widget "Could not process server response"
IMPORTANT: Your qooxdoo class must no longer extend "CanvasLayout" but "org.eclipse.swt.widgets.Composite".!
- Bug 324434 - [Client] Define a minimal JavaScript API for custom widgets