PreferencesEditor (OfficeFloor 3.27.0 API)

java.lang.Object
- net.officefloor.gef.ide.preferences.PreferencesEditor<R>

public class PreferencesEditor<R extends Model>
extends java.lang.Object

Editor for preferences.

Author:: Daniel Sagenschneider

Constructor Summary

Constructors
Constructor Description

PreferencesEditor(AbstractAdaptedIdeEditor<R,?,?> editor, EnvironmentBridge envBridge)
Instantiate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`apply()`	Applies the preferences.
`void`	`cancel()`	Cancels the changes to the preferences.
`javafx.beans.property.ReadOnlyProperty<java.lang.Boolean>`	`dirtyProperty()`	Indicates whether dirty (requires saving).
`javafx.scene.layout.Pane`	`loadView(java.util.function.Consumer<javafx.scene.layout.Pane> loader)`	Loads the view.
`void`	`resetToDefaults()`	Resets all preferences to their defaults.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PreferencesEditor
```
public PreferencesEditor(AbstractAdaptedIdeEditor<R,?,?> editor,
                         EnvironmentBridge envBridge)
```
    Instantiate.
    
    Parameters:
    
    editor - AbstractAdaptedIdeEditor to configure preferences.
    
    envBridge - EnvironmentBridge.
- Method Detail
  - dirtyProperty
```
public javafx.beans.property.ReadOnlyProperty<java.lang.Boolean> dirtyProperty()
```
    Indicates whether dirty (requires saving).
    
    Returns:
    
    Property to track whether requires saving.
  - resetToDefaults
```
public void resetToDefaults()
```
    Resets all preferences to their defaults.
  - apply
```
public void apply()
```
    Applies the preferences.
  - cancel
```
public void cancel()
```
    Cancels the changes to the preferences.
  - loadView
```
public javafx.scene.layout.Pane loadView(java.util.function.Consumer<javafx.scene.layout.Pane> loader)
```
    Loads the view.
    
    Parameters:
    
    loader - Receives the visual for the entire preview editor.
    
    Returns:
    
    Editor view enable decorating.