PreferencesFX 11.17.0 · com.dlsc.preferencesfx.model.Category

Modifier and Type	Field and Description
private final StringProperty	breadcrumb
private List<Category>	children
private StringProperty	description
private StringProperty	descriptionKey
private boolean	expand
private List<Group>	groups
private Node	itemIcon
private static final Logger	LOGGER
private VisibilityProperty	visibilityProperty

Access	Constructor and Description
private	Category(String Category name, for display in `CategoryView` description, VisibilityProperty visibilityProperty) Creates a category without groups, for top-level categories without any settings.
private	Category(String description, VisibilityProperty visibilityProperty, Group... groups)
private	Category(String description, Node itemIcon, VisibilityProperty visibilityProperty)
private	Category(String description, Node itemIcon, VisibilityProperty visibilityProperty, Group... groups)

Method Summary

Modifier and Type	Method and Description
public StringProperty	breadcrumbProperty()
public void	createBreadcrumbs(List<Category> the categories to create breadcrumbs for categories) Creates and defines all of the breadcrumbs for all of the categories.
public ReadOnlyStringProperty	descriptionProperty()
public Category	Returns: this object for chaining with the fluent API expand() Sets category to be expanded when added to the tree view.
public String	getBreadcrumb()
public List<Category>	getChildren()
public String	getDescription()
public List<Group>	getGroups()
public Node	getItemIcon()
public boolean	Returns: the property showing if Category should be expanded or not isExpand() Gets the property whether to auto-expand the Category or not.
public static Category	Returns: initialized Category object of(String Category name, for display in `CategoryView` description) Creates an empty category.
public static Category	Returns: initialized Category object of(String Category name, for display in `CategoryView` description, VisibilityProperty control category visibility visibilityProperty) Creates an empty category.
public static Category	Returns: initialized Category object of(String Category name, for display in `CategoryView` description, Group... `Group` with `Setting` to be shown in the `CategoryView` groups) Creates a new category from groups.
public static Category	Returns: initialized Category object of(String Category name, for display in `CategoryView` description, VisibilityProperty control category visibility visibilityProperty, Group... `Group` with `Setting` to be shown in the `CategoryView` groups) Creates a new category from groups.
public static Category	Returns: initialized Category object of(String Category name, for display in `CategoryView` description, Setting<E extends Element<E extends Element<E>>, P extends Property<T>>... `Setting` to be shown in the `CategoryView` settings) Creates a new category from settings, if the settings shouldn't be individually grouped.
public static Category	Returns: initialized Category object of(String Category name, for display in `CategoryView` description, VisibilityProperty control category visibility visibilityProperty, Setting<E extends Element<E extends Element<E>>, P extends Property<T>>... `Setting` to be shown in the `CategoryView` settings) Creates a new category from settings, if the settings shouldn't be individually grouped.
public static Category	Returns: initialized Category object of(String Category name, for display in `CategoryView` description, Node Icon to be shown next to the category name itemIcon) Creates an empty category.
public static Category	Returns: initialized Category object of(String Category name, for display in `CategoryView` description, Node Icon to be shown next to the category name itemIcon, VisibilityProperty control category visibility visibilityProperty) Creates an empty category.
public static Category	Returns: initialized Category object of(String Category name, for display in `CategoryView` description, Node Icon to be shown next to the category name itemIcon, Group... `Group` with `Setting` to be shown in the `CategoryView` groups) Creates a new category from groups.
public static Category	Returns: initialized Category object of(String Category name, for display in `CategoryView` description, Node Icon to be shown next to the category name itemIcon, VisibilityProperty control category visibility visibilityProperty, Group... `Group` with `Setting` to be shown in the `CategoryView` groups) Creates a new category from groups.
public static Category	Returns: initialized Category object of(String Category name, for display in `CategoryView` description, Node Icon to be shown next to the category name itemIcon, Setting<E extends Element<E extends Element<E>>, P extends Property<T>>... `Setting` to be shown in the `CategoryView` settings) Creates a new category from settings, if the settings shouldn't be individually grouped.
public static Category	Returns: initialized Category object of(String Category name, for display in `CategoryView` description, Node Icon to be shown next to the category name itemIcon, VisibilityProperty control category visibility visibilityProperty, Setting<E extends Element<E extends Element<E>>, P extends Property<T>>... `Setting` to be shown in the `CategoryView` settings) Creates a new category from settings, if the settings shouldn't be individually grouped.
public void	setBreadcrumb(String breadcrumb)
public void	setVisibilityProperty(VisibilityProperty visibilityProperty)
public Category	Returns: this object for chaining with the fluent API subCategories(Category... the subcategories to assign to this category children) Adds subcategories to this category.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	translate(TranslationService the translation service translationService) This internal method is used as a callback for when the translation service or its locale changes.
public void	unmarkAll() Unmarks all settings and groups.
public void	unmarkGroups() Unmarks all groups.
public void	unmarkSettings() Unmarks all settings.
public void	updateGroupDescriptions() Updates the group descriptions when translation changes.
public VisibilityProperty	visibilityProperty()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

