| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=utf-8" /> |
| <meta name="generator" content="JsDoc Toolkit" /> |
| |
| <title>JsDoc Reference - Event</title> |
| |
| <style type="text/css"> |
| /* default.css */ |
| body |
| { |
| font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; |
| width: 800px; |
| } |
| |
| .header |
| { |
| clear: both; |
| background-color: #ccc; |
| padding: 8px; |
| } |
| |
| h1 |
| { |
| font-size: 150%; |
| font-weight: bold; |
| padding: 0; |
| margin: 1em 0 0 .3em; |
| } |
| |
| hr |
| { |
| border: none 0; |
| border-top: 1px solid #7F8FB1; |
| height: 1px; |
| } |
| |
| pre.code |
| { |
| display: block; |
| padding: 8px; |
| border: 1px dashed #ccc; |
| } |
| |
| #index |
| { |
| margin-top: 24px; |
| float: left; |
| width: 160px; |
| position: absolute; |
| left: 8px; |
| background-color: #F3F3F3; |
| padding: 8px; |
| } |
| |
| #content |
| { |
| margin-left: 190px; |
| width: 600px; |
| } |
| |
| .classList |
| { |
| list-style-type: none; |
| padding: 0; |
| margin: 0 0 0 8px; |
| font-family: arial, sans-serif; |
| font-size: 1em; |
| overflow: auto; |
| } |
| |
| .classList li |
| { |
| padding: 0; |
| margin: 0 0 8px 0; |
| } |
| |
| .summaryTable { width: 100%; } |
| |
| h1.classTitle |
| { |
| font-size:170%; |
| line-height:130%; |
| } |
| |
| h2 { font-size: 110%; } |
| caption, div.sectionTitle |
| { |
| background-color: #7F8FB1; |
| color: #fff; |
| font-size:130%; |
| text-align: left; |
| padding: 2px 6px 2px 6px; |
| border: 1px #7F8FB1 solid; |
| } |
| |
| div.sectionTitle { margin-bottom: 8px; } |
| .summaryTable thead { display: none; } |
| |
| .summaryTable td |
| { |
| vertical-align: top; |
| padding: 4px; |
| border-bottom: 1px #7F8FB1 solid; |
| border-right: 1px #7F8FB1 solid; |
| } |
| |
| /*col#summaryAttributes {}*/ |
| .summaryTable td.attributes |
| { |
| border-left: 1px #7F8FB1 solid; |
| width: 140px; |
| text-align: right; |
| } |
| |
| td.attributes, .fixedFont |
| { |
| line-height: 15px; |
| color: #002EBE; |
| font-family: "Courier New",Courier,monospace; |
| font-size: 13px; |
| } |
| |
| .summaryTable td.nameDescription |
| { |
| text-align: left; |
| font-size: 13px; |
| line-height: 15px; |
| } |
| |
| .summaryTable td.nameDescription, .description |
| { |
| line-height: 15px; |
| padding: 4px; |
| padding-left: 4px; |
| } |
| |
| .summaryTable { margin-bottom: 8px; } |
| |
| ul.inheritsList |
| { |
| list-style: square; |
| margin-left: 20px; |
| padding-left: 0; |
| } |
| |
| .detailList { |
| margin-left: 20px; |
| line-height: 15px; |
| } |
| .detailList dt { margin-left: 20px; } |
| |
| .detailList .heading |
| { |
| font-weight: bold; |
| padding-bottom: 6px; |
| margin-left: 0; |
| } |
| |
| .light, td.attributes, .light a:link, .light a:visited |
| { |
| color: #777; |
| font-style: italic; |
| } |
| |
| .fineprint |
| { |
| text-align: right; |
| font-size: 10px; |
| } |
| </style> |
| </head> |
| |
| <body> |
| <!-- ============================== header ================================= --> |
| <!-- begin static/header.html --> |
| <div id="header"> |
| </div> |
| <!-- end static/header.html --> |
| |
| <!-- ============================== classes index ============================ --> |
| <div id="index"> |
| <!-- begin publish.classesIndex --> |
| <div align="center"><a href="../index.html">Index</a></div> |
| <hr /> |
| <h2>Global Objects</h2> |
| <ul class="classList"> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| <li><a href="../symbols/rap.html">rap</a></li> |
| |
| <li><a href="../symbols/SWT.html">SWT</a></li> |
| |
| </ul> |
| <h2>Types</h2> |
| <ul class="classList"> |
| |
| <li><a href="../symbols/%24.html">$</a></li> |
| |
| <li><a href="../symbols/Button.html">Button</a></li> |
| |
| <li><a href="../symbols/Canvas.html">Canvas</a></li> |
| |
| <li><a href="../symbols/Client.html">Client</a></li> |
| |
| <li><a href="../symbols/Combo.html">Combo</a></li> |
| |
| <li><a href="../symbols/Composite.html">Composite</a></li> |
| |
| <li><a href="../symbols/Control.html">Control</a></li> |
| |
| <li><a href="../symbols/Event.html">Event</a></li> |
| |
| <li><a href="../symbols/Label.html">Label</a></li> |
| |
| <li><a href="../symbols/ProgressBar.html">ProgressBar</a></li> |
| |
| <li><a href="../symbols/RemoteObject.html">RemoteObject</a></li> |
| |
| <li><a href="../symbols/Scale.html">Scale</a></li> |
| |
| <li><a href="../symbols/ScrolledComposite.html">ScrolledComposite</a></li> |
| |
| <li><a href="../symbols/Slider.html">Slider</a></li> |
| |
| <li><a href="../symbols/Spinner.html">Spinner</a></li> |
| |
| <li><a href="../symbols/Text.html">Text</a></li> |
| |
| <li><a href="../symbols/Widget.html">Widget</a></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| </ul> |
| <hr /> |
| <!-- end publish.classesIndex --> |
| </div> |
| |
| <div id="content"> |
| <!-- ============================== class title ============================ --> |
| <h1 class="classTitle"> |
| |
| Type Event |
| </h1> |
| |
| <!-- ============================== class summary ========================== --> |
| <p class="description"> |
| |
| |
| |
| RWT Scripting analoge to org.eclipse.swt.widgets.Event |
| |
| </p> |
| |
| <!-- ============================== constructor summary ==================== --> |
| |
| |
| <!-- ============================== properties summary ===================== --> |
| |
| |
| |
| <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class Event."> |
| <caption>Field Summary</caption> |
| <thead> |
| <tr> |
| <th scope="col">Field Attributes</th> |
| <th scope="col">Field Name and Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Event.html#button">button</a></b> |
| </div> |
| <div class="description">the button that was pressed or released; 1 for the first button, 2 for the |
| second button, and 3 for the third button, etc.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Event.html#character">character</a></b> |
| </div> |
| <div class="description">depending on the event, the character represented by the key that was |
| typed.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Event.html#doit">doit</a></b> |
| </div> |
| <div class="description">depending on the event, a flag indicating whether the operation should be |
| allowed.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Event.html#gc">gc</a></b> |
| </div> |
| <div class="description">the graphics context to use when painting.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Event.html#keyCode">keyCode</a></b> |
| </div> |
| <div class="description">depending on the event, the key code of the key that was typed, as defined |
| by the key code constants in class <code>SWT</code>.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Event.html#start">start</a></b> |
| </div> |
| <div class="description">depending on the event, the range of text being modified.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Event.html#stateMask">stateMask</a></b> |
| </div> |
| <div class="description">depending on the event, the state of the keyboard modifier keys and mouse |
| masks at the time the event was generated.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Event.html#text">text</a></b> |
| </div> |
| <div class="description">depending on the event, the new text that will be inserted.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Event.html#type">type</a></b> |
| </div> |
| <div class="description">the type of event, as defined by the event type constants in the <a href="../symbols/SWT.html">SWT</a> object.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Event.html#widget">widget</a></b> |
| </div> |
| <div class="description">an object representing the widget that issued the event.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Event.html#x">x</a></b> |
| </div> |
| <div class="description">x coordinate of the pointer at the time of the event |
| |
| Set for MouseDown, MouseUp, MouseMove, MouseEvnet, MouseExit and MouseDoubleClick.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"> |
| <b><a href="../symbols/Event.html#y">y</a></b> |
| </div> |
| <div class="description">y coordinate of the pointer at the time of the event |
| |
| Set for MouseDown, MouseUp, MouseMove, MouseEvnet, MouseExit and MouseDoubleClick.</div> |
| </td> |
| </tr> |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| |
| <!-- ============================== methods summary ======================== --> |
| |
| <!-- ============================== events summary ======================== --> |
| |
| |
| <!-- ============================== constructor details ==================== --> |
| |
| <div class="details"><a name="constructor"> </a> |
| <div class="sectionTitle"> |
| Type Detail |
| </div> |
| |
| <div class="fixedFont"><private> |
| <b>Event</b>(eventType, originalTarget, originalEvent) |
| </div> |
| |
| <div class="description"> |
| Objects of this type are given to the handleEvent function (JavaScript) of |
| org.eclipse.rap.rwt.scripting.ClientListener (Java) instances. |
| |
| </div> |
| |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">Parameters:</dt> |
| |
| <dt> |
| <b>eventType</b> |
| |
| </dt> |
| <dd></dd> |
| |
| <dt> |
| <b>originalTarget</b> |
| |
| </dt> |
| <dd></dd> |
| |
| <dt> |
| <b>originalEvent</b> |
| |
| </dt> |
| <dd></dd> |
| |
| </dl> |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">Since:</dt> |
| <dd>2.2</dd> |
| </dl> |
| |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">See:</dt> |
| |
| <dd><a href="../symbols/SWT.html">SWT</a></dd> |
| |
| </dl> |
| |
| |
| </div> |
| |
| |
| <!-- ============================== field details ========================== --> |
| |
| <div class="sectionTitle"> |
| Field Detail |
| </div> |
| |
| <a name="button"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>button</b> |
| |
| </div> |
| <div class="description"> |
| the button that was pressed or released; 1 for the first button, 2 for the |
| second button, and 3 for the third button, etc. |
| |
| Set for MouseDown, MouseUp, MouseMove, MouseEvnet, MouseExit and MouseDoubleClick. |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="character"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>character</b> |
| |
| </div> |
| <div class="description"> |
| depending on the event, the character represented by the key that was |
| typed. This is the final character that results after all modifiers have |
| been applied. For non-printable keys (like arrow-keys) this field is not set. |
| Changing its value has no effect. |
| |
| Set for KeyDown, KeyUp and Verify. |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="doit"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>doit</b> |
| |
| </div> |
| <div class="description"> |
| depending on the event, a flag indicating whether the operation should be |
| allowed. Setting this field to false will cancel the operation. |
| |
| Effective on KeyDown, KeyUp and Verify. |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="gc"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>gc</b> |
| |
| </div> |
| <div class="description"> |
| the graphics context to use when painting. |
| <p> |
| It supports a subset of the <a href="http://www.w3.org/TR/2dcontext/">HTML5 Canvas API</a>. |
| </p> |
| Fields: |
| <ul> |
| <li>strokeStyle</li> |
| <li>fillStyle</li> |
| <li>lineWidth</li> |
| <li>lineJoin</li> |
| <li>lineCap</li> |
| <li>miterLimit</li> |
| <li>globalAlpha</li> |
| </ul> |
| Methods: |
| <ul> |
| <li>save</li> |
| <li>restore</li> |
| <li>beginPath</li> |
| <li>closePath</li> |
| <li>clearRect (Limitation: in IE 7/8 arguments are ignored, the entire canvas is cleared)</li> |
| <li>stroke</li> |
| <li>fill</li> |
| <li>moveTo</li> |
| <li>lineTo</li> |
| <li>quadraticCurveTo</li> |
| <li>bezierCurveTo</li> |
| <li>rect</li> |
| <li>arc</li> |
| <li>drawImage</li> |
| <li>createLinearGradient (Limitations: In IE 7/8, the gradient can be only be drawn either |
| vertically or horizontally. Calls to "addColorStop" must be in the |
| order of the offsets and can not overwrite previous colorsStops)</li> |
| </ul> |
| |
| More methods are supported on modern browser, but for IE 7/8 these are all. |
| |
| Set on Paint. |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="keyCode"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>keyCode</b> |
| |
| </div> |
| <div class="description"> |
| depending on the event, the key code of the key that was typed, as defined |
| by the key code constants in class <code>SWT</code>. When the character |
| field of the event is ambiguous, this field contains the unaffected value |
| of the original character. For example, typing Shift+M or M result in different |
| characters ( 'M' and 'm' ), but the same keyCode (109, character code for 'm'). |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="start"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>start</b> |
| |
| </div> |
| <div class="description"> |
| depending on the event, the range of text being modified. Setting these |
| fields has no effect. |
| |
| Set for Verify. |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="stateMask"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>stateMask</b> |
| |
| </div> |
| <div class="description"> |
| depending on the event, the state of the keyboard modifier keys and mouse |
| masks at the time the event was generated. |
| |
| Set for KeyDown, KeyUp, MouseDown, MouseUp, MouseMove, MouseEvnet, MouseExit and MouseDoubleClick. |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="text"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>text</b> |
| |
| </div> |
| <div class="description"> |
| depending on the event, the new text that will be inserted. |
| Setting this field will change the text that is about to |
| be inserted or deleted. |
| |
| Set for Verify. |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="type"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>type</b> |
| |
| </div> |
| <div class="description"> |
| the type of event, as defined by the event type constants in the <a href="../symbols/SWT.html">SWT</a> object. |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="widget"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>widget</b> |
| |
| </div> |
| <div class="description"> |
| an object representing the widget that issued the event. |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">See:</dt> |
| |
| <dd><a href="../symbols/rap.html#.getObject">rap.getObject</a></dd> |
| |
| </dl> |
| |
| |
| |
| <hr /> |
| |
| <a name="x"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>x</b> |
| |
| </div> |
| <div class="description"> |
| x coordinate of the pointer at the time of the event |
| |
| Set for MouseDown, MouseUp, MouseMove, MouseEvnet, MouseExit and MouseDoubleClick. |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="y"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>y</b> |
| |
| </div> |
| <div class="description"> |
| y coordinate of the pointer at the time of the event |
| |
| Set for MouseDown, MouseUp, MouseMove, MouseEvnet, MouseExit and MouseDoubleClick. |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <!-- ============================== method details ========================= --> |
| |
| |
| <!-- ============================== event details ========================= --> |
| |
| |
| <hr /> |
| </div> |
| |
| |
| <!-- ============================== footer ================================= --> |
| <div class="fineprint" style="clear:both"> |
| Copyright (c) EclipseSource and others 2013, 2021. All rights reserved. |
| </div> |
| </body> |
| </html> |
