public abstract class HistoryManager
extends java.lang.Object
Extensions should use the declarative hook history-provider-hook to register history providers.
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
JNDI_NAME
The implementation of HistoryManager is stored in this
JNDI name.
|
Constructor and Description |
---|
HistoryManager() |
Modifier and Type | Method and Description |
---|---|
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.
|
protected static final java.lang.String JNDI_NAME
public CustomFilterManager getCustomFilterManager()
public HistoryFilter getAllFilter()
public static final HistoryManager getHistoryManager()
@Deprecated public void registerProvider(HistoryProvider provider)
provider
- an object that supplies history entries.@Deprecated public void unregisterProvider(HistoryProvider provider)
provider
- an object previously registered via registerProvider.public java.util.Collection getProviders()
public java.util.Collection getProviders(java.lang.String identifier)
public final ContextMenu getContextMenu()
public final HistoryComponent createHistoryComponent()
public final HistoryComponent createHistoryComponent(HistoryModel model)
url
- the URL to get a history component for.public abstract void showHistory(Context context)
node
- the Context to display history for.public abstract void showHistory(Node node)
node
- the Node to display history for.public abstract void updateHistory(java.net.URL url)
url
- the url of the history to update.public HistoryModel buildModel(java.net.URL url, boolean isAsynchronous, HistoryFilter filter)
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.public HistoryModel buildModel(java.net.URL url, boolean isAsynchronous, HistoryFilter filter, java.util.Collection providers)
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.