001package votorola.a.web.wic; // Copyright 2008, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.
002
003import votorola.g.lang.*;
004
005
006/** A page to which the user can navigate, through a hierarchy of tabs.  At the moment,
007  * this interface serves only as documentation; its methods are called by the page during
008  * its construction, and not by external clients.
009  */
010public @ThreadRestricted("wicket") interface TabbedPage
011{
012
013   // - T a b b e d - P a g e ------------------------------------------------------------
014
015
016    /** Finds and returns the navigation tab for this page.  In cases where a single page
017      * class has multiple tabs (corresponding, for example, to multiple pages with
018      * different parameters) the search will extend through the hierarchy of navigation
019      * bars.
020      */
021    public NavTab navTab( VRequestCycle cycle );
022
023
024
025}