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

Class AbstractPreferencePageProvider

java.lang.Object

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

All Implemented Interfaces:

IPreferencePageProvider

Direct Known Subclasses:

BslPreferencePageProvider

public abstract class AbstractPreferencePageProvider
extends Object
implements IPreferencePageProvider

Abstract implementation of IPreferencePageProvider that uses IOptionFactory to create options. Delegates to IPreferenceTabFolderProvider to perform compose(Composite)

Constructor Summary

Constructors

Constructor	Description
AbstractPreferencePageProvider(IOptionFactory optionFactory, IOptionProvider defaultOptionProvider)	Creates new instance with given IOptionFactory and initializes preferenceTabFolderProvider with createPreferenceTabFolderProvider()

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
protected abstract IPreferenceTabFolderProvider	createPreferenceTabFolderProvider()	Creates new instance of IPreferenceTabFolderProvider
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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPreferencePageProvider

public AbstractPreferencePageProvider(IOptionFactory optionFactory,
                                      IOptionProvider defaultOptionProvider)

Creates new instance with given IOptionFactory and initializes preferenceTabFolderProvider with createPreferenceTabFolderProvider()

Parameters:

optionFactory - The option factory to set on optionFactory, cannot be null

defaultOptionProvider - The provider for options, can be null if all tabs are configured manually with setOptionProvider(String, IOptionProvider)

Method Detail

addMultiStringOption

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

Description copied from interface: IPreferencePageProvider

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

Specified by:

addMultiStringOption in interface IPreferencePageProvider

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

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

Description copied from interface: IPreferencePageProvider

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

Specified by:

addBooleanOption in interface IPreferencePageProvider

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

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

Description copied from interface: IPreferencePageProvider

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

Specified by:

addStringOption in interface IPreferencePageProvider

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

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

Description copied from interface: IPreferencePageProvider

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

Specified by:

addIntegerOption in interface IPreferencePageProvider

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

compose

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

Description copied from interface: IPreferencePageProvider

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

Specified by:

compose in interface IPreferencePageProvider

Parameters:

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

setPreview

public void setPreview(String tabName,
                       String previewText)

Description copied from interface: IPreferencePageProvider

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

Specified by:

setPreview in interface IPreferencePageProvider

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

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

Description copied from interface: IPreferencePageProvider

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

Specified by:

enableShowWhitespaceCharactersOption in interface IPreferencePageProvider

Parameters:

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

store - The related preference store, can be null

setOptionProvider

public void setOptionProvider(String tabName,
                              IOptionProvider optionProvider)

Description copied from interface: IPreferencePageProvider

Sets option provider for the preview in the given tab

Specified by:

setOptionProvider in interface IPreferencePageProvider

Parameters:

tabName - The tab name to set option provider to

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

createPreferenceTabFolderProvider

protected abstract IPreferenceTabFolderProvider createPreferenceTabFolderProvider()

Creates new instance of IPreferenceTabFolderProvider

Returns:

new instance of IPreferenceTabFolderProvider, cannot be null