FormsFX Core 11.6.0 · com.dlsc.formsfx.model.structure.Group

Field Summary

Modifier and Type	Field and Description
protected final BooleanProperty	changed
protected final List<Element<E extends Element<E>>>	elements
private final Map<EventType<GroupEvent>, List<EventHandler<? super GroupEvent>>>	eventHandlers
protected TranslationService	translationService The translation service is passed down from the containing form.
protected final BooleanProperty	valid The group acts as a proxy for its contained elements' `changed` and `valid` properties.

Constructor Summary

Access	Constructor and Description
protected	Group(Element<E extends Element<E>>... A varargs list of elements that are contained in this group. elements) Internal constructor for the `Group` class.

Method Summary

Modifier and Type	Method and Description
public Group	addEventHandler(EventType<GroupEvent> the type of the events to receive by the handler eventType, EventHandler<? super GroupEvent> the handler to register eventHandler) Registers an event handler to this group.
public BooleanProperty	changedProperty()
protected void	fireEvent(GroupEvent event)
public List<Element<E extends Element<E>>>	getElements()
public boolean	hasChanged()
public boolean	isI18N()
public boolean	isValid()
public static Group	Returns: Returns a new `Group`. of(Element<E extends Element<E>>... The elements to be included in the group. elements) Creates a new group containing the given elements.
public void	persist() Persists the values for all contained elements.
public Group	removeEventHandler(EventType<GroupEvent> the event type from which to unregister eventType, EventHandler<? super GroupEvent> the handler to unregister eventHandler) Unregisters a previously registered event handler from this group.
public void	reset() Resets the values for all contained elements.
private void	setChangedProperty() Sets this group's `changed` property based on its contained elements' changed properties.
private void	setValidProperty() Sets this group's `valid` property based on its contained elements' changed properties.
protected void	translate(TranslationService The new service to use for translating translatable values. newValue) This internal method is called by the containing form when a new translation has been added to the form.
public BooleanProperty	validProperty()

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

Field Detail

changed	back to summary
protected final BooleanProperty changed

elements	back to summary
protected final List<Element<E extends Element<E>>> elements

eventHandlers	back to summary
private final Map<EventType<GroupEvent>, List<EventHandler<? super GroupEvent>>> eventHandlers

translationService	back to summary
protected TranslationService translationService The translation service is passed down from the containing form. It is used to translate all translatable values of the field.

valid	back to summary
protected final BooleanProperty valid The group acts as a proxy for its contained elements' `changed` and `valid` properties.

Constructor Detail

Group back to summary

Group	back to summary
protected Group(Element<E extends Element<E>>... elements) Internal constructor for the `Group` class. To create new groups, see the static factory method in this class. Parameters elements:Element<E extends Element<E>>[] A varargs list of elements that are contained in this group. See Also `Group::of`

protected Group(Element<E extends Element<E>>... elements)

Internal constructor for the Group class. To create new groups, see the static factory method in this class.

Parameters

elements:Element<E extends Element<E>>[]: A varargs list of elements that are contained in this group.

See Also

Group::of

Method Detail

addEventHandler back to summary

addEventHandler	back to summary
public Group addEventHandler(EventType<GroupEvent> eventType, EventHandler<? super GroupEvent> eventHandler) Registers an event handler to this group. The handler is called when the group receives an `Event` of the specified type during the bubbling phase of event delivery. Parameters eventType:EventType<GroupEvent> the type of the events to receive by the handler eventHandler:EventHandler<? super GroupEvent> the handler to register Exceptions NullPointerException: if either event type or handler are `null`.

public Group addEventHandler(EventType<GroupEvent> eventType, EventHandler<? super GroupEvent> eventHandler)

Registers an event handler to this group. The handler is called when the group receives an Event of the specified type during the bubbling phase of event delivery.

Parameters

eventType:EventType<GroupEvent>: the type of the events to receive by the handler
eventHandler:EventHandler<? super GroupEvent>: the handler to register

Exceptions

NullPointerException:: if either event type or handler are null.

changedProperty	back to summary
public BooleanProperty changedProperty()

fireEvent	back to summary
protected void fireEvent(GroupEvent event)

getElements	back to summary
public List<Element<E extends Element<E>>> getElements()

hasChanged	back to summary
public boolean hasChanged()

isI18N	back to summary
public boolean isI18N()

isValid	back to summary
public boolean isValid()

of back to summary

of	back to summary
public static Group of(Element<E extends Element<E>>... elements) Creates a new group containing the given elements. Parameters elements:Element<E extends Element<E>>[] The elements to be included in the group. Returns:Group Returns a new `Group`.

public static Group of(Element<E extends Element<E>>... elements)

Creates a new group containing the given elements.

Parameters

elements:Element<E extends Element<E>>[]: The elements to be included in the group.

Returns:Group

Returns a new Group.

persist back to summary

persist	back to summary
public void persist() Persists the values for all contained elements. See Also `Field::persist`

public void persist()

Persists the values for all contained elements.

See Also: Field::persist

removeEventHandler back to summary

removeEventHandler	back to summary
public Group removeEventHandler(EventType<GroupEvent> eventType, EventHandler<? super GroupEvent> eventHandler) Unregisters a previously registered event handler from this group. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler. Parameters eventType:EventType<GroupEvent> the event type from which to unregister eventHandler:EventHandler<? super GroupEvent> the handler to unregister Exceptions NullPointerException: if either event type or handler are `null`.

public Group removeEventHandler(EventType<GroupEvent> eventType, EventHandler<? super GroupEvent> eventHandler)

Unregisters a previously registered event handler from this group. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler.

Parameters

eventType:EventType<GroupEvent>: the event type from which to unregister
eventHandler:EventHandler<? super GroupEvent>: the handler to unregister

Exceptions

NullPointerException:: if either event type or handler are null.

reset back to summary

reset	back to summary
public void reset() Resets the values for all contained elements. See Also `Field::reset`

public void reset()

Resets the values for all contained elements.

See Also: Field::reset

setChangedProperty	back to summary
private void setChangedProperty() Sets this group's `changed` property based on its contained elements' changed properties.

setValidProperty	back to summary
private void setValidProperty() Sets this group's `valid` property based on its contained elements' changed properties.

translate back to summary

translate	back to summary
protected void translate(TranslationService newValue) This internal method is called by the containing form when a new translation has been added to the form. Also applies the translation to all contained elements. Parameters newValue:TranslationService The new service to use for translating translatable values. See Also `Field::translate`

protected void translate(TranslationService newValue)

This internal method is called by the containing form when a new translation has been added to the form. Also applies the translation to all contained elements.

Parameters

newValue:TranslationService: The new service to use for translating translatable values.

See Also

Field::translate

validProperty	back to summary
public BooleanProperty validProperty()

public Class Group

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail