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

Class AbstractPreferenceTabItemProvider

java.lang.Object

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

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

All Implemented Interfaces:

IPreferenceTabItemProvider, IReformatable

Direct Known Subclasses:

DefaultUITabItemProvider

public abstract class AbstractPreferenceTabItemProvider
extends TerminalUIBuilder
implements IPreferenceTabItemProvider

This is abstract implementation of IPreferenceTabItemProvider it creates its Ui representation with #createTabItem(TabFolder, String) and options UI representation with TerminalUIBuilder.applyOption(IOption, Composite)

Field Summary

Fields

Modifier and Type	Field	Description
protected String	previewText	The text for the preview

Constructor Summary

Constructors

Constructor	Description
AbstractPreferenceTabItemProvider()

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	createContent(org.eclipse.swt.widgets.TabFolder tabFolder, String name)	Builds UI representation of this TabItem with given name in the given tabFolder
protected abstract IPreferenceGroupProvider	createPreferenceGroupProvider()	Creates instance of IBuildableGroup
protected abstract org.eclipse.swt.widgets.Composite	createTabItem(org.eclipse.swt.widgets.TabFolder tabFodler, String name, IOptionProvider optionProvider)	Creates TabItem with given name in given parent tabFolder
void	setPreview(String previewText, IOptionProvider optionProvider)	Sets given previewText and previewFormater for this tab

Methods inherited from class com.e1c.g5.v8.dt.formatter.ui.preferences.page.builders.TerminalUIBuilder

applyBooleanOption, applyIntegerOption, applyOption, applyStringOption

Methods inherited from class java.lang.Object

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

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

addShowWhitespaceOption

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

reformat

Field Detail

previewText

protected String previewText

The text for the preview

Constructor Detail

AbstractPreferenceTabItemProvider

public AbstractPreferenceTabItemProvider()

Method Detail

addOption

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

Description copied from interface: IPreferenceTabItemProvider

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

Specified by:

addOption in interface IPreferenceTabItemProvider

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

setPreview

public void setPreview(String previewText,
                       IOptionProvider optionProvider)

Description copied from interface: IPreferenceTabItemProvider

Sets given previewText and previewFormater for this tab

Specified by:

setPreview in interface IPreferenceTabItemProvider

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

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

Description copied from interface: IPreferenceTabItemProvider

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

Specified by:

createContent in interface IPreferenceTabItemProvider

Parameters:

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

name - The name of this TabItem, cannot be null

createPreferenceGroupProvider

protected abstract IPreferenceGroupProvider createPreferenceGroupProvider()

Creates instance of IBuildableGroup

Returns:

new instance of IBuildableGroup, cannot be null

createTabItem

protected abstract org.eclipse.swt.widgets.Composite createTabItem(org.eclipse.swt.widgets.TabFolder tabFodler,
                                                                   String name,
                                                                   IOptionProvider optionProvider)

Creates TabItem with given name in given parent tabFolder

Parameters:

tabFodler - The parent TabFodler, cannot be null

name - The name of the TabItem, cannot be null

optionProvider - The optionProvider for preview editors, cannot benull

Returns:

The composite that represents created TabItem, cannot be null