Skip to main content
Jump to: navigation, search

RAP/Custom Widgets FAQ

Revision as of 05:04, 15 August 2013 by (Talk | contribs) (Where can I find a Tutorial)


What is this about?

This is an FAQ about HTML/RemoteObject based custom widget development for RAP 2.x (WebClient). For other kinds of custom widgets, see RAP/Custom_Widgets and here

How is Custom Widget Development different in RAP 2.x?

Compared to RAP 1.x:

  • Custom widgets no longer need an LCA.
  • Custom widgets no longer have to work with unstable internal client API.
  • Custom widgets no longer extend existing client widgets.
  • Custom widgets now use RemoteObjects to communicate between client and server.
  • Custom widgets now have a stable API to built on.
  • Custom widgets now are only rendered based on HTML/DOM/CSS that is attached to a Composite.

Where can I find a Tutorial?

There is no tutorial yet. For now there are the following resources:

How is this related to ClientScript/RWT Scripting?

Short answer: This approach does not involve ClientListener, and RWT Scripting does not invlolve HTML or RemoteObjects.

RWT Scripting (formerly known as ClientScripting) is the practice of attaching a piece of JavaScript ("ClientListener") to an existing widget and react to events that it fires. The "widget" object used in RWT Scripting (which can be obtained from the event object or from rap.getObject) are not the internal client widget, but a wrapper with SWT-like API that allows savely interacting with the widget on the client. These wrapper can not be destroyed or created on the client.

It is possible to create custom widgets using the SWT/compound approach and enhance them with RWT Scripting, but this is not what this FAQ is about.

What the two have in common is the Composite client object type. Like any other widget obtained on the client it is a wrapper with SWT-like API, but also some exclusive methods (append, getClientArea, addListener, removeListener) which allow creating custom widgets.

How do I port my RAP 1.x Custom Widget to RAP 2.x?

Either you use the new API, in which case your widget is future-proof, but you will have to rewrite most or all of your code. Or you continue to use LCAs and client internal, in which case you will have to read the client code to figure out what changed, and the widget will not be future-proof.

Obviously we recommend to use the new API, but it is strongly discouraged to somehow mix the two approaches.

What is the basic architecture of a Custom Widget?

  • The ResourceManager (or the ApplicationConfiguration are used to register all resourcse required on the client
  • The JavaScriptLoader is used to load the required scripts.
  • An HTML/JavaScript based widget/component/application that can be attached anywhere in the DOM
  • A typeHandler that registers a new RAP protocol type and creates an instance of the above JavaScript component
  • A java class that extends Composite and creates a RemoteObject of the type that was registered by the typeHandler.
  • The server widget needs to set it's own id as a parent on the RemoteObject (e.g. remoteObject.set( "parent", WidgetUtil.getId( this ) );)
  • The client widget needs to attach itself to the composite, for example in the factory like this:
    var parent = rap.getObject( properties.parent );
var element = document.createElement( "div" ); parent.append( this.element );
  • To sent changes to the server, the client widget can use it's own RemoteObject: rap.getRemoteObject( clientWidget ).set( "prop", value );
  • The client widget can listen to resize events on the parent composite to layout itself.
  • When destroyed the client widget must remove itself from the parent composite and de-register all listeners from the composite or "rap" object.



Back to the top