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

public abstract Class SimpleControl<F extends Field<F extends Field<F>>, N extends Node>

extends SimpleControl<F extends Field<F extends Field<F>>>
Class Inheritance
Known Direct Subclasses
com.dlsc.preferencesfx.formsfx.view.controls.SimpleListViewControl, com.dlsc.preferencesfx.formsfx.view.controls.SimpleNumberControl, com.dlsc.preferencesfx.formsfx.view.controls.SimplePasswordControl, com.dlsc.preferencesfx.formsfx.view.controls.SimpleRadioButtonControl, com.dlsc.preferencesfx.formsfx.view.controls.SimpleTextControl, com.dlsc.preferencesfx.formsfx.view.controls.ToggleControl, com.dlsc.preferencesfx.formsfx.view.controls.DoubleSliderControl, com.dlsc.preferencesfx.formsfx.view.controls.IntegerSliderControl, com.dlsc.preferencesfx.formsfx.view.controls.SimpleBooleanControl, com.dlsc.preferencesfx.formsfx.view.controls.SimpleCheckBoxControl, com.dlsc.preferencesfx.formsfx.view.controls.SimpleChooserControl, com.dlsc.preferencesfx.formsfx.view.controls.SimpleColorPickerControl, com.dlsc.preferencesfx.formsfx.view.controls.SimpleComboBoxControl
Imports
javafx.collections.ListChangeListener, javafx.css.PseudoClass, javafx.geometry.Point2D, javafx.scene.Node, javafx.scene.control.Control, .Label, .Tooltip, com.dlsc.formsfx.model.structure.Field, com.dlsc.preferencesfx.util.VisibilityProperty
This class provides a base for general purpose FormsFX controls.
Authors
Sacha Schmid, Rinesch Murugathas, François Martin, Marco Sanfratello

Field Summary

Modifier and TypeField and Description
protected static final PseudoClass
CHANGED_CLASS

Hides com.dlsc.formsfx.view.controls.SimpleControl.CHANGED_CLASS.

protected static final PseudoClass
DISABLED_CLASS

Hides com.dlsc.formsfx.view.controls.SimpleControl.DISABLED_CLASS.

protected F
field

Hides com.dlsc.formsfx.view.controls.SimpleControl.field.

This is the Field that is used for binding and update styling changes.
protected Label
fieldLabel

The label which gets rendered on the left of the node.

protected static final PseudoClass
INVALID_CLASS

Hides com.dlsc.formsfx.view.controls.SimpleControl.INVALID_CLASS.

protected N
node

The control which gets rendered.

protected static final PseudoClass
REQUIRED_CLASS

Hides com.dlsc.formsfx.view.controls.SimpleControl.REQUIRED_CLASS.

Pseudo classes for state changes.
pack-priv Tooltip
tooltip

Hides com.dlsc.formsfx.view.controls.SimpleControl.tooltip.

Tooltip to hold the error message.
protected VisibilityProperty
visibilityProperty

Property for control visibility.

Constructor Summary

AccessConstructor and Description
public
SimpleControl()

Method Summary

Modifier and TypeMethod and Description
public void
addStyleClass(String
of the style class to be added to the control
name)

Overrides com.dlsc.formsfx.view.controls.SimpleControl.addStyleClass.

Adds a style class to the control.

public F
getField()

public Label
getFieldLabel()

public N
getNode()

public VisibilityProperty
getVisibilityProperty()

public void
init()

Overrides default com.dlsc.formsfx.view.util.ViewMixin.init.

This method calls all the other methods, so that it can be initialized easier.

public void
initializeParts()

Overrides com.dlsc.formsfx.view.controls.SimpleControl.initializeParts.

Implements com.dlsc.formsfx.view.util.ViewMixin.initializeParts.

This method is used to initializes all the properties of a class.

public abstract void
layoutParts()

Redeclares com.dlsc.formsfx.view.util.ViewMixin.layoutParts.

