View source for Nebula PromptSupport

[[Nebula|< Back to Nebula Main Page]]

==Introduction==

[[File:PromptSupport.png]]

See http://designinginterfaces.com/Input_Prompt for a description of the Input Prompt pattern or https://msdn.microsoft.com/en-us/library/dn742442.aspx for guidelines of how to use prompts in Windows Vista.

This work is inpired by the project XSwingX (http://code.google.com/p/xswingx/) by Peter Weishapl.

__TOC__

==Usage==

===Add a Prompt to Your Existing Text Component===

Just invoke

 PromptSupport.setPrompt("Prompt Text", control);

Where control is an instance of a Text, a StyledText, a Combo or a CCombo widget.

===Customize the Prompt===
====Focus Behavior====

By default, the prompt text will be hidden, when the text component is focused: 

[[File:Textfield_xp_focused_hidden.png]]

This behavior can be customized with the <code>PromptSupport.setFocusBehavior()</code> method. 
The prompt text can be hidden or highlighted when the widget gets the focus (and no text is entered), as indicated in the screenshots below.

'''FocusBehavior.HIDE_PROMPT'''

[[File:Textfield_xp_focused_hidden.png]]


'''FocusBehavior.HIGHLIGHT_PROMPT'''

[[File:Textfield_xp_focused_highlighted.png]]

===Font Style and Color===

The font of the prompt text by default is the same as the text component's font, but sometimes you want the prompt text to be different. You can make the prompt text plain, bold, italic, or both bold and italic with the <code>PromptSupport.setFontStyle()</code> method.

<code>SWT.NONE</code>

[[File:Textfield_xp.png]]

<code>SWT.ITALIC</code>

[[File:Textfield_xp_italic.png]]

<code>SWT.BOLD</code>

[[File:Textfield_xp_bold.png]]

<code>SWT.BOLD | SWT.ITALIC</code>

[[File:Textfield_xp_bolditalic.png]]

By default, the color used for the prompt text is the text component's disabled text color, but yout can change this with the <code>PromptSupport.setForeground()</code method. 
<code>PromptSupport.setForeground(Color.RED)</code> gives you: 

[[File:Textfield_xp_red.png]]

You can also set a background color for the promp by calling <code>PromptSupport.setBackground()</code>.

==Example==

An example called PromptSupportSnippet.java is located in the plugin '''org.eclipse.nebula.widgets.opal.promptsupport.snippets'''.

This example is also available here : [https://github.com/eclipse/nebula/blob/master/widgets/opal/promptsupport/org.eclipse.nebula.widgets.opal.promptsupport.snippets/src/org/eclipse/nebula/widgets/opal/promptsupport/snippets/PromptSupportSnippet.java PromptSupportSnippet.java]