|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.pepper.guiutils.browser.BaseHistoryListener
public class BaseHistoryListener
Base implementation of PepperHistoryListener
Field Summary | |
---|---|
protected GuiServicesProvider |
gsp
|
Constructor Summary | |
---|---|
BaseHistoryListener(String packageId)
Called by JRex |
Method Summary | |
---|---|
void |
addEntry(PepperHistoryEvent event)
Notify a listener when a new document is added to the history. |
boolean |
goBack(PepperHistoryEvent event)
Notify a listener when the browser attempts to go back one page in its history, usually because the user pressed the 'back' button. |
boolean |
goForward(PepperHistoryEvent event)
Notify a listener when the browser attempts to go forward one page in its history, usually because the user pressed the 'forward' button. |
boolean |
goToIndex(PepperHistoryEvent event)
Notify a listener when the browser attempts to visit an arbitrary page in the history, usually because the user chose that page to load from a popup or other menu. |
boolean |
purge(PepperHistoryEvent event)
called to notify a listener when documents are removed from session history. |
boolean |
reload(PepperHistoryEvent event)
Notify a listener when the browser attempts to reload the current page, usually because the user clicked the 'reload' button. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected GuiServicesProvider gsp
Constructor Detail |
---|
public BaseHistoryListener(String packageId)
Method Detail |
---|
public void addEntry(PepperHistoryEvent event)
PepperHistoryListener
addEntry
in interface PepperHistoryListener
public boolean goBack(PepperHistoryEvent event)
PepperHistoryListener
goBack
in interface PepperHistoryListener
true
, it indicates
that the back operation can be continued else back operation will be aborted.
This is a mechanism for the listener to control user's operations with history.public boolean goForward(PepperHistoryEvent event)
PepperHistoryListener
goForward
in interface PepperHistoryListener
true
, it indicates
that the forward operation can be continued else forward operation will be aborted.
This is a mechanism for the listener to control user's operations with history.public boolean reload(PepperHistoryEvent event)
PepperHistoryListener
reload
in interface PepperHistoryListener
true
, it indicates
that the reload operation can be continued else reload operation will be aborted.
This is a mechanism for the listener to control user's operations with history.public boolean goToIndex(PepperHistoryEvent event)
PepperHistoryListener
index
value contains the
index in the history of the document to be loaded.
goToIndex
in interface PepperHistoryListener
true
, it indicates
that the GotoIndex operation can be continued else GotoIndex operation will be aborted.
This is a mechanism for the listener to control user's operations with history.public boolean purge(PepperHistoryEvent event)
PepperHistoryListener
purge
in interface PepperHistoryListener
true
, it indicates
that the purge operation can be continued else purge operation will be aborted.
This is a mechanism for the listener to control user's operations with history.
Note:- While purging history, the older documents are removed
and newly loaded documents are kept. For example if there
are 5 documents in history, and purge is called with 3 entries
to be removed, then document 1, 2 and 3 are removed from history
and most recently loaded document 4 and 5 are kept.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |