oracle.javatools.history
Interface HistoryModel

All Known Implementing Classes:

AbstractHistoryModel, DefaultHistoryModel

public interface HistoryModel

The model for HistoryComponent. The history is made up of a series of HistoryEntry instances. Each entry may have properties, defined by HistoryProperty.

Since:

10.0.3

Method Summary

void	addHistoryModelListener(HistoryModelListener vhl) Add a listener that will be notified of changes to this model.
HistoryProperty[]	getDefaultProperties() Get all default available properties for entries in this history.
HistoryEntry	getEntry(int index) Get the entry at the specified index in this history.
HistoryProperty[]	getProperties() Get all available properties for entries in this history.
int	getSize() Get the number of entries in this model.
boolean	isComplete() Whether the model is complete.
void	removeHistoryModelListener(HistoryModelListener vhl) Remove a listener previously added via the addVersionHistoryListener method.

Method Detail

getSize

int getSize()

Get the number of entries in this model.

Returns:

the number of entries in this model.

getEntry

HistoryEntry getEntry(int index)

Get the entry at the specified index in this history.

Parameters:

index - the index of the entry

Returns:

the history entry.

getProperties

HistoryProperty[] getProperties()

Get all available properties for entries in this history.

Returns:

an array of properties available for entries in this history.

getDefaultProperties

HistoryProperty[] getDefaultProperties()

Get all default available properties for entries in this history.

Returns:

an array of properties available by default for entries in this history.

addHistoryModelListener

void addHistoryModelListener(HistoryModelListener vhl)

Add a listener that will be notified of changes to this model.

Parameters:

vhl - a listener to add.

removeHistoryModelListener

void removeHistoryModelListener(HistoryModelListener vhl)

Remove a listener previously added via the addVersionHistoryListener method.

Parameters:

vhl - a listener to remove.

isComplete

boolean isComplete()

Whether the model is complete. This is used when the model is being built asynchronously. The version history viewer may check the value of this property when version history events are fired to see whether any actions requiring a complete model should be enabled.

Returns:

true if this model is complete, false if it's still in the process of being built.