org.eclipse.fx.ui.preferences

Class PreferenceUI

java.lang.Object

org.eclipse.fx.ui.preferences.PreferenceUI

public class PreferenceUI
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTIONS_BAR_STYLE The CSS class for the Actions bar
static java.lang.String	CONTENT_AREA_STYLE The CSS class for the content area of the preferences (Where the current preference page is displayed)
protected java.lang.String	currentFilterTerm
static java.lang.String	PAGE_LIST_STYLE The CSS class for the list of preference pages
static java.lang.String	PAGE_STYLE The CSS class for a preference page
static java.lang.String	SEARCH_STYLE The CSS class for the page-search field
static java.lang.String	TOP_LEVEL_STYLE The CSS class for the top-level container of the Preference UI

Constructor Summary

Constructors

Constructor and Description
PreferenceUI(PreferencePageFactory factory)

Method Summary

Modifier and Type	Method and Description
protected void	addButton(java.lang.String label, java.util.Optional<<any>> restoreDefault)
protected void	createActionButtons()
protected java.util.Comparator<PreferencePageProvider>	createComparator() Create the comparator used for sorting the list of providers.
protected java.util.function.Predicate<PreferencePageProvider>	createFilter() Create the predicate used for filtering the list of providers.
Subscription	registerOnCancelHandler(java.util.function.Consumer<PreferencePage> handler)
Subscription	registerOnOkHandler(java.util.function.Consumer<PreferencePage> handler)
void	selectPage(java.lang.String pageId) Select the preference page with the given ID
void	setFilter(java.lang.String filter) Set the text filter to the given value.
void	setPreferencePageProviders(java.util.List<PreferencePageProvider> providers)

Methods inherited from class java.lang.Object

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

Field Detail

TOP_LEVEL_STYLE

public static final java.lang.String TOP_LEVEL_STYLE

The CSS class for the top-level container of the Preference UI

See Also:

Constant Field Values

CONTENT_AREA_STYLE

public static final java.lang.String CONTENT_AREA_STYLE

The CSS class for the content area of the preferences (Where the current preference page is displayed)

See Also:

Constant Field Values

PAGE_STYLE

public static final java.lang.String PAGE_STYLE

The CSS class for a preference page

See Also:

Constant Field Values

PAGE_LIST_STYLE

public static final java.lang.String PAGE_LIST_STYLE

The CSS class for the list of preference pages

See Also:

Constant Field Values

SEARCH_STYLE

public static final java.lang.String SEARCH_STYLE

The CSS class for the page-search field

See Also:

Constant Field Values

ACTIONS_BAR_STYLE

public static final java.lang.String ACTIONS_BAR_STYLE

The CSS class for the Actions bar

See Also:

Constant Field Values

currentFilterTerm

protected java.lang.String currentFilterTerm

Constructor Detail

PreferenceUI

public PreferenceUI(PreferencePageFactory factory)

Method Detail

createFilter

protected java.util.function.Predicate<PreferencePageProvider> createFilter()

Create the predicate used for filtering the list of providers.

createComparator

protected java.util.Comparator<PreferencePageProvider> createComparator()

Create the comparator used for sorting the list of providers.

createActionButtons

protected void createActionButtons()

addButton

protected void addButton(java.lang.String label,
                         java.util.Optional<<any>> restoreDefault)

setPreferencePageProviders

public void setPreferencePageProviders(java.util.List<PreferencePageProvider> providers)

registerOnCancelHandler

public Subscription registerOnCancelHandler(java.util.function.Consumer<PreferencePage> handler)

registerOnOkHandler

public Subscription registerOnOkHandler(java.util.function.Consumer<PreferencePage> handler)

setFilter

public void setFilter(java.lang.String filter)

Set the text filter to the given value. The filter is used to restrict the pages displayed in the pages list.

The filter is case-insensitive, and accepts wildcards (* and ?)

Parameters:

filter - The new filter

selectPage

public void selectPage(java.lang.String pageId)

Select the preference page with the given ID

Parameters:

pageId - The ID of the page to select

See Also:

PreferencePageProvider.id()