org.docgene.help.utils

Class NavigationHistory

java.lang.Object

org.docgene.help.utils.NavigationHistory

public class NavigationHistory
extends java.lang.Object

Handle the navigation history.

Constructor Summary

Constructors

Constructor and Description
NavigationHistory()

Method Summary

Modifier and Type	Method and Description
HistoryElement	back() Apply a back action.
HistoryElement	back(HistoryElement element) Apply a back action.
HistoryElement	back(java.lang.String urlS) Apply a back action.
HistoryElement	back(java.lang.String urlS, java.lang.String anchor) Apply a back action.
HistoryElement	backFromFulltextSearch(java.lang.String content) Apply a back action from the full text search content.
void	clear() Clear the history.
HistoryElement	forward() Apply a forward action.
HistoryElement	getCurrentElement() Return the current element.
int	getCurrentSize() Return the current size of the history.
java.util.List<HistoryElement>	getNext() Return the next history.
java.util.List<HistoryElement>	getPrevious() Return the previous history.
boolean	hasNext() Return true if the history has a next element.
boolean	hasPrevious() Return true if the history has a previous lement.
void	setMaxSize(int maxSize) Set the maximum size of the history.
void	visit(HistoryElement element) Visit a history element.
void	visit(java.lang.String urlS) Visit an URL.
void	visit(java.lang.String urlS, java.lang.String anchor) Visit an URL.
void	visit(java.net.URL url) Visit an URL.
void	visit(java.net.URL url, java.lang.String anchor) Visit an URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationHistory

public NavigationHistory()

Method Detail

setMaxSize

public void setMaxSize(int maxSize)

Set the maximum size of the history.

Parameters:

maxSize - the maximum size

getCurrentSize

public int getCurrentSize()

Return the current size of the history.

Returns:

the current size

hasPrevious

public boolean hasPrevious()

Return true if the history has a previous lement.

Returns:

true if the history has a previous lement

getPrevious

public java.util.List<HistoryElement> getPrevious()

Return the previous history.

Returns:

the previous history

hasNext

public boolean hasNext()

Return true if the history has a next element.

Returns:

true if the history has a next element

getNext

public java.util.List<HistoryElement> getNext()

Return the next history.

Returns:

the next history

backFromFulltextSearch

public HistoryElement backFromFulltextSearch(java.lang.String content)

Apply a back action from the full text search content.

Parameters:

content - the full text search content

Returns:

the new HistoryElement

back

public HistoryElement back(java.lang.String urlS)

Apply a back action.

Parameters:

urlS - the current URL as a String

Returns:

the new HistoryElement

back

public HistoryElement back(java.lang.String urlS,
                           java.lang.String anchor)

Apply a back action.

Parameters:

urlS - the current URL as a String

anchor - the anchor

Returns:

the new HistoryElement

back

public HistoryElement back()

Apply a back action.

Returns:

the new HistoryElement

back

public HistoryElement back(HistoryElement element)

Apply a back action.

Parameters:

element - the history element

Returns:

the new URL

forward

public HistoryElement forward()

Apply a forward action.

Returns:

the new URL

getCurrentElement

public HistoryElement getCurrentElement()

Return the current element.

Returns:

the current element

visit

public void visit(java.lang.String urlS)

Visit an URL.

Parameters:

urlS - the URL as a String

visit

public void visit(HistoryElement element)

Visit a history element.

Parameters:

element - the history element

visit

public void visit(java.lang.String urlS,
                  java.lang.String anchor)

Visit an URL.

Parameters:

urlS - the URL as a String

anchor - the anchor

visit

public void visit(java.net.URL url)

Visit an URL.

Parameters:

url - the URL

visit

public void visit(java.net.URL url,
                  java.lang.String anchor)

Visit an URL.

Parameters:

url - the URL

anchor - the anchor

clear

public void clear()

Clear the history.