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/AdapterRegistry"
(New page: = Overview = The <code>rwt.protocol.AdapterRegistry</code> object stores all protocol adapters known to the client. A protocol adapter is needed by the clients message processor for all t...) |
|||
| Line 1: | Line 1: | ||
= Overview = | = Overview = | ||
| − | The <code>rwt.protocol.AdapterRegistry</code> object stores all protocol adapters known to the client. A protocol adapter is needed by the clients message processor for all types of targets used in a given [[RAP/Protocol#Protocol_Format|RAP protocol message]]. It basically translates the API of the 'virtual' object referenced by the protocol message to the API of the actual client object. If a message contains a [[RAP/Protocol#Create|create operation]] for an unkown type (no matching adapter registered), the client will crash. | + | The <code>rwt.protocol.AdapterRegistry</code> object stores all protocol adapters known to the client. A protocol adapter is needed by the clients message processor for all types of targets used in a given [[RAP/Protocol#Protocol_Format|RAP protocol message]]. It basically translates the API of the [[RAP/WebClient#Communication|'virtual' object]] referenced by the protocol message to the API of the actual client object. If a message contains a [[RAP/Protocol#Create|create operation]] for an unkown type (no matching adapter registered), the client will crash. |
| + | |||
| + | ''Note: The follwing describes only the API required to write additional widgets. Any undocumented functions and features should '''never''' be used outside the web client core.'' | ||
{| align="left" width="100%" height="73" cellspacing="0" cellpadding="3" border="1" style="margin: auto auto 1em auto;" | {| align="left" width="100%" height="73" cellspacing="0" cellpadding="3" border="1" style="margin: auto auto 1em auto;" | ||
| Line 10: | Line 12: | ||
| <code><b>add( string key, Adapter adapter )</b></code><br> stores the given adapter. The key has to match the type string used in a RAP protocol [[RAP/Protocol#Create|create operation]]. | | <code><b>add( string key, Adapter adapter )</b></code><br> stores the given adapter. The key has to match the type string used in a RAP protocol [[RAP/Protocol#Create|create operation]]. | ||
|} | |} | ||
| + | |||
| + | |||
| + | = Adapter API = | ||
| + | |||
| + | An adapter is a plain JavaScript object that has to implement a specific API. Some of it is optional, as the processer will fall back on a default behavior when missing. However, if that default behavior is not supported by the actual client object | ||
Revision as of 12:03, 24 October 2012
Overview
The rwt.protocol.AdapterRegistry object stores all protocol adapters known to the client. A protocol adapter is needed by the clients message processor for all types of targets used in a given RAP protocol message. It basically translates the API of the 'virtual' object referenced by the protocol message to the API of the actual client object. If a message contains a create operation for an unkown type (no matching adapter registered), the client will crash.
Note: The follwing describes only the API required to write additional widgets. Any undocumented functions and features should never be used outside the web client core.
| Function Summary | |
|---|---|
undefined
|
add( string key, Adapter adapter )stores the given adapter. The key has to match the type string used in a RAP protocol create operation. |
Adapter API
An adapter is a plain JavaScript object that has to implement a specific API. Some of it is optional, as the processer will fall back on a default behavior when missing. However, if that default behavior is not supported by the actual client object