blob: 4a72385eb8949072c6df2775bbe394ab72d40b05 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to you under the Apache License,
Version 2.0 (the "License"); you may not use this file except in
compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document id="navigation-containers">
<properties>
<title>Navigation Containers</title>
</properties>
<body>
<p>
Navigation containers are used to maximize screen real estate, showing or hiding their
children as needed. Navigation containers include:
</p>
<ul>
<li>
<p>
<a href="card-panes.html"><b>CardPane</b></a> - A simple "card stack" of
components, only one of which is visible at a time.
</p>
</li>
<li>
<p>
<a href="tab-panes.html"><b>TabPane</b></a> - Similar to <tt>CardPane</tt> but
with built-in "tabs" for navigation; may optionally be "collapsed" such that
only the tab buttons show.
</p>
</li>
<li>
<p>
<a href="accordions.html"><b>Accordion</b></a> - Similar to <tt>TabPane</tt>,
but subcomponents are presented like the folds of an accordion, with headers
for navigating between panels.
</p>
</li>
<li>
<p>
<a href="expanders.html"><b>Expander</b></a> - Similar to a border but
collapsible such that only the title shows.
</p>
</li>
<li>
<p>
<a href="rollups.html"><b>Rollup</b></a> - Similar to <tt>Expander</tt> but
supports a configurable "header" component; when collapsed, only the header is
visible. Can be nested to create the appearance of a "tree" structure.
</p>
</li>
<li>
<p>
<a href="viewports.html"><b><i>Viewport</i></b></a> - Abstract base class for a
scrollable region. Sublcasses of <tt>Viewport</tt> include:
<ul>
<li>
<a href="scroll-panes.html"><b>ScrollPane</b></a> - A scrollable area
with optional vertical and horizontal scroll bars as well as row and
column headers.
</li>
<li>
<a href="panoramas.html"><b>Panorama</b></a> - A scrollable area with
optional up/down/left/right arrows.
</li>
</ul>
</p>
</li>
</ul>
<p>
Each of these are discussed in detail in the following sections.
</p>
</body>
</document>