breadcrumb	back to summary
private final StringProperty breadcrumb

children	back to summary
private List<Category> children

description	back to summary
private StringProperty description

descriptionKey	back to summary
private StringProperty descriptionKey

expand	back to summary
private boolean expand

groups	back to summary
private List<Group> groups

itemIcon	back to summary
private Node itemIcon

LOGGER	back to summary
private static final Logger LOGGER

visibilityProperty	back to summary
private VisibilityProperty visibilityProperty

Category	back to summary
private Category(String description, VisibilityProperty visibilityProperty) Creates a category without groups, for top-level categories without any settings. Parameters description:String Category name, for display in `CategoryView`

Category	back to summary
private Category(String description, VisibilityProperty visibilityProperty, Group... groups)

Category	back to summary
private Category(String description, Node itemIcon, VisibilityProperty visibilityProperty)

Category	back to summary
private Category(String description, Node itemIcon, VisibilityProperty visibilityProperty, Group... groups)

Method Detail

breadcrumbProperty	back to summary
public StringProperty breadcrumbProperty()

createBreadcrumbs	back to summary
public void createBreadcrumbs(List<Category> categories) Creates and defines all of the breadcrumbs for all of the categories. Parameters categories:List<Category> the categories to create breadcrumbs for

createBreadcrumbs

back to summary

public void createBreadcrumbs(List<Category> categories)

Creates and defines all of the breadcrumbs for all of the categories.

Parameters

categories:List<Category>: the categories to create breadcrumbs for

descriptionProperty	back to summary
public ReadOnlyStringProperty descriptionProperty()

expand	back to summary
public Category expand() Sets category to be expanded when added to the tree view. Returns:Category this object for chaining with the fluent API

expand

back to summary

public Category expand()

Sets category to be expanded when added to the tree view.

Returns:Category: this object for chaining with the fluent API

getBreadcrumb	back to summary
public String getBreadcrumb()

getChildren	back to summary
public List<Category> getChildren()

getDescription	back to summary
public String getDescription()

getGroups	back to summary
public List<Group> getGroups()

getItemIcon	back to summary
public Node getItemIcon()

isExpand	back to summary
public boolean isExpand() Gets the property whether to auto-expand the Category or not. Returns:boolean the property showing if Category should be expanded or not

isExpand

back to summary

public boolean isExpand()

Gets the property whether to auto-expand the Category or not.

Returns:boolean: the property showing if Category should be expanded or not

of back to summary

of	back to summary
public static Category of(String description) Creates an empty category. Can be used for top-level categories without `Setting`. Parameters description:String Category name, for display in `CategoryView` Returns:Category initialized Category object

public static Category of(String description)

Creates an empty category. Can be used for top-level categories without Setting.

Parameters

description:String: Category name, for display in CategoryView

Returns:Category

initialized Category object

of back to summary

of	back to summary
public static Category of(String description, VisibilityProperty visibilityProperty) Creates an empty category. Can be used for top-level categories without `Setting`. Parameters description:String Category name, for display in `CategoryView` visibilityProperty:VisibilityProperty control category visibility Returns:Category initialized Category object

public static Category of(String description, VisibilityProperty visibilityProperty)

Creates an empty category. Can be used for top-level categories without Setting.

Parameters

description:String: Category name, for display in CategoryView
visibilityProperty:VisibilityProperty: control category visibility

Returns:Category

initialized Category object

of back to summary

of	back to summary
public static Category of(String description, Group... groups) Creates a new category from groups. Parameters description:String Category name, for display in `CategoryView` groups:Group[] `Group` with `Setting` to be shown in the `CategoryView` Returns:Category initialized Category object

public static Category of(String description, Group... groups)

Creates a new category from groups.

Parameters

description:String: Category name, for display in CategoryView
groups:Group[]: Group with Setting to be shown in the CategoryView

Returns:Category

initialized Category object

of back to summary

