Top Description Fields Constructors Methods
com.dlsc.preferencesfx.formsfx.view.renderer

public Class PreferencesFxGroup

extends Group
Class Inheritance
Imports
com.dlsc.formsfx.model.structure.Element, .Group, com.dlsc.formsfx.model.util.TranslationService, com.dlsc.preferencesfx.util.Strings, .VisibilityProperty, javafx.beans.property.SimpleStringProperty, .StringProperty

Represents a group of Elements which in comparison with Group are not collapsible and are separated by more space around it.
Authors
Sacha Schmid, Rinesch Murugathas, François Martin, Marco Sanfratello

Field Summary

Modifier and TypeField and Description
private PreferencesFxGroupRenderer
private final StringProperty
private final StringProperty
titleKey

The title acts as a description for the group.

private VisibilityProperty
Inherited from com.dlsc.formsfx.model.structure.Group:
changedelementstranslationServicevalid

Constructor Summary

AccessConstructor and Description
protected
PreferencesFxGroup(Element<E extends Element<E>>... elements)

Method Summary

Modifier and TypeMethod and Description
public PreferencesFxGroupRenderer
public String
public VisibilityProperty
public static PreferencesFxGroup

Returns:

Returns a new Section.
of
(Element<E extends Element<E>>...
The elements to be included in the section.
elements
)

Hides com.dlsc.formsfx.model.structure.Group.of.

Creates a new section containing the given elements.

public void
public void
public Group

Returns:

Returns the current group to allow for chaining.
title
(String
The new value for the title property. This can be the title itself or a key that is then used for translation.
newValue
)

Sets the title property of the current group.

public StringProperty
public void
translate()

Updates the title based on the titleKey for i18n.

public PreferencesFxGroup
Inherited from com.dlsc.formsfx.model.structure.Group:
addEventHandlerchangedPropertyfireEventgetElementshasChangedisI18NisValidpersistremoveEventHandlerresettranslatevalidProperty

Field Detail

rendererback to summary
private PreferencesFxGroupRenderer renderer
titleback to summary
private final StringProperty title
titleKeyback to summary
private final StringProperty titleKey

The title acts as a description for the group. It is always visible to the user and tells them how the contained elements are grouped. This property is translatable if a TranslationService is set on the containing form.

visibilityPropertyback to summary
private VisibilityProperty visibilityProperty

Constructor Detail

PreferencesFxGroupback to summary
protected PreferencesFxGroup(Element<E extends Element<E>>... elements)

Method Detail

getRendererback to summary
public PreferencesFxGroupRenderer getRenderer()
getTitleback to summary
public String getTitle()
getVisibilityPropertyback to summary
public VisibilityProperty getVisibilityProperty()
ofback to summary
public static PreferencesFxGroup of(Element<E extends Element<E>>... elements)

Hides com.dlsc.formsfx.model.structure.Group.of.

Creates a new section containing the given elements.

Parameters
elements:Element<E extends Element<E>>[]

The elements to be included in the section.

Returns:PreferencesFxGroup

Returns a new Section.

setRendererback to summary
public void setRenderer(PreferencesFxGroupRenderer renderer)
setVisibilityPropertyback to summary
public void setVisibilityProperty(VisibilityProperty visibilityProperty)
titleback to summary
public Group title(String newValue)

Sets the title property of the current group.

Parameters
newValue:String

The new value for the title property. This can be the title itself or a key that is then used for translation.

Returns:Group

Returns the current group to allow for chaining.

See Also
TranslationService
titlePropertyback to summary
public StringProperty titleProperty()
translateback to summary
public void translate()

Updates the title based on the titleKey for i18n. If there is no translationService, the title will be the same as the titleKey. If there is a translationService, the titleKey will be used to lookup the translated variant using the translationService and the title is set.

visibilityPropertyback to summary
public PreferencesFxGroup visibilityProperty(VisibilityProperty visibilityProperty)