java.lang.Object
- nl.siegmann.epublib.browsersupport.NavigationHistory

All Implemented Interfaces:

NavigationEventListener
```
public class NavigationHistory
extends java.lang.Object
implements NavigationEventListener
```
A history of the user's locations with the epub.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

private static class NavigationHistory.Location

Field Summary

Fields
Modifier and Type	Field	Description
`private int`	`currentPos`
`private int`	`currentSize`
`private static long`	`DEFAULT_HISTORY_WAIT_TIME`
`static int`	`DEFAULT_MAX_HISTORY_SIZE`
`private long`	`historyWaitTime`
`private long`	`lastUpdateTime`
`private java.util.List<NavigationHistory.Location>`	`locations`
`private int`	`maxHistorySize`
`private Navigator`	`navigator`

Constructor Summary

Constructors
Constructor Description

NavigationHistory(Navigator navigator)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addLocation(java.lang.String href)`
`void`	`addLocation(NavigationHistory.Location location)`	Adds the location after the current position.
`void`	`addLocation(Resource resource)`
`private void`	`checkHistorySize()`	Removes all elements that are too much for the maxHistorySize out of the history.
`java.lang.String`	`getCurrentHref()`
`int`	`getCurrentPos()`
`int`	`getCurrentSize()`
`long`	`getHistoryWaitTime()`	If the time between a navigation event is less than the historyWaitTime then the new location is not added to the history.
`private java.lang.String`	`getLocationHref(int pos)`
`int`	`getMaxHistorySize()`
`void`	`initBook(Book book)`
`boolean`	`move(int delta)`	Moves the current positions delta positions.
`void`	`navigationPerformed(NavigationEvent navigationEvent)`	If this is not the source of the navigationEvent then the addLocation will be called with the href of the currentResource in the navigationEvent.
`void`	`setHistoryWaitTime(long historyWaitTime)`
`void`	`setMaxHistorySize(int maxHistorySize)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_MAX_HISTORY_SIZE
```
public static final int DEFAULT_MAX_HISTORY_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HISTORY_WAIT_TIME
```
private static final long DEFAULT_HISTORY_WAIT_TIME
```
    See Also:
    
    Constant Field Values
  - lastUpdateTime
```
private long lastUpdateTime
```
  - locations
```
private java.util.List<NavigationHistory.Location> locations
```
  - navigator
```
private Navigator navigator
```
  - currentPos
```
private int currentPos
```
  - currentSize
```
private int currentSize
```
  - maxHistorySize
```
private int maxHistorySize
```
  - historyWaitTime
```
private long historyWaitTime
```
- Constructor Detail
  - NavigationHistory
```
public NavigationHistory(Navigator navigator)
```
- Method Detail
  - getCurrentPos
```
public int getCurrentPos()
```
  - getCurrentSize
```
public int getCurrentSize()
```
  - initBook
```
public void initBook(Book book)
```
  - getHistoryWaitTime
```
public long getHistoryWaitTime()
```
    If the time between a navigation event is less than the historyWaitTime then the new location is not added to the history. When a user is rapidly viewing many pages using the slider we do not want all of them to be added to the history.
    
    Returns:
    
    the time we wait before adding the page to the history
  - setHistoryWaitTime
```
public void setHistoryWaitTime(long historyWaitTime)
```
  - addLocation
```
public void addLocation(Resource resource)
```
  - addLocation
```
public void addLocation(NavigationHistory.Location location)
```
    Adds the location after the current position. If the currentposition is not the end of the list then the elements between the current element and the end of the list will be discarded. Does nothing if the new location matches the current location.
    If this nr of locations becomes larger then the historySize then the first item(s) will be removed.
    
    Parameters:
    
    location -
  - checkHistorySize
```
private void checkHistorySize()
```
    Removes all elements that are too much for the maxHistorySize out of the history.
  - addLocation
```
public void addLocation(java.lang.String href)
```
  - getLocationHref
```
private java.lang.String getLocationHref(int pos)
```
  - move
```
public boolean move(int delta)
```
    Moves the current positions delta positions. move(-1) to go one position back in history.
    move(1) to go one position forward.
    
    Parameters:
    
    delta -
    
    Returns:
    
    Whether we actually moved. If the requested value is illegal it will return false, true otherwise.
  - navigationPerformed
```
public void navigationPerformed(NavigationEvent navigationEvent)
```
    If this is not the source of the navigationEvent then the addLocation will be called with the href of the currentResource in the navigationEvent.
    
    Specified by:
    
    navigationPerformed in interface NavigationEventListener
  - getCurrentHref
```
public java.lang.String getCurrentHref()
```
  - setMaxHistorySize
```
public void setMaxHistorySize(int maxHistorySize)
```
  - getMaxHistorySize
```
public int getMaxHistorySize()
```

Class NavigationHistory

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_HISTORY_SIZE

DEFAULT_HISTORY_WAIT_TIME

lastUpdateTime

locations

navigator

currentPos

currentSize

maxHistorySize

historyWaitTime

Constructor Detail

NavigationHistory

Method Detail

getCurrentPos

getCurrentSize

initBook

getHistoryWaitTime

setHistoryWaitTime

addLocation

addLocation

checkHistorySize

addLocation

getLocationHref

move

navigationPerformed

getCurrentHref

setMaxHistorySize

getMaxHistorySize