PreferencesFX 11.17.0 · com.dlsc.preferencesfx.history.History

Modifier and Type	Field and Description
private ObservableList<Change<P>>	changes
private SimpleObjectProperty<Change<P>>	currentChange
private BooleanProperty	listenerActive
private static final Logger	LOGGER
private IntegerProperty	position
private BooleanProperty	redoAvailable
private BooleanProperty	undoAvailable
private IntegerProperty	validPosition

Access	Constructor and Description
public	History() Initializes a new history object.

Method Summary

Modifier and Type	Method and Description
private void	addChange(Change<P> change)
public void	attachChangeListener(Setting<E extends Element<E extends Element<E>>, P extends Property<T>> the setting to observe for changes setting) Adds a listener to the `setting`, so every time the value of the `setting` changes, a new `Change` will be created and added to the list of changes.
public void	clear(boolean if true, will undo all changes before clearing undoAll) Clears the change history.
public ReadOnlyObjectProperty<Change<P>>	currentChangeProperty()
private int	Returns: the position value before the decrementation decrementPosition() Equals to the same as: "return position--" if position was an Integer.
public void	doWithoutListeners(Setting<E extends Element<E extends Element<E>>, P extends Property<T>> the setting, whose ChangeListener should be ignored setting, Runnable the action to be performed action) Enables to perform an action, without firing the attached ChangeListener of a Setting.
public ObservableList<Change<P>>	getChanges()
private boolean	hasNext()
private boolean	hasPrev()
private int	Returns: the position value before the incrementation incrementPosition() Equals to the same as: "return ++position" if position was an Integer.
public boolean	isListenerActive()
public boolean	isRedoAvailable()
public boolean	isUndoAvailable()
public ReadOnlyBooleanProperty	listenerActiveProperty()
private Change<P>	next()
private Change<P>	prev()
public boolean	Returns: true if successful, false if there are no changes to redo redo() Redos a change in the history.
public void	redoAll() Redos all changes in the history.
public BooleanProperty	redoAvailableProperty()
public void	setListenerActive(boolean listenerActive)
private void	setupBindings()
public boolean	Returns: true if successful, false if there are no changes to undo undo() Undos a change in the history.
public void	undoAll() Undos all changes in the history.
public BooleanProperty	undoAvailableProperty()

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

changes	back to summary
private ObservableList<Change<P>> changes

currentChange	back to summary
private SimpleObjectProperty<Change<P>> currentChange

listenerActive	back to summary
private BooleanProperty listenerActive

LOGGER	back to summary
private static final Logger LOGGER

position	back to summary
private IntegerProperty position

redoAvailable	back to summary
private BooleanProperty redoAvailable

undoAvailable	back to summary
private BooleanProperty undoAvailable

validPosition	back to summary
private IntegerProperty validPosition

History	back to summary
public History() Initializes a new history object.

Method Detail

addChange	back to summary
private void addChange(Change<P> change)

attachChangeListener back to summary

attachChangeListener	back to summary
public void attachChangeListener(Setting<E extends Element<E extends Element<E>>, P extends Property<T>> setting) Adds a listener to the `setting`, so every time the value of the `setting` changes, a new `Change` will be created and added to the list of changes. Parameters setting:Setting<E extends Element<E extends Element<E>>, P extends Property<T>> the setting to observe for changes

public void attachChangeListener(Setting<E extends Element<E extends Element<E>>, P extends Property<T>> setting)

Adds a listener to the setting, so every time the value of the setting changes, a new Change will be created and added to the list of changes.

Parameters

setting:Setting<E extends Element<E extends Element<E>>, P extends Property<T>>: the setting to observe for changes

clear	back to summary
public void clear(boolean undoAll) Clears the change history. Parameters undoAll:boolean if true, will undo all changes before clearing

clear

back to summary

public void clear(boolean undoAll)

Clears the change history.

Parameters

undoAll:boolean: if true, will undo all changes before clearing

currentChangeProperty	back to summary
public ReadOnlyObjectProperty<Change<P>> currentChangeProperty()

decrementPosition	back to summary
private int decrementPosition() Equals to the same as: "return position--" if position was an Integer. Returns:int the position value before the decrementation

decrementPosition

back to summary

private int decrementPosition()

Equals to the same as: "return position--" if position was an Integer.

Returns:int: the position value before the decrementation

doWithoutListeners	back to summary
public void doWithoutListeners(Setting<E extends Element<E extends Element<E>>, P extends Property<T>> setting, Runnable action) Enables to perform an action, without firing the attached ChangeListener of a Setting. This is used by undo and redo, since those shouldn't cause a new change to be added. Parameters setting:Setting<E extends Element<E extends Element<E>>, P extends Property<T>> the setting, whose ChangeListener should be ignored action:Runnable the action to be performed

doWithoutListeners

back to summary

public void doWithoutListeners(Setting<E extends Element<E extends Element<E>>, P extends Property<T>> setting, Runnable action)

Enables to perform an action, without firing the attached ChangeListener of a Setting. This is used by undo and redo, since those shouldn't cause a new change to be added.

Parameters

setting:Setting<E extends Element<E extends Element<E>>, P extends Property<T>>: the setting, whose ChangeListener should be ignored
action:Runnable: the action to be performed

getChanges	back to summary
public ObservableList<Change<P>> getChanges()

hasNext	back to summary
private boolean hasNext()

hasPrev	back to summary
private boolean hasPrev()

incrementPosition	back to summary
private int incrementPosition() Equals to the same as: "return ++position" if position was an Integer. Returns:int the position value before the incrementation

incrementPosition

back to summary

private int incrementPosition()

Equals to the same as: "return ++position" if position was an Integer.

Returns:int: the position value before the incrementation

isListenerActive	back to summary
public boolean isListenerActive()

isRedoAvailable	back to summary
public boolean isRedoAvailable()

isUndoAvailable	back to summary
public boolean isUndoAvailable()

listenerActiveProperty	back to summary
public ReadOnlyBooleanProperty listenerActiveProperty()

next	back to summary
private Change<P> next()

prev	back to summary
private Change<P> prev()

redo	back to summary
public boolean redo() Redos a change in the history. Returns:boolean true if successful, false if there are no changes to redo

redo

back to summary

public boolean redo()

Redos a change in the history.

Returns:boolean: true if successful, false if there are no changes to redo

redoAll	back to summary
public void redoAll() Redos all changes in the history.

redoAvailableProperty	back to summary
public BooleanProperty redoAvailableProperty()

setListenerActive	back to summary
public void setListenerActive(boolean listenerActive)

setupBindings	back to summary
private void setupBindings()

undo	back to summary
public boolean undo() Undos a change in the history. Returns:boolean true if successful, false if there are no changes to undo

undo

back to summary

public boolean undo()

Undos a change in the history.

Returns:boolean: true if successful, false if there are no changes to undo

undoAll	back to summary
public void undoAll() Undos all changes in the history.

undoAvailableProperty	back to summary
public BooleanProperty undoAvailableProperty()

public Class History

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail