blob: da49feee95115a9356aa663cee1cd4bf8efb1b62 [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>style (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/style.html">
Frames
</a>
</li>
<li>
<a target="_top" href="style.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
style</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Description:</dt>
<dd>
<div class="block">
<p>
Add a style tag with the given file name to the header (using file attribute) or add
some CSS styles to the parent component.
</p><p><b>UIComponentClass: </b>org.apache.myfaces.tobago.component.UIStyle</p><p><b>RendererType: </b><ul><li>Style (default)</li></ul></p>
</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.Style</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>Style</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="backgroundImage" class="rowColor">
<td class="colFirst"><a href="#backgroundImage"><code>backgroundImage</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 background image of the element.<br />Type: <code>java.lang.String</code>
</td>
</tr>
<tr id="binding" class="altColor">
<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="bottom" class="rowColor">
<td class="colFirst"><a href="#bottom"><code>bottom</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="customClass" class="altColor">
<td class="colFirst"><a href="#customClass"><code>customClass</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.renderkit.css.CustomClass</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.renderkit.css.CustomClass</code>
</td>
</tr>
<tr id="display" class="rowColor">
<td class="colFirst"><a href="#display"><code>display</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.Display</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Display</code><br />Allowed Values: <code>[block, inline, grid, none]</code>
</td>
</tr>
<tr id="file" class="altColor">
<td class="colFirst"><a href="#file"><code>file</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">
Name of the stylesheet file to add to page. The name must be full qualified, or relative.
If using a complete path from root, you'll need to add the contextPath from the web application.
This can be done with the EL #{request.contextPath}.<br />Type: <code>java.lang.String</code>
</td>
</tr>
<tr id="flexBasis" class="rowColor">
<td class="colFirst"><a href="#flexBasis"><code>flexBasis</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.Measure</code>)
</td><td class="colLast">
Flex basis value of the element.<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="flexGrow" class="altColor">
<td class="colFirst"><a href="#flexGrow"><code>flexGrow</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.Number</code>)
</td><td class="colLast">
Flex grow value of the element.<br />Type: <code>java.lang.Number</code>
</td>
</tr>
<tr id="flexShrink" class="rowColor">
<td class="colFirst"><a href="#flexShrink"><code>flexShrink</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.Number</code>)
</td><td class="colLast">
Flex shrink value of the element.<br />Type: <code>java.lang.Number</code>
</td>
</tr>
<tr id="gridColumn" class="altColor">
<td class="colFirst"><a href="#gridColumn"><code>gridColumn</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.GridSpan</code>)
</td><td class="colLast">
Grid column value of the element.<br />Type: <code>org.apache.myfaces.tobago.layout.GridSpan</code>
</td>
</tr>
<tr id="gridRow" class="rowColor">
<td class="colFirst"><a href="#gridRow"><code>gridRow</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.GridSpan</code>)
</td><td class="colLast">
Grid row value of the element.<br />Type: <code>org.apache.myfaces.tobago.layout.GridSpan</code>
</td>
</tr>
<tr id="gridTemplateColumns" class="altColor">
<td class="colFirst"><a href="#gridTemplateColumns"><code>gridTemplateColumns</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">
Grid template columns value of the element.<br />Type: <code>java.lang.String</code>
</td>
</tr>
<tr id="gridTemplateRows" class="rowColor">
<td class="colFirst"><a href="#gridTemplateRows"><code>gridTemplateRows</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">
Grid template rows value of the element.<br />Type: <code>java.lang.String</code>
</td>
</tr>
<tr id="height" class="altColor">
<td class="colFirst"><a href="#height"><code>height</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="id" class="rowColor">
<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="left" class="altColor">
<td class="colFirst"><a href="#left"><code>left</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="marginBottom" class="rowColor">
<td class="colFirst"><a href="#marginBottom"><code>marginBottom</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="marginLeft" class="altColor">
<td class="colFirst"><a href="#marginLeft"><code>marginLeft</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="marginRight" class="rowColor">
<td class="colFirst"><a href="#marginRight"><code>marginRight</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="marginTop" class="altColor">
<td class="colFirst"><a href="#marginTop"><code>marginTop</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="maxHeight" class="rowColor">
<td class="colFirst"><a href="#maxHeight"><code>maxHeight</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="maxWidth" class="altColor">
<td class="colFirst"><a href="#maxWidth"><code>maxWidth</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="minHeight" class="rowColor">
<td class="colFirst"><a href="#minHeight"><code>minHeight</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="minWidth" class="altColor">
<td class="colFirst"><a href="#minWidth"><code>minWidth</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="overflowX" class="rowColor">
<td class="colFirst"><a href="#overflowX"><code>overflowX</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.Overflow</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Overflow</code><br />Allowed Values: <code>[auto, scroll, hidden]</code>
</td>
</tr>
<tr id="overflowY" class="altColor">
<td class="colFirst"><a href="#overflowY"><code>overflowY</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.Overflow</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Overflow</code><br />Allowed Values: <code>[auto, scroll, hidden]</code>
</td>
</tr>
<tr id="paddingBottom" class="rowColor">
<td class="colFirst"><a href="#paddingBottom"><code>paddingBottom</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="paddingLeft" class="altColor">
<td class="colFirst"><a href="#paddingLeft"><code>paddingLeft</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="paddingRight" class="rowColor">
<td class="colFirst"><a href="#paddingRight"><code>paddingRight</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="paddingTop" class="altColor">
<td class="colFirst"><a href="#paddingTop"><code>paddingTop</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="position" class="rowColor">
<td class="colFirst"><a href="#position"><code>position</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.Position</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Position</code><br />Allowed Values: <code>[absolute, relative, fixed]</code>
</td>
</tr>
<tr id="right" class="altColor">
<td class="colFirst"><a href="#right"><code>right</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="selector" class="rowColor">
<td class="colFirst"><a href="#selector"><code>selector</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">
<br />Type: <code>java.lang.String</code>
</td>
</tr>
<tr id="textAlign" class="altColor">
<td class="colFirst"><a href="#textAlign"><code>textAlign</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.TextAlign</code>)
</td><td class="colLast">
The alignment of the elements inside of the container, possible values are:
{@link TextAlign#left},
{@link TextAlign#right},
{@link TextAlign#center} and
{@link TextAlign#justify}.<br />Type: <code>org.apache.myfaces.tobago.layout.TextAlign</code><br />Allowed Values: <code>[left, right, center, justify]</code>
</td>
</tr>
<tr id="top" class="rowColor">
<td class="colFirst"><a href="#top"><code>top</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</code>
</td>
</tr>
<tr id="width" class="altColor">
<td class="colFirst"><a href="#width"><code>width</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.Measure</code>)
</td><td class="colLast">
<br />Type: <code>org.apache.myfaces.tobago.layout.Measure</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/style.html">
Frames
</a>
</li>
<li>
<a target="_bottom" href="style.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>