of	back to summary
public static Category of(String description, VisibilityProperty visibilityProperty, Group... groups) Creates a new category from groups. Parameters description:String Category name, for display in `CategoryView` visibilityProperty:VisibilityProperty control category visibility groups:Group[] `Group` with `Setting` to be shown in the `CategoryView` Returns:Category initialized Category object

public static Category of(String description, VisibilityProperty visibilityProperty, Group... groups)

Creates a new category from groups.

Parameters

description:String: Category name, for display in CategoryView
visibilityProperty:VisibilityProperty: control category visibility
groups:Group[]: Group with Setting to be shown in the CategoryView

Returns:Category

initialized Category object

of back to summary

of	back to summary
public static Category of(String description, Setting<E extends Element<E extends Element<E>>, P extends Property<T>>... settings) Creates a new category from settings, if the settings shouldn't be individually grouped. Parameters description:String Category name, for display in `CategoryView` settings:Setting<E extends Element<E extends Element<E>>, P extends Property<T>>[] `Setting` to be shown in the `CategoryView` Returns:Category initialized Category object

public static Category of(String description, Setting<E extends Element<E extends Element<E>>, P extends Property<T>>... settings)

Creates a new category from settings, if the settings shouldn't be individually grouped.

Parameters

description:String: Category name, for display in CategoryView
settings:Setting<E extends Element<E extends Element<E>>, P extends Property<T>>[]: Setting to be shown in the CategoryView

Returns:Category

initialized Category object

of back to summary

of	back to summary
public static Category of(String description, VisibilityProperty visibilityProperty, Setting<E extends Element<E extends Element<E>>, P extends Property<T>>... settings) Creates a new category from settings, if the settings shouldn't be individually grouped. Parameters description:String Category name, for display in `CategoryView` visibilityProperty:VisibilityProperty control category visibility settings:Setting<E extends Element<E extends Element<E>>, P extends Property<T>>[] `Setting` to be shown in the `CategoryView` Returns:Category initialized Category object

public static Category of(String description, VisibilityProperty visibilityProperty, Setting<E extends Element<E extends Element<E>>, P extends Property<T>>... settings)

Creates a new category from settings, if the settings shouldn't be individually grouped.

Parameters

description:String: Category name, for display in CategoryView
visibilityProperty:VisibilityProperty: control category visibility
settings:Setting<E extends Element<E extends Element<E>>, P extends Property<T>>[]: Setting to be shown in the CategoryView

Returns:Category

initialized Category object

of back to summary

of	back to summary
public static Category of(String description, Node itemIcon) Creates an empty category. Can be used for top-level categories without `Setting`. Parameters description:String Category name, for display in `CategoryView` itemIcon:Node Icon to be shown next to the category name Returns:Category initialized Category object

public static Category of(String description, Node itemIcon)

Creates an empty category. Can be used for top-level categories without Setting.

Parameters

description:String: Category name, for display in CategoryView
itemIcon:Node: Icon to be shown next to the category name

Returns:Category

initialized Category object

of back to summary

of	back to summary
public static Category of(String description, Node itemIcon, VisibilityProperty visibilityProperty) Creates an empty category. Can be used for top-level categories without `Setting`. Parameters description:String Category name, for display in `CategoryView` itemIcon:Node Icon to be shown next to the category name visibilityProperty:VisibilityProperty control category visibility Returns:Category initialized Category object

public static Category of(String description, Node itemIcon, VisibilityProperty visibilityProperty)

Creates an empty category. Can be used for top-level categories without Setting.

Parameters

description:String: Category name, for display in CategoryView
itemIcon:Node: Icon to be shown next to the category name
visibilityProperty:VisibilityProperty: control category visibility

Returns:Category

initialized Category object

of back to summary

of	back to summary
public static Category of(String description, Node itemIcon, Group... groups) Creates a new category from groups. Parameters description:String Category name, for display in `CategoryView` itemIcon:Node Icon to be shown next to the category name groups:Group[] `Group` with `Setting` to be shown in the `CategoryView` Returns:Category initialized Category object

public static Category of(String description, Node itemIcon, Group... groups)

Creates a new category from groups.

Parameters

description:String: Category name, for display in CategoryView
itemIcon:Node: Icon to be shown next to the category name
groups:Group[]: Group with Setting to be shown in the CategoryView

Returns:Category

initialized Category object

of back to summary

of	back to summary
public static Category of(String description, Node itemIcon, VisibilityProperty visibilityProperty, Group... groups) Creates a new category from groups. Parameters description:String Category name, for display in `CategoryView` itemIcon:Node Icon to be shown next to the category name visibilityProperty:VisibilityProperty control category visibility groups:Group[] `Group` with `Setting` to be shown in the `CategoryView` Returns:Category initialized Category object

