package org.litesoft.GWT.client.pavsupport;

import com.google.gwt.place.shared.*;

public interface PlaceChangeListener {
    enum Source {
        Forward, // The Place Change is the result of calling PlaceChanger.goForwardTo( pNewPlace ).
        Back, // The Place Change is the result of calling PlaceChanger.goBack().
        Unexpected // The Place Change does not appear to be the result of calling a PlaceChanger method (such as a deep link).
    }

    /**
     * This method is called whenever the PAM changes its CurrentPlace.
     *
     * @param pSource        the "source" if know of the of the pNewPlace (derived from the PlaceChanger method call).
     * @param pPreviousPlace the previous CurrentPlace (this could be Place.NOWHERE).
     * @param pNewPlace      the "new" CurrentPlace.
     */
    void placeChange( Source pSource, Place pPreviousPlace, Place pNewPlace );
}