oracle.jdeveloper.history
Class HistoryManager

java.lang.Object
  oracle.jdeveloper.history.HistoryManager

public abstract class HistoryManager
extends java.lang.Object

The HistoryManager provides a mechanism for extensions to register HistoryProvider instances, which are used to retrieve a list of history entries for a URL for the history viewer.

Extensions should use the declarative hook history-provider-hook to register history providers.

Since:

10.0.3

Field Summary

protected static java.lang.String

JNDI_NAME The implementation of HistoryManager is stored in this JNDI name.

Constructor Summary

HistoryManager()

Method Summary

HistoryModel	buildModel(java.net.URL url, boolean isAsynchronous, HistoryFilter filter) Retrieve a HistoryModel for the specified URL.
HistoryModel	buildModel(java.net.URL url, boolean isAsynchronous, HistoryFilter filter, java.util.Collection providers) Retrieve a HistoryModel for the specified URL.
HistoryComponent	createHistoryComponent() Create a history component with no initial model.
HistoryComponent	createHistoryComponent(HistoryModel model) Obtain a history component for the specified URL.
HistoryFilter	getAllFilter() Get the predefined filter that returns all items in the history.
ContextMenu	getContextMenu() Get the context menu that is displayed in the history viewer.
CustomFilterManager	getCustomFilterManager() Get the manager for registered custom filters.
static HistoryManager	getHistoryManager() Get the history manager.
java.util.Collection	getProviders() Get all registered providers.
java.util.Collection	getProviders(java.lang.String identifier) Get all registered providers by idenitier
void	registerProvider(HistoryProvider provider) Deprecated. replaced by declarative registration through history-provider-hook.
abstract void	showHistory(Context context) Request that the history be shown for the specified Context.
abstract void	showHistory(Node node) Request that the history be shown for the specified Node.
void	unregisterProvider(HistoryProvider provider) Deprecated. not replaced.
abstract void	updateHistory(java.net.URL url) Request that the history for the specified URL be updated if it is currently visible via a history viewer.

Methods inherited from class java.lang.Object

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

Field Detail

JNDI_NAME

protected static final java.lang.String JNDI_NAME

The implementation of HistoryManager is stored in this JNDI name.

See Also:

Constant Field Values

Constructor Detail

HistoryManager

public HistoryManager()

Method Detail

getCustomFilterManager

public CustomFilterManager getCustomFilterManager()

Get the manager for registered custom filters.

Returns:

the custom filter manager.

getAllFilter

public HistoryFilter getAllFilter()

Get the predefined filter that returns all items in the history.

Returns:

the predefined "all" filter.

getHistoryManager

public static final HistoryManager getHistoryManager()

Get the history manager.

Returns:

the singleton history manager. This may return null if the history extension has been turned off.

registerProvider

@Deprecated
public void registerProvider(HistoryProvider provider)

Deprecated. replaced by declarative registration through history-provider-hook.

Register a provider with the manager.

Parameters:

provider - an object that supplies history entries.

unregisterProvider

@Deprecated
public void unregisterProvider(HistoryProvider provider)

Deprecated. not replaced.

Unregister a provider from the manager.

Parameters:

provider - an object previously registered via registerProvider.

getProviders

public java.util.Collection getProviders()

Get all registered providers.

Returns:

a collection of providers. The returned collection is unmodifiable.

getProviders

public java.util.Collection getProviders(java.lang.String identifier)

Get all registered providers by idenitier

Returns:

a collection of providers. The returned collection is unmodifiable.

getContextMenu

public final ContextMenu getContextMenu()

Get the context menu that is displayed in the history viewer. There is a single shared ContextMenu instance for all history viewers. Extensions can listen to this context menu to add menu items.

Returns:

a ContextMenu instance.

createHistoryComponent

public final HistoryComponent createHistoryComponent()

Create a history component with no initial model.

Returns:

a history component with no initial model.

createHistoryComponent

public final HistoryComponent createHistoryComponent(HistoryModel model)

Obtain a history component for the specified URL. This can be used to e.g. display the history for an element in a dialog.

Parameters:

url - the URL to get a history component for.

showHistory

public abstract void showHistory(Context context)

Request that the history be shown for the specified Context.

Parameters:

node - the Context to display history for.

showHistory

public abstract void showHistory(Node node)

Request that the history be shown for the specified Node.

Parameters:

node - the Node to display history for.

updateHistory

public abstract void updateHistory(java.net.URL url)

Request that the history for the specified URL be updated if it is currently visible via a history viewer. This will cause all providers for the specified URL to be requeried.

Parameters:

url - the url of the history to update.

buildModel

public HistoryModel buildModel(java.net.URL url,
                               boolean isAsynchronous,
                               HistoryFilter filter)

Retrieve a HistoryModel for the specified URL. You may specify whether the model is build synchronously or asynchronously. If asynchronous, this method will return immediately and you will have to listen for the completenessChanged() event on the model to determine when it is fully populated.

Parameters:

url - the url to get the history for.

isAsynchronous - if true, the model should be built on another thread if possible.

filter - an optional filter. Can be null.

Returns:

a HistoryModel. You can check the isComplete() method to see whether the model has been fully populated.

buildModel

public HistoryModel buildModel(java.net.URL url,
                               boolean isAsynchronous,
                               HistoryFilter filter,
                               java.util.Collection providers)

Retrieve a HistoryModel for the specified URL. You may specify whether the model is build synchronously or asynchronously. If asynchronous, this method will return immediately and you will have to listen for the completenessChanged() event on the model to determine when it is fully populated.

Parameters:

url - the url to get the history for.

isAsynchronous - if true, the model should be built on another thread if possible.

filter - an optional filter. Can be null.

providers - the list of history providers.

Returns:

a HistoryModel. You can check the isComplete() method to see whether the model has been fully populated.