org.eclipse.xtext.ui.util

Class DontAskAgainDialogs

java.lang.Object

org.eclipse.xtext.ui.util.DontAskAgainDialogs

public class DontAskAgainDialogs
extends Object

A utility class to ask use questions and remember his decision.
The settings a stored in IDialogSettings of your language UIPlugin.

Since:

2.8

Author:

Dennis Huebner - Initial contribution and API

Field Summary

Fields

Modifier and Type	Field and Description
static String	DONT_ASK_AGAIN_DIALOG_PREFIX A section id that holds the "don't ask me again" dialog settings.

Constructor Summary

Constructors

Constructor and Description
DontAskAgainDialogs()

Method Summary

Methods

Modifier and Type	Method and Description
int	askUser(String question, String dialogTitle, String storeKey, org.eclipse.swt.widgets.Shell shell) Opens a MessageDialogWithToggle and stores the answer, if use activate the corresponding checkbox.
void	forgetAllUserDecisions() Rewrites the DONT_ASK_AGAIN_DIALOG_PREFIX section in IDialogSettings for the current language.
String	getUserDecision(String key) Returns the stored user answer to the question identified with the passed key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DONT_ASK_AGAIN_DIALOG_PREFIX

public static final String DONT_ASK_AGAIN_DIALOG_PREFIX

A section id that holds the "don't ask me again" dialog settings.

Value is of type String and is one of MessageDialogWithToggle.ALWAYS, MessageDialogWithToggle.NEVER or (default) MessageDialogWithToggle.PROMPT.

Since:

2.8

See Also:

Constant Field Values

Constructor Detail

DontAskAgainDialogs

public DontAskAgainDialogs()

Method Detail

getUserDecision

public String getUserDecision(String key)

Returns the stored user answer to the question identified with the passed key.

Parameters:

key - unique identifier . Represents the key to use when storing or reading the setting.

Returns:

User decision for the corresponding question. Value is one of type String and is one of MessageDialogWithToggle.ALWAYS, MessageDialogWithToggle.NEVER or (default) MessageDialogWithToggle.PROMPT. Never null

askUser

public int askUser(String question,
          String dialogTitle,
          String storeKey,
          org.eclipse.swt.widgets.Shell shell)

Opens a MessageDialogWithToggle and stores the answer, if use activate the corresponding checkbox.

Parameters:

question - The question to ask.

dialogTitle - Title

storeKey - the key used to store the decision in IDialogSettings, also used to read them getUserDecision(String)

shell - the parent Shell of the dialog

Returns:

User answer one of IDialogConstants.YES_ID, IDialogConstants.NO_ID or IDialogConstants.CANCEL_ID

forgetAllUserDecisions

public void forgetAllUserDecisions()

Rewrites the DONT_ASK_AGAIN_DIALOG_PREFIX section in IDialogSettings for the current language.
All the user decisions will be reseted.