Package com.e1c.g5.v8.dt.formatter.ui.preferences.page.builders

Interface IPreferencePageProvider

All Known Implementing Classes:

AbstractPreferencePageProvider, BslPreferencePageProvider

public interface IPreferencePageProvider

Builder that adds options and then creates their UI representation.

Method Summary

Modifier and Type	Method	Description
void	addBooleanOption(String tabName, String groupName, String preferenceKey, String presentation, org.eclipse.jface.preference.IPreferenceStore store)	Adds new store based boolean option in the given tab with given group and given preference key
void	addIntegerOption(String tabName, String groupName, String preferenceKey, String presentation, org.eclipse.jface.preference.IPreferenceStore store)	Adds new store based Integer option in the given tab with given group and given preference key
void	addMultiStringOption(String tabName, String groupName, String preferenceKey, String presentation, String[] options, String[] optionPresentations, org.eclipse.jface.preference.IPreferenceStore store)	Adds new manager based chose-one string option in the given tab with given group and given preference key
void	addStringOption(String tabName, String groupName, String preferenceKey, String presentation, org.eclipse.jface.preference.IPreferenceStore store)	Adds new store based string option in the given tab with given group and given preference key
void	compose(org.eclipse.swt.widgets.Composite parent)	Creates UI representation of options collected with #addBooleanOption(String, String, String, String, IPreferenceStore, boolean, boolean), #addIntegerOption(String, String, String, String, IPreferenceStore, boolean, boolean) #addMultiStringOption(String, String, String, String, String[], String[], IPreferenceStore, boolean, boolean) and #addStringOption(String, String, String, String, IPreferenceStore, boolean, boolean) methods
void	enableShowWhitespaceCharactersOption(String preferenceKey, org.eclipse.jface.preference.IPreferenceStore store)	Creates a specific option for each preview that lets user to turn on/off showing of whitespace characters
void	setOptionProvider(String tabName, IOptionProvider optionProvider)	Sets option provider for the preview in the given tab
void	setPreview(String tabName, String previewText)	Sets given previewText and given previewFromatter for the tab with given tabName

Method Detail

addMultiStringOption

void addMultiStringOption(String tabName,
                          String groupName,
                          String preferenceKey,
                          String presentation,
                          String[] options,
                          String[] optionPresentations,
                          org.eclipse.jface.preference.IPreferenceStore store)

Adds new manager based chose-one string option in the given tab with given group and given preference key

Parameters:

tabName - The name of the tab that holds this option, cannot be null

groupName - The name of the group that hold this option, can be null

preferenceKey - The preference key of the option, cannot be null

presentation - The presentation text to set on associated label, cannot be null

options - The options that can be chosen from the list, cannot be null

optionPresentations - The localized options presentation, cannot be null

store - The store which is bound to this option. Any set/get will be adjusted with it, can be null

addBooleanOption

void addBooleanOption(String tabName,
                      String groupName,
                      String preferenceKey,
                      String presentation,
                      org.eclipse.jface.preference.IPreferenceStore store)

Adds new store based boolean option in the given tab with given group and given preference key

Parameters:

tabName - The name of the tab that holds this option, cannot be null

groupName - The name of the group that hold this option, can be null

preferenceKey - The preference key of the option, cannot be null

presentation - The presentation text to set on associated label, cannot be null

store - The store which is bound to this option. Any set/get will be adjusted with it, can be null

addStringOption

void addStringOption(String tabName,
                     String groupName,
                     String preferenceKey,
                     String presentation,
                     org.eclipse.jface.preference.IPreferenceStore store)

Adds new store based string option in the given tab with given group and given preference key

Parameters:

tabName - The name of the tab that holds this option, cannot be null

groupName - The name of the group that hold this option, can be null

preferenceKey - The preference key of the option, cannot be null

presentation - The presentation text to set on associated label, cannot be null

store - The store which is bound to this option. Any set/get will be adjusted with it, can be null

addIntegerOption

void addIntegerOption(String tabName,
                      String groupName,
                      String preferenceKey,
                      String presentation,
                      org.eclipse.jface.preference.IPreferenceStore store)

Adds new store based Integer option in the given tab with given group and given preference key

Parameters:

tabName - The name of the tab that holds this option, cannot be null

groupName - The name of the group that hold this option, can be null

preferenceKey - The preference key of the option, cannot be null

presentation - The presentation text to set on associated label, cannot be null

The - store which is bound to this option. Any set/get will be adjusted with it, can be null

setPreview

void setPreview(String tabName,
                String previewText)

Sets given previewText and given previewFromatter for the tab with given tabName

Parameters:

tabName - The name of the tab to set preview preferences on, cannot be null

previewText - The text of preview(code example to be formatted), can be null

enableShowWhitespaceCharactersOption

void enableShowWhitespaceCharactersOption(String preferenceKey,
                                          org.eclipse.jface.preference.IPreferenceStore store)

Creates a specific option for each preview that lets user to turn on/off showing of whitespace characters

Parameters:

preferenceKey - The preference key of this option, cannot be null

store - The related preference store, can be null

compose

void compose(org.eclipse.swt.widgets.Composite parent)

Creates UI representation of options collected with #addBooleanOption(String, String, String, String, IPreferenceStore, boolean, boolean), #addIntegerOption(String, String, String, String, IPreferenceStore, boolean, boolean) #addMultiStringOption(String, String, String, String, String[], String[], IPreferenceStore, boolean, boolean) and #addStringOption(String, String, String, String, IPreferenceStore, boolean, boolean) methods

Parameters:

parent - The composite parent on which UI shall be built on, cannot be null

setOptionProvider

void setOptionProvider(String tabName,
                       IOptionProvider optionProvider)

Sets option provider for the preview in the given tab

Parameters:

tabName - The tab name to set option provider to

optionProvider - The option provider that is set to the given tab