ej.widget.navigation.stack

Interface PageStack

All Known Implementing Classes:

PageStackReference, PageStackURL

public interface PageStack

A pages stack is responsible for the pages history management.

Method Summary

Modifier and Type	Method and Description
Page	elementAt(int index) Gets the page at an index.
boolean	isEmpty() Gets whether the stack is empty or not.
Page	peek() Gets the page at the top of the stack.
Page	pop() Gets and removes the page at the top of the stack.
Page	popUntil(java.lang.String url) Gets and removes the last page pushed with a URL.
void	push(Page page) Pushes a page at the top of the stack.
void	removeAll() Removes all pages in the stack.
int	size() Gets the number of pages in the stack.

Method Detail

isEmpty

boolean isEmpty()

Gets whether the stack is empty or not.

Returns:

true if the stack is empty, false otherwise.

push

void push(Page page)

Pushes a page at the top of the stack.

Parameters:

page - the page to push.

pop

Page pop()
  throws java.util.EmptyStackException

Gets and removes the page at the top of the stack.

Returns:

the page at the top of the stack.

Throws:

java.util.EmptyStackException - if the stack is empty.

See Also:

isEmpty()

popUntil

Page popUntil(java.lang.String url)

Gets and removes the last page pushed with a URL. All pages pushed after this page are also removed.

If no page with this URL can be found in the stack, the stack is cleared and a new page is created with this URL.

Parameters:

url - the URL to search for in the stack.

Returns:

a page with the given URL.

See Also:

URLResolver.isSamePage(String, String), URLResolver.resolve(String)

peek

Page peek()
   throws java.util.EmptyStackException

Gets the page at the top of the stack.

Returns:

the page at the top of the stack.

Throws:

java.util.EmptyStackException - if the stack is empty.

See Also:

isEmpty()

removeAll

void removeAll()

Removes all pages in the stack.

elementAt

Page elementAt(int index)
        throws java.lang.ArrayIndexOutOfBoundsException

Gets the page at an index.

Parameters:

index - the index of the page.

Returns:

the page at the given index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

size

int size()

Gets the number of pages in the stack.

Returns:

the number of pages in the stack.