org.gwtopenmaps.openlayers.client.control
Class NavigationHistory

java.lang.Object
  org.gwtopenmaps.openlayers.client.util.JSObjectWrapper
      org.gwtopenmaps.openlayers.client.OpenLayersObjectWrapper
          org.gwtopenmaps.openlayers.client.OpenLayersEObjectWrapper
              org.gwtopenmaps.openlayers.client.control.Control
                  org.gwtopenmaps.openlayers.client.control.NavigationHistory

public class NavigationHistory
extends Control

Author:

Maciej Jezierski - Pinocchio

Field Summary

Fields inherited from class org.gwtopenmaps.openlayers.client.OpenLayersEObjectWrapper

eventListeners

Constructor Summary

NavigationHistory()

NavigationHistory(JSObject element)
TODO hughesa - should this be protected or public?

NavigationHistory(NavigationHistoryOptions options)

Method Summary

void	autoActivate(boolean autoActivate) Activate the control when it is added to a map.
void	clear() APIMethod: clear Clear history.
Control	getNext()
Control	getPrevious()
void	limit(int limit) Optional limit on the number of history items to retain.
void	next() Switch map view to next step in browser's history.
JSObject	nextTrigger() TODO ahhughes, should this return JSObject or void? APIMethod: nextTrigger Restore the next state.
void	previous() Switch map view to a previous step in browser's history.
void	previousTrigger() Method: previousTrigger Restore the previous state.

Methods inherited from class org.gwtopenmaps.openlayers.client.control.Control

activate, addControlActivateListener, addControlDeactivateListener, deactivate, disable, enable, getControlId, getLayer, getMap, getZIndex, isActive, narrowToControl, setAutoActivate

Methods inherited from class org.gwtopenmaps.openlayers.client.OpenLayersEObjectWrapper

getListeners, narrowToOpenLayersEObjectWrapper, removeListener

Methods inherited from class org.gwtopenmaps.openlayers.client.OpenLayersObjectWrapper

getClassName, getEvents, narrowToOpenLayersObjectWrapper

Methods inherited from class org.gwtopenmaps.openlayers.client.util.JSObjectWrapper

getJSObject, setJSObject

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationHistory

public NavigationHistory(JSObject element)

TODO hughesa - should this be protected or public?

Parameters:

element -

NavigationHistory

public NavigationHistory()

NavigationHistory

public NavigationHistory(NavigationHistoryOptions options)

Method Detail

previous

public void previous()

Switch map view to a previous step in browser's history.

next

public void next()

Switch map view to next step in browser's history.

limit

public void limit(int limit)

Optional limit on the number of history items to retain. If null, there is no limit. Default is 50.

Parameters:

limit - - number of items

autoActivate

public void autoActivate(boolean autoActivate)

Activate the control when it is added to a map. Default is true. If set to false, activate() method must be fired in order to use the control with map.

Parameters:

autoActivate - - set automatic activation true or false

nextTrigger

public JSObject nextTrigger()

TODO ahhughes, should this return JSObject or void? APIMethod: nextTrigger Restore the next state. If no items are in the next history stack, this has no effect. The next history stack is populated as states are restored from the previous history stack. Returns: {Object} Item representing state that was restored. Undefined if no items are in the next history stack.

Parameters:

void -

Returns:

JSObject - Item representing state that was restored. Undefined if no items are in the next history stack.

getPrevious

public Control getPrevious()

Returns:

Previous Control

getNext

public Control getNext()

Returns:

Next Control

previousTrigger

public void previousTrigger()

Method: previousTrigger Restore the previous state. If no items are in the previous history stack, this has no effect. Returns: {Object} Item representing state that was restored. Undefined if no items are in the previous history stack.

clear

public void clear()

APIMethod: clear Clear history.