| <!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 - Control</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><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/Button.html">Button</a></li> |
| |
| <li><a href="../symbols/Canvas.html">Canvas</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/RemoteObject.html">RemoteObject</a></li> |
| |
| <li><a href="../symbols/Text.html">Text</a></li> |
| |
| <li></li> |
| |
| <li></li> |
| |
| </ul> |
| <hr /> |
| <!-- end publish.classesIndex --> |
| </div> |
| |
| <div id="content"> |
| <!-- ============================== class title ============================ --> |
| <h1 class="classTitle"> |
| |
| Type Control |
| </h1> |
| |
| <!-- ============================== class summary ========================== --> |
| <p class="description"> |
| |
| |
| |
| RWT Scripting analoge to org.eclipse.swt.widgets.Control |
| |
| </p> |
| |
| <!-- ============================== constructor summary ==================== --> |
| |
| <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Control."> |
| <caption>Type Summary</caption> |
| <thead> |
| <tr> |
| <th scope="col">Constructor Attributes</th> |
| <th scope="col">Constructor Name and Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription" > |
| <div class="fixedFont"> |
| <b><a href="../symbols/Control.html#constructor">Control</a></b>() |
| </div> |
| <div class="description">The constructor is not public.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <!-- ============================== properties summary ===================== --> |
| |
| |
| <!-- ============================== methods summary ======================== --> |
| |
| |
| |
| <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Control."> |
| <caption>Method Summary</caption> |
| <thead> |
| <tr> |
| <th scope="col">Method Attributes</th> |
| <th scope="col">Method Name and Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"><b><a href="../symbols/Control.html#forceFocus">forceFocus</a></b>() |
| </div> |
| <div class="description">Forces the receiver to have the <em>keyboard focus</em>, causing |
| all keyboard events to be delivered to it.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"><b><a href="../symbols/Control.html#getData">getData</a></b>(property) |
| </div> |
| <div class="description">Returns the application defined property of the receiver |
| with the specified name, or null if it has not been set.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"><b><a href="../symbols/Control.html#setBackground">setBackground</a></b>(color) |
| </div> |
| <div class="description">Sets the receiver's background color to the color specified |
| by the argument, or to the default system color for the control |
| if the argument is null.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"><b><a href="../symbols/Control.html#setData">setData</a></b>(property, value) |
| </div> |
| <div class="description">Sets the application defined property of the receiver |
| with the specified name to the given value.</div> |
| </td> |
| </tr> |
| |
| <tr> |
| <td class="attributes"> </td> |
| <td class="nameDescription"> |
| <div class="fixedFont"><b><a href="../symbols/Control.html#setForeground">setForeground</a></b>(color) |
| </div> |
| <div class="description">Sets the receiver's foreground color to the color specified |
| by the argument, or to the default system color for the control |
| if the argument is null.</div> |
| </td> |
| </tr> |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <!-- ============================== events summary ======================== --> |
| |
| |
| <!-- ============================== constructor details ==================== --> |
| |
| <div class="details"><a name="constructor"> </a> |
| <div class="sectionTitle"> |
| Type Detail |
| </div> |
| |
| <div class="fixedFont"> |
| <b>Control</b>() |
| </div> |
| |
| <div class="description"> |
| The constructor is not public. |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">Since:</dt> |
| <dd>2.2</dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| <!-- ============================== field details ========================== --> |
| |
| |
| <!-- ============================== method details ========================= --> |
| |
| <div class="sectionTitle"> |
| Method Detail |
| </div> |
| |
| <a name="forceFocus"> </a> |
| <div class="fixedFont"> |
| |
| <span class="light">{boolean}</span> |
| <b>forceFocus</b>() |
| |
| </div> |
| <div class="description"> |
| Forces the receiver to have the <em>keyboard focus</em>, causing |
| all keyboard events to be delivered to it. |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">Returns:</dt> |
| |
| <dd><span class="light fixedFont">{boolean}</span> <code>true</code> if the control got focus, and <code>false</code> if it was unable to.</dd> |
| |
| </dl> |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="getData"> </a> |
| <div class="fixedFont"> |
| |
| <span class="light">{var}</span> |
| <b>getData</b>(property) |
| |
| </div> |
| <div class="description"> |
| Returns the application defined property of the receiver |
| with the specified name, or null if it has not been set. |
| <p> |
| The java widget properties can be accessed if the |
| property name was registered with WidgetUtil.registerDataKeys. |
| </p> |
| |
| |
| </div> |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">Parameters:</dt> |
| |
| <dt> |
| <span class="light fixedFont">{string}</span> <b>property</b> |
| |
| </dt> |
| <dd>the name of the property</dd> |
| |
| </dl> |
| |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">Returns:</dt> |
| |
| <dd><span class="light fixedFont">{var}</span> the value</dd> |
| |
| </dl> |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">See:</dt> |
| |
| <dd><a href="../symbols/Control.html#setData">Control#setData</a></dd> |
| |
| </dl> |
| |
| |
| <hr /> |
| |
| <a name="setBackground"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>setBackground</b>(color) |
| |
| </div> |
| <div class="description"> |
| Sets the receiver's background color to the color specified |
| by the argument, or to the default system color for the control |
| if the argument is null. |
| |
| |
| </div> |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">Parameters:</dt> |
| |
| <dt> |
| <span class="light fixedFont">{int[]|null}</span> <b>color</b> |
| |
| </dt> |
| <dd>the new color as array [ red, green, blue ] or null</dd> |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <hr /> |
| |
| <a name="setData"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>setData</b>(property, value) |
| |
| </div> |
| <div class="description"> |
| Sets the application defined property of the receiver |
| with the specified name to the given value. |
| <p> |
| The java widget is not affected by this method, but can itself set this object's |
| properties if the name was registered with WidgetUtil.registerDataKeys. |
| </p> |
| |
| |
| </div> |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">Parameters:</dt> |
| |
| <dt> |
| <span class="light fixedFont">{string}</span> <b>property</b> |
| |
| </dt> |
| <dd>the name of the property</dd> |
| |
| <dt> |
| <span class="light fixedFont">{var}</span> <b>value</b> |
| |
| </dt> |
| <dd>the new value for the property</dd> |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">See:</dt> |
| |
| <dd><a href="../symbols/Control.html#getData">Control#getData</a></dd> |
| |
| </dl> |
| |
| |
| <hr /> |
| |
| <a name="setForeground"> </a> |
| <div class="fixedFont"> |
| |
| |
| <b>setForeground</b>(color) |
| |
| </div> |
| <div class="description"> |
| Sets the receiver's foreground color to the color specified |
| by the argument, or to the default system color for the control |
| if the argument is null. |
| |
| |
| </div> |
| |
| |
| |
| |
| <dl class="detailList"> |
| <dt class="heading">Parameters:</dt> |
| |
| <dt> |
| <span class="light fixedFont">{int[]|null}</span> <b>color</b> |
| |
| </dt> |
| <dd>the new color as array [ red, green, blue ] or null</dd> |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <!-- ============================== event details ========================= --> |
| |
| |
| <hr /> |
| </div> |
| |
| |
| <!-- ============================== footer ================================= --> |
| <div class="fineprint" style="clear:both"> |
| Copyright (c) EclipseSource and others 2013. All rights reserved. |
| </div> |
| </body> |
| </html> |
