Skip to main content

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.

Jump to: navigation, search

Nebula PromptSupport

< Back to Nebula Main Page

Introduction

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.

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:

Textfield xp focused hidden.png

This behavior can be customized with the PromptSupport.setFocusBehavior() 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

Textfield xp focused hidden.png


FocusBehavior.HIGHLIGHT_PROMPT

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 PromptSupport.setFontStyle() method.

SWT.NONE

Textfield xp.png

SWT.ITALIC

Textfield xp italic.png

SWT.BOLD

Textfield xp bold.png

SWT.BOLD | SWT.ITALIC

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 PromptSupport.setForeground()</code method. <code>PromptSupport.setForeground(Color.RED) gives you:

Textfield xp red.png

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

Example

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

This example is also available here : PromptSupportSnippet.java

Copyright © Eclipse Foundation, Inc. All Rights Reserved.