Package com.j3d.engine.react.history

Class History

java.lang.Object

java.util.AbstractCollection<Action<?>>

java.util.AbstractList<Action<?>>

java.util.ArrayList<Action<?>>

com.j3d.engine.react.history.History

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Action<?>>, Collection<Action<?>>, List<Action<?>>, RandomAccess, SequencedCollection<Action<?>>

public class History
extends ArrayList<Action<?>>

Manages a history of actions, allowing for undo and redo functionality. It extends ArrayList to store Action objects.

Author:

Lehlogonolo Poole

See Also:

• Action
• Backup
• HistoryPanel
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final Backup	backup	Where actions that are undone are stored for redo functionality.
static final String	logHead
private static final int	MAX_HISTORY_SIZE
static HistoryPanel	panel
private static final long	serialVersionUID	Serial version UID for serialization.

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
History()

Method Summary

Modifier and Type	Method	Description
boolean	add(Action<?> action)
void	apply(Action<?> action)	Applies a given action by either redoing it from the backup or undoing actions from the history until the target action is reached.
private void	bypassAdd(Action<?> action)	Adds an action to the history, bypassing the size limit and backup clearing.
void	clear()
private static void	clearLocators()
void	redo()	Removes and returns the last action in the history.
private static void	repaint()
void	undo()	Undoes the last action in the history.
private void	updateHistory()	Updates the history panel with the current actions in the history and backup.

Methods inherited from class java.util.ArrayList

add, addAll, addAll, addFirst, addLast, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll, reversed

Field Details

backup

private final Backup backup

Where actions that are undone are stored for redo functionality.

logHead

public static final String logHead

See Also:

• Constant Field Values

panel

public static HistoryPanel panel

serialVersionUID

private static final long serialVersionUID

Serial version UID for serialization.

See Also:

• Constant Field Values

MAX_HISTORY_SIZE

private static final int MAX_HISTORY_SIZE

See Also:

• Constant Field Values

Constructor Details

History

public History()

Method Details

undo

public void undo()

Undoes the last action in the history.

redo

public void redo()

Removes and returns the last action in the history.

repaint

private static void repaint()

bypassAdd

private void bypassAdd(Action<?> action)

Adds an action to the history, bypassing the size limit and backup clearing. This is used for redoing actions.

Parameters:

action - The action to add.

add

public boolean add(Action<?> action)

Specified by:

add in interface Collection<Action<?>>

Specified by:

add in interface List<Action<?>>

Overrides:

add in class ArrayList<Action<?>>

clear

public void clear()

Specified by:

clear in interface Collection<Action<?>>

Specified by:

clear in interface List<Action<?>>

Overrides:

clear in class ArrayList<Action<?>>

clearLocators

private static void clearLocators()

updateHistory

private void updateHistory()

Updates the history panel with the current actions in the history and backup. This method clears the existing panels and repopulates them.

apply

public void apply(Action<?> action)

Applies a given action by either redoing it from the backup or undoing actions from the history until the target action is reached.

Parameters:

action - The action to apply.