Google Git
Sign in
eclipse / gerrit / www.eclipse.org / nebula / f998bb2b16354fd59b8a5b5c8f47d9f4a3020c64 / . / releases / 2.4.2 / javadoc / org / eclipse / nebula / widgets / opal / promptsupport / PromptSupport.html
blob: f69b17c0657f33b9c48c5ff3df32feaf3f81e194 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_201) on Thu Jul 23 15:59:02 CEST 2020 -->
<title>PromptSupport</title>
<meta name="date" content="2020-07-23">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PromptSupport";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PromptSupport.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/FocusControlListenerFactory.html" title="class in org.eclipse.nebula.widgets.opal.promptsupport"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.FocusBehavior.html" title="enum in org.eclipse.nebula.widgets.opal.promptsupport"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html" target="_top">Frames</a></li>
<li><a href="PromptSupport.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.nebula.widgets.opal.promptsupport</div>
<h2 title="Class PromptSupport" class="title">Class PromptSupport</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.nebula.widgets.opal.promptsupport.PromptSupport</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">PromptSupport</span>
extends java.lang.Object</pre>
<div class="block">This utility class allows the user to add a prompt to a text or combo
component (see http://designinginterfaces.com/Input_Prompt).<br/>
This class is inspired by work of Peter Weishapl</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.FocusBehavior.html" title="enum in org.eclipse.nebula.widgets.opal.promptsupport">PromptSupport.FocusBehavior</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#BACKGROUND">BACKGROUND</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#BEHAVIOR">BEHAVIOR</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#FOREGROUND">FOREGROUND</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#IS_PROMPT_DISPLAYED">IS_PROMPT_DISPLAYED</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#PROMPT">PROMPT</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#SET">SET</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#STYLE">STYLE</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#PromptSupport--">PromptSupport</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static org.eclipse.swt.graphics.Color</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#getBackground-org.eclipse.swt.widgets.Control-">getBackground</a></span>(org.eclipse.swt.widgets.Control&nbsp;control)</code>
<div class="block">Get the background color of the <code>control</code>, when no text is
present.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.FocusBehavior.html" title="enum in org.eclipse.nebula.widgets.opal.promptsupport">PromptSupport.FocusBehavior</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#getFocusBehavior-org.eclipse.swt.widgets.Control-">getFocusBehavior</a></span>(org.eclipse.swt.widgets.Control&nbsp;control)</code>
<div class="block">Get the <a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.FocusBehavior.html" title="enum in org.eclipse.nebula.widgets.opal.promptsupport"><code>PromptSupport.FocusBehavior</code></a> of <code>control</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#getFontStyle-org.eclipse.swt.widgets.Control-">getFontStyle</a></span>(org.eclipse.swt.widgets.Control&nbsp;control)</code>
<div class="block">Returns the font style of the prompt text, which is a OR mix of
SWT.ITALIC, SWT.NONE or SWT.BOLD</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static org.eclipse.swt.graphics.Color</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#getForeground-org.eclipse.swt.widgets.Control-">getForeground</a></span>(org.eclipse.swt.widgets.Control&nbsp;control)</code>
<div class="block">Get the foreground color of the prompt text.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#getPrompt-org.eclipse.swt.widgets.Control-">getPrompt</a></span>(org.eclipse.swt.widgets.Control&nbsp;control)</code>
<div class="block">Get the prompt text of <code>control</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#init-java.lang.String-org.eclipse.swt.graphics.Color-org.eclipse.swt.graphics.Color-org.eclipse.swt.widgets.Control-">init</a></span>(java.lang.String&nbsp;promptText,
org.eclipse.swt.graphics.Color&nbsp;promptForeground,
org.eclipse.swt.graphics.Color&nbsp;promptBackground,
org.eclipse.swt.widgets.Control&nbsp;control)</code>
<div class="block">
Convenience method to set the <code>promptText</code> and
<code>promptTextColor</code> on a <code>Control</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>(package private) static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#isPromptDisplayed-org.eclipse.swt.widgets.Control-">isPromptDisplayed</a></span>(org.eclipse.swt.widgets.Control&nbsp;control)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#setBackground-org.eclipse.swt.graphics.Color-org.eclipse.swt.widgets.Control-">setBackground</a></span>(org.eclipse.swt.graphics.Color&nbsp;color,
org.eclipse.swt.widgets.Control&nbsp;control)</code>
<div class="block">
Sets the prompts background color on <code>control</code>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#setFocusBehavior-org.eclipse.nebula.widgets.opal.promptsupport.PromptSupport.FocusBehavior-org.eclipse.swt.widgets.Control-">setFocusBehavior</a></span>(<a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.FocusBehavior.html" title="enum in org.eclipse.nebula.widgets.opal.promptsupport">PromptSupport.FocusBehavior</a>&nbsp;focusBehavior,
org.eclipse.swt.widgets.Control&nbsp;control)</code>
<div class="block">Sets the <a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.FocusBehavior.html" title="enum in org.eclipse.nebula.widgets.opal.promptsupport"><code>PromptSupport.FocusBehavior</code></a> on <code>control</code>, if it is the
focus owner.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#setFontStyle-int-org.eclipse.swt.widgets.Control-">setFontStyle</a></span>(int&nbsp;fontStyle,
org.eclipse.swt.widgets.Control&nbsp;control)</code>
<div class="block">
Set the style of the prompt font, which is a OR mix of SWT.ITALIC,
SWT.NONE or SWT.BOLD</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#setForeground-org.eclipse.swt.graphics.Color-org.eclipse.swt.widgets.Control-">setForeground</a></span>(org.eclipse.swt.graphics.Color&nbsp;color,
org.eclipse.swt.widgets.Control&nbsp;control)</code>
<div class="block">Sets the foreground color of the prompt on <code>control</code>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#setPrompt-java.lang.String-org.eclipse.swt.widgets.Control-">setPrompt</a></span>(java.lang.String&nbsp;promptText,
org.eclipse.swt.widgets.Control&nbsp;control)</code>
<div class="block">
Sets the prompt text on <code>control</code></div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>(package private) static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html#setPromptDisplayed-org.eclipse.swt.widgets.Control-boolean-">setPromptDisplayed</a></span>(org.eclipse.swt.widgets.Control&nbsp;control,
boolean&nbsp;newValue)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="BACKGROUND">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BACKGROUND</h4>
<pre>static final&nbsp;java.lang.String BACKGROUND</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.nebula.widgets.opal.promptsupport.PromptSupport.BACKGROUND">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FOREGROUND">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FOREGROUND</h4>
<pre>static final&nbsp;java.lang.String FOREGROUND</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.nebula.widgets.opal.promptsupport.PromptSupport.FOREGROUND">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STYLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STYLE</h4>
<pre>static final&nbsp;java.lang.String STYLE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.nebula.widgets.opal.promptsupport.PromptSupport.STYLE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="BEHAVIOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BEHAVIOR</h4>
<pre>static final&nbsp;java.lang.String BEHAVIOR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.nebula.widgets.opal.promptsupport.PromptSupport.BEHAVIOR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PROMPT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROMPT</h4>
<pre>static final&nbsp;java.lang.String PROMPT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.nebula.widgets.opal.promptsupport.PromptSupport.PROMPT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="SET">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SET</h4>
<pre>static final&nbsp;java.lang.String SET</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.nebula.widgets.opal.promptsupport.PromptSupport.SET">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="IS_PROMPT_DISPLAYED">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IS_PROMPT_DISPLAYED</h4>
<pre>static final&nbsp;java.lang.String IS_PROMPT_DISPLAYED</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.nebula.widgets.opal.promptsupport.PromptSupport.IS_PROMPT_DISPLAYED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PromptSupport--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PromptSupport</h4>
<pre>public&nbsp;PromptSupport()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init-java.lang.String-org.eclipse.swt.graphics.Color-org.eclipse.swt.graphics.Color-org.eclipse.swt.widgets.Control-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public static&nbsp;void&nbsp;init(java.lang.String&nbsp;promptText,
org.eclipse.swt.graphics.Color&nbsp;promptForeground,
org.eclipse.swt.graphics.Color&nbsp;promptBackground,
org.eclipse.swt.widgets.Control&nbsp;control)</pre>
<div class="block"><p>
Convenience method to set the <code>promptText</code> and
<code>promptTextColor</code> on a <code>Control</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>promptText</code> - Prompt Text</dd>
<dd><code>promptForeground</code> - Foreground</dd>
<dd><code>promptBackground</code> - Background</dd>
<dd><code>control</code> - control</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the control is not a Text Box, a
Combo Box, a StyledText or a CCombo</dd>
</dl>
</li>
</ul>
<a name="getBackground-org.eclipse.swt.widgets.Control-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBackground</h4>
<pre>public static&nbsp;org.eclipse.swt.graphics.Color&nbsp;getBackground(org.eclipse.swt.widgets.Control&nbsp;control)</pre>
<div class="block">Get the background color of the <code>control</code>, when no text is
present. If no color has been set, the <code>control</code> background
color will be returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>textComponent</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the the background color of the text component, when no text is
present</dd>
</dl>
</li>
</ul>
<a name="setBackground-org.eclipse.swt.graphics.Color-org.eclipse.swt.widgets.Control-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBackground</h4>
<pre>public static&nbsp;void&nbsp;setBackground(org.eclipse.swt.graphics.Color&nbsp;color,
org.eclipse.swt.widgets.Control&nbsp;control)</pre>
<div class="block"><p>
Sets the prompts background color on <code>control</code>. This
background color will only be used when no text is present.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>background</code> - </dd>
<dd><code>control</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the control is not a Text Box, a
Combo Box, a StyledText or a CCombo</dd>
</dl>
</li>
</ul>
<a name="getFocusBehavior-org.eclipse.swt.widgets.Control-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFocusBehavior</h4>
<pre>public static&nbsp;<a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.FocusBehavior.html" title="enum in org.eclipse.nebula.widgets.opal.promptsupport">PromptSupport.FocusBehavior</a>&nbsp;getFocusBehavior(org.eclipse.swt.widgets.Control&nbsp;control)</pre>
<div class="block">Get the <a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.FocusBehavior.html" title="enum in org.eclipse.nebula.widgets.opal.promptsupport"><code>PromptSupport.FocusBehavior</code></a> of <code>control</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>control</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.FocusBehavior.html" title="enum in org.eclipse.nebula.widgets.opal.promptsupport"><code>PromptSupport.FocusBehavior</code></a> or <a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.FocusBehavior.html#HIDE_PROMPT"><code>PromptSupport.FocusBehavior.HIDE_PROMPT</code></a> if
none is set</dd>
</dl>
</li>
</ul>
<a name="setFocusBehavior-org.eclipse.nebula.widgets.opal.promptsupport.PromptSupport.FocusBehavior-org.eclipse.swt.widgets.Control-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFocusBehavior</h4>
<pre>public static&nbsp;void&nbsp;setFocusBehavior(<a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.FocusBehavior.html" title="enum in org.eclipse.nebula.widgets.opal.promptsupport">PromptSupport.FocusBehavior</a>&nbsp;focusBehavior,
org.eclipse.swt.widgets.Control&nbsp;control)</pre>
<div class="block">Sets the <a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.FocusBehavior.html" title="enum in org.eclipse.nebula.widgets.opal.promptsupport"><code>PromptSupport.FocusBehavior</code></a> on <code>control</code>, if it is the
focus owner.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>focusBehavior</code> - </dd>
<dd><code>control</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the control is not a Text Box, a
Combo Box, a StyledText or a CCombo</dd>
</dl>
</li>
</ul>
<a name="getFontStyle-org.eclipse.swt.widgets.Control-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFontStyle</h4>
<pre>public static&nbsp;int&nbsp;getFontStyle(org.eclipse.swt.widgets.Control&nbsp;control)</pre>
<div class="block">Returns the font style of the prompt text, which is a OR mix of
SWT.ITALIC, SWT.NONE or SWT.BOLD</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>control</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>font style of the prompt text</dd>
</dl>
</li>
</ul>
<a name="setFontStyle-int-org.eclipse.swt.widgets.Control-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFontStyle</h4>
<pre>public static&nbsp;void&nbsp;setFontStyle(int&nbsp;fontStyle,
org.eclipse.swt.widgets.Control&nbsp;control)</pre>
<div class="block"><p>
Set the style of the prompt font, which is a OR mix of SWT.ITALIC,
SWT.NONE or SWT.BOLD
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fontStyle</code> - </dd>
<dd><code>control</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the control is not a Text Box, a
Combo Box, a StyledText or a CCombo</dd>
</dl>
</li>
</ul>
<a name="getForeground-org.eclipse.swt.widgets.Control-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getForeground</h4>
<pre>public static&nbsp;org.eclipse.swt.graphics.Color&nbsp;getForeground(org.eclipse.swt.widgets.Control&nbsp;control)</pre>
<div class="block">Get the foreground color of the prompt text. If no color has been set,
the <code>GREY</code> color will be returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>color</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the color of the prompt text or <code>GREY</code>if none is set</dd>
</dl>
</li>
</ul>
<a name="setForeground-org.eclipse.swt.graphics.Color-org.eclipse.swt.widgets.Control-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForeground</h4>
<pre>public static&nbsp;void&nbsp;setForeground(org.eclipse.swt.graphics.Color&nbsp;color,
org.eclipse.swt.widgets.Control&nbsp;control)</pre>
<div class="block">Sets the foreground color of the prompt on <code>control</code>. This
color will be used when no text is present.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>promptTextColor</code> - </dd>
<dd><code>textComponent</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the control is not a Text Box, a
Combo Box, a StyledText or a CCombo</dd>
</dl>
</li>
</ul>
<a name="getPrompt-org.eclipse.swt.widgets.Control-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrompt</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getPrompt(org.eclipse.swt.widgets.Control&nbsp;control)</pre>
<div class="block">Get the prompt text of <code>control</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>control</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the prompt text</dd>
</dl>
</li>
</ul>
<a name="setPrompt-java.lang.String-org.eclipse.swt.widgets.Control-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPrompt</h4>
<pre>public static&nbsp;void&nbsp;setPrompt(java.lang.String&nbsp;promptText,
org.eclipse.swt.widgets.Control&nbsp;control)</pre>
<div class="block"><p>
Sets the prompt text on <code>control</code>
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>promptText</code> - </dd>
<dd><code>textComponent</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the control is not a Text Box, a
Combo Box, a StyledText or a CCombo</dd>
</dl>
</li>
</ul>
<a name="isPromptDisplayed-org.eclipse.swt.widgets.Control-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPromptDisplayed</h4>
<pre>static&nbsp;boolean&nbsp;isPromptDisplayed(org.eclipse.swt.widgets.Control&nbsp;control)</pre>
</li>
</ul>
<a name="setPromptDisplayed-org.eclipse.swt.widgets.Control-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setPromptDisplayed</h4>
<pre>static&nbsp;void&nbsp;setPromptDisplayed(org.eclipse.swt.widgets.Control&nbsp;control,
boolean&nbsp;newValue)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PromptSupport.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/FocusControlListenerFactory.html" title="class in org.eclipse.nebula.widgets.opal.promptsupport"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.FocusBehavior.html" title="enum in org.eclipse.nebula.widgets.opal.promptsupport"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/nebula/widgets/opal/promptsupport/PromptSupport.html" target="_top">Frames</a></li>
<li><a href="PromptSupport.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>