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

Class AbstractPreferenceTabFolderProvider

java.lang.Object

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

All Implemented Interfaces:

IPreferenceTabFolderProvider

Direct Known Subclasses:

DefaultUITabFolderProvider

public abstract class AbstractPreferenceTabFolderProvider
extends Object
implements IPreferenceTabFolderProvider

This is abstract implementation of IPreferenceTabFolderProvider that collects tabItems and creates them with createPreferenceTabItemProvider(). It can create itself with createTabFodler(Composite)

Constructor Summary

Constructors

Constructor	Description
AbstractPreferenceTabFolderProvider()

Method Summary

Modifier and Type	Method	Description
void	addOption(String tabName, String groupName, IOption<?> option)	Adds option to the TabItem with given name and the Group with given name
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.Composite parent)	Builds UI representation of this TabFolder
protected abstract IPreferenceTabItemProvider	createPreferenceTabItemProvider()	Creates new instance of IPreferenceTabItemProvider, cannot be null
protected abstract org.eclipse.swt.widgets.TabFolder	createTabFodler(org.eclipse.swt.widgets.Composite parent)	Creates instance of the TabFolder on the composite
protected void	reformat(String tabItemName)	Calls reformat on tab with given name
void	setPreview(String tabName, String previewText, IOptionProvider optionProvider)	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

AbstractPreferenceTabFolderProvider

public AbstractPreferenceTabFolderProvider()

Method Detail

addOption

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

Description copied from interface: IPreferenceTabFolderProvider

Adds option to the TabItem with given name and the Group with given name

Specified by:

addOption in interface IPreferenceTabFolderProvider

Parameters:

tabName - The name of the TabItem to add the option, cannot be null

groupName - The name of the Group held by TabItem to add the option, can be null

option - The option to add, cannot be null

createContent

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

Description copied from interface: IPreferenceTabFolderProvider

Builds UI representation of this TabFolder

Specified by:

createContent in interface IPreferenceTabFolderProvider

Parameters:

parent - The composite parent of this TabFolder, cannot be null

setPreview

public void setPreview(String tabName,
                       String previewText,
                       IOptionProvider optionProvider)

Description copied from interface: IPreferenceTabFolderProvider

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

Specified by:

setPreview in interface IPreferenceTabFolderProvider

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

optionProvider - The option provider for formatter(that shall format previewText with given preferences), cannot be null

addShowWhitespaceOption

public void addShowWhitespaceOption(IOption<Boolean> option)

Description copied from interface: IPreferenceTabFolderProvider

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

Specified by:

addShowWhitespaceOption in interface IPreferenceTabFolderProvider

Parameters:

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

reformat

protected void reformat(String tabItemName)

Calls reformat on tab with given name

Parameters:

tabItemName - The name of the tab to call reformat on, cannot be null

createTabFodler

protected abstract org.eclipse.swt.widgets.TabFolder createTabFodler(org.eclipse.swt.widgets.Composite parent)

Creates instance of the TabFolder on the composite

Parameters:

parent - The composite parent to build TabFodler on, cannot be null

Returns:

The new instance of TabFodler, cannot be null

createPreferenceTabItemProvider

protected abstract IPreferenceTabItemProvider createPreferenceTabItemProvider()

Creates new instance of IPreferenceTabItemProvider, cannot be null

Returns:

new instance of IPreferenceTabItemProvider, cannot be null