Overrides com.dlsc.formsfx.view.controls.SimpleControl.layoutParts.

This method is used to align the parts of a class.

public void
removeStyleClass(String
of the class to be removed from the control
name)

Overrides com.dlsc.formsfx.view.controls.SimpleControl.removeStyleClass.

Removes a style class from the control.

public void
setField(F field)

Overrides com.dlsc.formsfx.view.controls.SimpleControl.setField.

public void
setupBindings()

Overrides com.dlsc.formsfx.view.controls.SimpleControl.setupBindings.

Overrides default com.dlsc.formsfx.view.util.ViewMixin.setupBindings.

This method is used to configure the bindings of the properties.

public void
setupEventHandlers()

Overrides default com.dlsc.formsfx.view.util.ViewMixin.setupEventHandlers.

This method is used to set up event handlers.

public void
setupValueChangedListeners()

Overrides com.dlsc.formsfx.view.controls.SimpleControl.setupValueChangedListeners.

Overrides default com.dlsc.formsfx.view.util.ViewMixin.setupValueChangedListeners.

This method is used to set up value change listeners.

public void
setVisibilityProperty(VisibilityProperty visibilityProperty)

protected void
toggleTooltip(Node
The control which gets the tooltip.
reference)

Overrides com.dlsc.formsfx.view.controls.SimpleControl.toggleTooltip.

Sets the error message as tooltip for the matching control and shows them below the same control.

protected void
toggleTooltip(Node
The control which gets the tooltip.
reference, Control
The control needed for positioning the tooltip.
below)

Overrides com.dlsc.formsfx.view.controls.SimpleControl.toggleTooltip.

Sets the error message as tooltip for the matching control.

private void
updatePseudoStyles()

protected void
updateStyle(PseudoClass
The CSS pseudo class to toggle.
pseudo, boolean
Determines whether the CSS class should be applied.
newValue)

Overrides com.dlsc.formsfx.view.controls.SimpleControl.updateStyle.

Sets the css style for the defined properties.

Field Detail

CHANGED_CLASSback to summary
protected static final PseudoClass CHANGED_CLASS

Hides com.dlsc.formsfx.view.controls.SimpleControl.CHANGED_CLASS.

DISABLED_CLASSback to summary
protected static final PseudoClass DISABLED_CLASS

Hides com.dlsc.formsfx.view.controls.SimpleControl.DISABLED_CLASS.

fieldback to summary
protected F field

Hides com.dlsc.formsfx.view.controls.SimpleControl.field.

This is the Field that is used for binding and update styling changes.

fieldLabelback to summary
protected Label fieldLabel

The label which gets rendered on the left of the node.

INVALID_CLASSback to summary
protected static final PseudoClass INVALID_CLASS

Hides com.dlsc.formsfx.view.controls.SimpleControl.INVALID_CLASS.

nodeback to summary
protected N node

The control which gets rendered.

REQUIRED_CLASSback to summary
protected static final PseudoClass REQUIRED_CLASS

Hides com.dlsc.formsfx.view.controls.SimpleControl.REQUIRED_CLASS.

Pseudo classes for state changes.

tooltipback to summary
pack-priv Tooltip tooltip

Hides com.dlsc.formsfx.view.controls.SimpleControl.tooltip.

Tooltip to hold the error message.

visibilityPropertyback to summary
protected VisibilityProperty visibilityProperty

Property for control visibility.

Constructor Detail

SimpleControlback to summary
public SimpleControl()

Method Detail

addStyleClassback to summary
public void addStyleClass(String name)

Overrides com.dlsc.formsfx.view.controls.SimpleControl.addStyleClass.

Adds a style class to the control.

Parameters
name:String

of the style class to be added to the control

Annotations
@Override
getFieldback to summary
public F getField()
getFieldLabelback to summary
public Label getFieldLabel()
getNodeback to summary
public N getNode()
getVisibilityPropertyback to summary
public VisibilityProperty getVisibilityProperty()
initback to summary
public void init()

