blob: a4244c232af83d3712f3ea7fb86df76c679551da [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en" xmlns:vdldoc="http://vdldoc.omnifaces.org" xmlns:fo="http://www.w3.org/1999/XSL/Format" xmlns:jakartaee="https://jakarta.ee/xml/ns/jakartaee">
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>segmentLayout (Tobago Core VDL Documentation)
</title>
<meta name="keywords" content="$title">
<link rel="stylesheet" type="text/css" title="Style" href="../stylesheet.css">
</head>
<body>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="topNav">
<a name="navbar_top"></a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"></a>
<ul class="navList" title="Navigation">
<li>
<a href="../overview-summary.html">Overview</a>
</li>
<li>
<a href="tld-summary.html">Library</a>
</li>
<li class="navBarCell1Rev">Tag</li>
<li>
<a href="../help-doc.html">Help</a>
</li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>
<a target="_top" href="../index.html?tc/segmentLayout.html">
Frames
</a>
</li>
<li>
<a target="_top" href="segmentLayout.html">
No Frames
</a>
</li>
</ul>
<ul class="navList" id="alltags_navbar_top">
<li>
<a href="../alltags-noframe.html">All Tags</a>
</li>
</ul>
<div>
<script type="text/javascript">
document.getElementById("alltags_navbar_top").style.display = (window == top) ? "block" : "none";
</script>
</div>
<a name="skip-navbar_top"></a>
</div>
<div class="header">
<h1 title="Library" class="title">tc</h1>
<h2 class="title">
Tag
segmentLayout</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Description:</dt>
<dd>
<div class="block">
Renders a layout using a 12 columns grid.
Find more information on how the grid works in the Twitter Bootstrap documentation.
If no attribute is defined, extraSmall="12seg" will be used as default.<p><b>UIComponentClass: </b>org.apache.myfaces.tobago.component.UISegmentLayout</p><p><b>RendererType: </b><ul><li>SegmentLayout (default)</li></ul></p><p><b>Supported markups:</b></p><dl><dt><b>spread</b></dt><dd>Use the full height for the HTML content.</dd></dl>
</div>
</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Component summary table, listing component information">
<caption>
<span>Component Information</span><span class="tabEnd">&nbsp;</span>
</caption>
<thead>
<tr>
<th class="colFirst" scope="col">Info</th><th class="colLast" scope="col">Value</th>
</tr>
</thead>
<tbody>
<tr class="rowColor">
<td class="colFirst">Component Type</td><td class="colLast"><code>org.apache.myfaces.tobago.SegmentLayout</code></td>
</tr>
<tr class="altColor">
<td class="colFirst">Handler Class</td><td class="colLast"><code>org.apache.myfaces.tobago.facelets.TobagoComponentHandler</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst">Renderer Type</td><td class="colLast"><code>SegmentLayout</code></td>
</tr>
<tr class="altColor">
<td class="colFirst">Description</td><td class="colLast"><i>None</i></td>
</tr>
</tbody>
</table>
</div>
<div class="summary">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Attribute summary table, listing attribute information">
<caption>
<span>Attributes</span><span class="tabEnd">&nbsp;</span>
</caption>
<thead>
<tr>
<th class="colFirst">Name</th><th class="colOne">Required</th><th class="colOne">Type</th><th class="colLast">Description</th>
</tr>
</thead>
<tbody>
<tr id="binding" class="rowColor">
<td class="colFirst"><a href="#binding"><code>binding</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>javax.faces.component.UIComponent</code>)
</td><td class="colLast">
The value binding expression linking this component to a property in a backing bean.
For Facelets, the component is the outer UIPanel, not the input control.<br />Type: <code>javax.faces.component.UIComponent</code>
</td>
</tr>
<tr id="extraLarge" class="altColor">
<td class="colFirst"><a href="#extraLarge"><code>extraLarge</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>org.apache.myfaces.tobago.layout.SegmentMeasureList</code>)
</td><td class="colLast">
The space-separated definition of the columns for extra large devices.
Possible values are: segment values between 1 and 12, 'auto' and '*'.
Example: '1seg 5seg * auto'<br />Type: <code>org.apache.myfaces.tobago.layout.SegmentMeasureList</code>
</td>
</tr>
<tr id="extraSmall" class="rowColor">
<td class="colFirst"><a href="#extraSmall"><code>extraSmall</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>org.apache.myfaces.tobago.layout.SegmentMeasureList</code>)
</td><td class="colLast">
The space-separated definition of the columns for extra small devices.
Possible values are: segment values between 1 and 12, 'auto' and '*'.
Example: '1seg 5seg * auto'<br />Type: <code>org.apache.myfaces.tobago.layout.SegmentMeasureList</code>
</td>
</tr>
<tr id="id" class="altColor">
<td class="colFirst"><a href="#id"><code>id</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>java.lang.String</code></td><td class="colLast">
The component identifier for this component.
This value must be unique within the closest parent component that is a naming container.<br />Type: <code>java.lang.String</code>
</td>
</tr>
<tr id="large" class="rowColor">
<td class="colFirst"><a href="#large"><code>large</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>org.apache.myfaces.tobago.layout.SegmentMeasureList</code>)
</td><td class="colLast">
The space-separated definition of the columns for large devices.
Possible values are: segment values between 1 and 12, 'auto' and '*'.
Example: '1seg 5seg * auto'<br />Type: <code>org.apache.myfaces.tobago.layout.SegmentMeasureList</code>
</td>
</tr>
<tr id="marginExtraLarge" class="altColor">
<td class="colFirst"><a href="#marginExtraLarge"><code>marginExtraLarge</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.String</code>)
</td><td class="colLast">
The space-separated definition of the column margins for extra large devices.
Allowed values are: none, left, right, both
Example: 'left none both'<br />Type: <code>java.lang.String</code>
</td>
</tr>
<tr id="marginExtraSmall" class="rowColor">
<td class="colFirst"><a href="#marginExtraSmall"><code>marginExtraSmall</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.String</code>)
</td><td class="colLast">
The space-separated definition of the column margins for extra small devices.
Allowed values are: none, left, right, both
Example: 'left none both'<br />Type: <code>java.lang.String</code>
</td>
</tr>
<tr id="marginLarge" class="altColor">
<td class="colFirst"><a href="#marginLarge"><code>marginLarge</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.String</code>)
</td><td class="colLast">
The space-separated definition of the column margins for large devices.
Allowed values are: none, left, right, both
Example: 'left none both'<br />Type: <code>java.lang.String</code>
</td>
</tr>
<tr id="marginMedium" class="rowColor">
<td class="colFirst"><a href="#marginMedium"><code>marginMedium</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.String</code>)
</td><td class="colLast">
The space-separated definition of the column margins for medium devices.
Allowed values are: none, left, right, both
Example: 'left none both'<br />Type: <code>java.lang.String</code>
</td>
</tr>
<tr id="marginSmall" class="altColor">
<td class="colFirst"><a href="#marginSmall"><code>marginSmall</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.String</code>)
</td><td class="colLast">
The space-separated definition of the column margins for small devices.
Allowed values are: none, left, right, both
Example: 'left none both'<br />Type: <code>java.lang.String</code>
</td>
</tr>
<tr id="markup" class="rowColor">
<td class="colFirst"><a href="#markup"><code>markup</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>org.apache.myfaces.tobago.context.Markup</code>)
</td><td class="colLast">
Indicate markup of this component.
The allowed markups can be defined or overridden in the theme.
The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.<br />Type: <code>org.apache.myfaces.tobago.context.Markup</code>
</td>
</tr>
<tr id="medium" class="altColor">
<td class="colFirst"><a href="#medium"><code>medium</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>org.apache.myfaces.tobago.layout.SegmentMeasureList</code>)
</td><td class="colLast">
The space-separated definition of the columns for medium devices.
Possible values are: segment values between 1 and 12, 'auto' and '*'.
Example: '1seg 5seg * auto'<br />Type: <code>org.apache.myfaces.tobago.layout.SegmentMeasureList</code>
</td>
</tr>
<tr id="rendered" class="rowColor">
<td class="colFirst"><a href="#rendered"><code>rendered</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.Boolean</code>)
</td><td class="colLast">
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent form submit.<br />Type: <code>boolean</code><br />Default: <code>true</code>
</td>
</tr>
<tr id="small" class="altColor">
<td class="colFirst"><a href="#small"><code>small</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>org.apache.myfaces.tobago.layout.SegmentMeasureList</code>)
</td><td class="colLast">
The space-separated definition of the columns for small devices.
Possible values are: segment values between 1 and 12, 'auto' and '*'.
Example: '1seg 5seg * auto'<br />Type: <code>org.apache.myfaces.tobago.layout.SegmentMeasureList</code>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="bottomNav">
<a name="navbar_bottom"></a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"></a>
<ul class="navList" title="Navigation">
<li>
<a href="../overview-summary.html">Overview</a>
</li>
<li>
<a href="tld-summary.html">Library</a>
</li>
<li class="navBarCell1Rev">Tag</li>
<li>
<a href="../help-doc.html">Help</a>
</li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>
<a target="_bottom" href="../index.html?tc/segmentLayout.html">
Frames
</a>
</li>
<li>
<a target="_bottom" href="segmentLayout.html">
No Frames
</a>
</li>
</ul>
<ul class="navList" id="alltags_navbar_bottom">
<li>
<a href="../alltags-noframe.html">All Tags</a>
</li>
</ul>
<script type="text/javascript">
document.getElementById("alltags_navbar_bottom").style.display = (window == top) ? "block" : "none";
</script><a name="skip-navbar_bottom"></a>
</div>
<p class="about">
Output generated by <a href="http://vdldoc.omnifaces.org" target="_blank">Vdldoc</a> View Declaration Language Documentation Generator.
</p>
</body>
</html>