gov.nih.nlm.nls.vtt.Model
Class UndoNode

java.lang.Object
  gov.nih.nlm.nls.vtt.Model.UndoNode

public class UndoNode
extends java.lang.Object

This is the undo node class. It includes a list of UndoBase of ADD, DELETE, CHANGE. This class is used directly in VTT for undo and redo managers.

History:

Version:

V-2010

Author:

NLM NLS Development Team, clu

Constructor Summary

UndoNode()
Create an undo node Java object with default values.

UndoNode(int action)
Create an undo node Java object by specifying action.

UndoNode(int action, Markup cur, Markup prev)
Create an undo node Java object with default values.

Method Summary

void	AddUndoBase(UndoBase undoBase) Add undoBase to undo bases.
UndoBase	GetFirstUndoBase() Get the first undo base from bases list.
UndoBase	GetLastUndoBase() Get the last undo base from bases list.
int	GetSize() Get size of bases list.
UndoBase	GetUndoBase(int index) Get undoBase from undo bases list.
java.util.Vector<UndoBase>	GetUndoBases() Get the undo bases list.
void	SetAction(int action) Set the action.
java.lang.String	ToString() Converts undoNode to String representation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UndoNode

public UndoNode()

Create an undo node Java object with default values.

UndoNode

public UndoNode(int action)

Create an undo node Java object by specifying action. This is used for multiple undoNode base operations: join, override

Parameters:

action - action on markup

UndoNode

public UndoNode(int action,
                Markup cur,
                Markup prev)

Create an undo node Java object with default values. This is used for one undoNode base operation: add, delete, change

Parameters:

action - action on markup

cur - current markup

prev - previous markup

Method Detail

AddUndoBase

public void AddUndoBase(UndoBase undoBase)

Add undoBase to undo bases.

Parameters:

undoBase - undoBase to be added

GetUndoBase

public UndoBase GetUndoBase(int index)

Get undoBase from undo bases list.

Parameters:

index - the index of interest

Returns:

undoBase of interest

GetSize

public int GetSize()

Get size of bases list.

Returns:

size of undoBases list

GetFirstUndoBase

public UndoBase GetFirstUndoBase()

Get the first undo base from bases list.

Returns:

the first undo base from undoBases list

GetLastUndoBase

public UndoBase GetLastUndoBase()

Get the last undo base from bases list.

Returns:

the last undo base from undoBases list

GetUndoBases

public java.util.Vector<UndoBase> GetUndoBases()

Get the undo bases list.

Returns:

the undo base list

SetAction

public void SetAction(int action)

Set the action.

Parameters:

action - the action to be set

ToString

public java.lang.String ToString()

Converts undoNode to String representation.

Returns:

string representation of undo node