Overrides default com.dlsc.formsfx.view.util.ViewMixin.init.

Doc from com.dlsc.formsfx.view.util.ViewMixin.init.

This method calls all the other methods, so that it can be initialized easier.

Annotations
@Override
initializePartsback to summary
public void initializeParts()

Overrides com.dlsc.formsfx.view.controls.SimpleControl.initializeParts.

Implements com.dlsc.formsfx.view.util.ViewMixin.initializeParts.

Doc from com.dlsc.formsfx.view.controls.SimpleControl.initializeParts.

This method is used to initializes all the properties of a class.

Annotations
@Override
layoutPartsback to summary
public abstract void layoutParts()

Redeclares com.dlsc.formsfx.view.util.ViewMixin.layoutParts.

Overrides com.dlsc.formsfx.view.controls.SimpleControl.layoutParts.

Doc from com.dlsc.formsfx.view.controls.SimpleControl.layoutParts.

This method is used to align the parts of a class.

Annotations
@Override
removeStyleClassback to summary
public void removeStyleClass(String name)

Overrides com.dlsc.formsfx.view.controls.SimpleControl.removeStyleClass.

Removes a style class from the control.

Parameters
name:String

of the class to be removed from the control

Annotations
@Override
setFieldback to summary
public void setField(F field)

Overrides com.dlsc.formsfx.view.controls.SimpleControl.setField.

Annotations
@Override
setupBindingsback to summary
public void setupBindings()

Overrides com.dlsc.formsfx.view.controls.SimpleControl.setupBindings.

Overrides default com.dlsc.formsfx.view.util.ViewMixin.setupBindings.

Doc from com.dlsc.formsfx.view.controls.SimpleControl.setupBindings.

This method is used to configure the bindings of the properties.

Annotations
@Override
setupEventHandlersback to summary
public void setupEventHandlers()

Overrides default com.dlsc.formsfx.view.util.ViewMixin.setupEventHandlers.

Doc from com.dlsc.formsfx.view.util.ViewMixin.setupEventHandlers.

This method is used to set up event handlers.

Annotations
@Override
setupValueChangedListenersback to summary
public void setupValueChangedListeners()

Overrides com.dlsc.formsfx.view.controls.SimpleControl.setupValueChangedListeners.

Overrides default com.dlsc.formsfx.view.util.ViewMixin.setupValueChangedListeners.

Doc from com.dlsc.formsfx.view.controls.SimpleControl.setupValueChangedListeners.

This method is used to set up value change listeners.

Annotations
@Override
setVisibilityPropertyback to summary
public void setVisibilityProperty(VisibilityProperty visibilityProperty)
toggleTooltipback to summary
protected void toggleTooltip(Node reference)

Overrides com.dlsc.formsfx.view.controls.SimpleControl.toggleTooltip.

Sets the error message as tooltip for the matching control and shows them below the same control.

Parameters
reference:Node

The control which gets the tooltip.

Annotations
@Override
toggleTooltipback to summary
protected void toggleTooltip(Node reference, Control below)

Overrides com.dlsc.formsfx.view.controls.SimpleControl.toggleTooltip.

Sets the error message as tooltip for the matching control.

Parameters
reference:Node

The control which gets the tooltip.

below:Control

The control needed for positioning the tooltip.

Annotations
@Override
updatePseudoStylesback to summary
private void updatePseudoStyles()
updateStyleback to summary
protected void updateStyle(PseudoClass pseudo, boolean newValue)

Overrides com.dlsc.formsfx.view.controls.SimpleControl.updateStyle.

Sets the css style for the defined properties.

Parameters
pseudo:PseudoClass

The CSS pseudo class to toggle.

newValue:boolean

Determines whether the CSS class should be applied.

Annotations
@Override