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

Interface IPreferenceTabItemProvider

All Superinterfaces:

IReformatable

All Known Implementing Classes:

AbstractPreferenceTabItemProvider, BslTabItemProvider, DefaultUITabItemProvider

public interface IPreferenceTabItemProvider
extends IReformatable

This interface represents TabItem that can collect options with addOption(String, IOption) and then build its UI representation with createContent(TabFolder, String)

Method Summary

Modifier and Type	Method	Description
void	addOption(String groupName, IOption<?> option)	Adds option with in the given group or to this TabItem if groupName field is null
void	addShowWhitespaceOption(IOption<Boolean> option)	Adds specific option that is used to turn on/off showing of whitespace characters in preview editors.
void	createContent(org.eclipse.swt.widgets.TabFolder tabFolder, String name)	Builds UI representation of this TabItem with given name in the given tabFolder
void	setPreview(String previewText, IOptionProvider optionProvider)	Sets given previewText and previewFormater for this tab

Methods inherited from interface com.e1c.g5.v8.dt.formatter.ui.preferences.page.builders.IReformatable

reformat

Method Detail

addOption

void addOption(String groupName,
               IOption<?> option)

Adds option with in the given group or to this TabItem if groupName field is null

Parameters:

groupName - The name of the group to add the option, can be null

option - The option to add to the given group in this TabItem, cannot be null

addShowWhitespaceOption

void addShowWhitespaceOption(IOption<Boolean> option)

Adds specific option that is used to turn on/off showing of whitespace characters in preview editors. The last option that is called with this will be applied

Parameters:

option - The option that is used to read and write actual values

setPreview

void setPreview(String previewText,
                IOptionProvider optionProvider)

Sets given previewText and previewFormater for this tab

Parameters:

previewText - The text of preview(code example), cannot be null

optionProvider - The option provider for formatter(formatter that formats previewText), can be null

createContent

void createContent(org.eclipse.swt.widgets.TabFolder tabFolder,
                   String name)

Builds UI representation of this TabItem with given name in the given tabFolder

Parameters:

tabFolder - The containing TabFodler of this TabItem, cannot be null

name - The name of this TabItem, cannot be null