public static Category of(String description, Node itemIcon, VisibilityProperty visibilityProperty, Group... groups)

Creates a new category from groups.

Parameters

description:String: Category name, for display in CategoryView
itemIcon:Node: Icon to be shown next to the category name
visibilityProperty:VisibilityProperty: control category visibility
groups:Group[]: Group with Setting to be shown in the CategoryView

Returns:Category

initialized Category object

of back to summary

of	back to summary
public static Category of(String description, Node itemIcon, Setting<E extends Element<E extends Element<E>>, P extends Property<T>>... settings) Creates a new category from settings, if the settings shouldn't be individually grouped. Parameters description:String Category name, for display in `CategoryView` itemIcon:Node Icon to be shown next to the category name settings:Setting<E extends Element<E extends Element<E>>, P extends Property<T>>[] `Setting` to be shown in the `CategoryView` Returns:Category initialized Category object

public static Category of(String description, Node itemIcon, Setting<E extends Element<E extends Element<E>>, P extends Property<T>>... settings)

Creates a new category from settings, if the settings shouldn't be individually grouped.

Parameters

description:String: Category name, for display in CategoryView
itemIcon:Node: Icon to be shown next to the category name
settings:Setting<E extends Element<E extends Element<E>>, P extends Property<T>>[]: Setting to be shown in the CategoryView

Returns:Category

initialized Category object

of back to summary

of	back to summary
public static Category of(String description, Node itemIcon, VisibilityProperty visibilityProperty, Setting<E extends Element<E extends Element<E>>, P extends Property<T>>... settings) Creates a new category from settings, if the settings shouldn't be individually grouped. Parameters description:String Category name, for display in `CategoryView` itemIcon:Node Icon to be shown next to the category name visibilityProperty:VisibilityProperty control category visibility settings:Setting<E extends Element<E extends Element<E>>, P extends Property<T>>[] `Setting` to be shown in the `CategoryView` Returns:Category initialized Category object

public static Category of(String description, Node itemIcon, VisibilityProperty visibilityProperty, Setting<E extends Element<E extends Element<E>>, P extends Property<T>>... settings)

Creates a new category from settings, if the settings shouldn't be individually grouped.

Parameters

description:String: Category name, for display in CategoryView
itemIcon:Node: Icon to be shown next to the category name
visibilityProperty:VisibilityProperty: control category visibility
settings:Setting<E extends Element<E extends Element<E>>, P extends Property<T>>[]: Setting to be shown in the CategoryView

Returns:Category

initialized Category object

setBreadcrumb	back to summary
public void setBreadcrumb(String breadcrumb)

setVisibilityProperty	back to summary
public void setVisibilityProperty(VisibilityProperty visibilityProperty)

subCategories	back to summary
public Category subCategories(Category... children) Adds subcategories to this category. Can be used to build up a hierarchical tree of Categories. Parameters children:Category[] the subcategories to assign to this category Returns:Category this object for chaining with the fluent API

subCategories

back to summary

public Category subCategories(Category... children)

Adds subcategories to this category. Can be used to build up a hierarchical tree of Categories.

Parameters

children:Category[]: the subcategories to assign to this category

Returns:Category

this object for chaining with the fluent API

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

translate back to summary

translate	back to summary
public void translate(TranslationService translationService) This internal method is used as a callback for when the translation service or its locale changes. Also applies the translation to all contained sections. Parameters translationService:TranslationService the translation service See Also `::translate`

public void translate(TranslationService translationService)

This internal method is used as a callback for when the translation service or its locale changes. Also applies the translation to all contained sections.

Parameters

translationService:TranslationService: the translation service

See Also

::translate

unmarkAll	back to summary
public void unmarkAll() Unmarks all settings and groups. Is used for the search, which marks and unmarks items depending on the match as a form of visual feedback.

unmarkGroups	back to summary
public void unmarkGroups() Unmarks all groups. Is used for the search, which marks and unmarks items depending on the match as a form of visual feedback.

unmarkSettings	back to summary
public void unmarkSettings() Unmarks all settings. Is used for the search, which marks and unmarks items depending on the match as a form of visual feedback.

updateGroupDescriptions	back to summary
public void updateGroupDescriptions() Updates the group descriptions when translation changes.

visibilityProperty	back to summary
public VisibilityProperty visibilityProperty()

public Class Category

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail