blob: d4327f1e2396dd375d9b85e45b8545db6df288c5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a>
<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a>
<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a>
<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a>
<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a>
<span class="sourceLineNo">006</span>// * *<a name="line.6"></a>
<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a>
<span class="sourceLineNo">008</span>// * *<a name="line.8"></a>
<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a>
<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a>
<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a>
<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a>
<span class="sourceLineNo">013</span>package org.apache.juneau.dto.html5;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import org.apache.juneau.annotation.*;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>/**<a name="line.17"></a>
<span class="sourceLineNo">018</span> * DTO for an HTML {@doc ExtHTML5.tabular-data#the-th-element &lt;th&gt;}<a name="line.18"></a>
<span class="sourceLineNo">019</span> * element.<a name="line.19"></a>
<span class="sourceLineNo">020</span> *<a name="line.20"></a>
<span class="sourceLineNo">021</span> * &lt;ul class='seealso'&gt;<a name="line.21"></a>
<span class="sourceLineNo">022</span> * &lt;li class='link'&gt;{@doc DtoHtml5}<a name="line.22"></a>
<span class="sourceLineNo">023</span> * &lt;/ul&gt;<a name="line.23"></a>
<span class="sourceLineNo">024</span> */<a name="line.24"></a>
<span class="sourceLineNo">025</span>@Bean(typeName="th")<a name="line.25"></a>
<span class="sourceLineNo">026</span>public class Th extends HtmlElementMixed {<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span> /**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Creates an empty {@link Th} element.<a name="line.29"></a>
<span class="sourceLineNo">030</span> */<a name="line.30"></a>
<span class="sourceLineNo">031</span> public Th() {}<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span> /**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * Creates a {@link Th} element with the specified child nodes.<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * @param children The child nodes.<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span> public Th(Object...children) {<a name="line.38"></a>
<span class="sourceLineNo">039</span> children(children);<a name="line.39"></a>
<span class="sourceLineNo">040</span> }<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> /**<a name="line.42"></a>
<span class="sourceLineNo">043</span> * {@doc ExtHTML5.tabular-data#attr-th-abbr abbr} attribute.<a name="line.43"></a>
<span class="sourceLineNo">044</span> *<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * Alternative label to use for the header cell when referencing the cell in other contexts.<a name="line.46"></a>
<span class="sourceLineNo">047</span> *<a name="line.47"></a>
<span class="sourceLineNo">048</span> * @param abbr The new value for this attribute.<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @return This object (for method chaining).<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span> public final Th abbr(String abbr) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> attr("abbr", abbr);<a name="line.52"></a>
<span class="sourceLineNo">053</span> return this;<a name="line.53"></a>
<span class="sourceLineNo">054</span> }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
<span class="sourceLineNo">057</span> * {@doc ExtHTML5.tabular-data#attr-tdth-colspan colspan} attribute.<a name="line.57"></a>
<span class="sourceLineNo">058</span> *<a name="line.58"></a>
<span class="sourceLineNo">059</span> * &lt;p&gt;<a name="line.59"></a>
<span class="sourceLineNo">060</span> * Number of columns that the cell is to span.<a name="line.60"></a>
<span class="sourceLineNo">061</span> *<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @param colspan<a name="line.62"></a>
<span class="sourceLineNo">063</span> * The new value for this attribute.<a name="line.63"></a>
<span class="sourceLineNo">064</span> * Typically a {@link Number} or {@link String}.<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @return This object (for method chaining).<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> public final Th colspan(Object colspan) {<a name="line.67"></a>
<span class="sourceLineNo">068</span> attr("colspan", colspan);<a name="line.68"></a>
<span class="sourceLineNo">069</span> return this;<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> /**<a name="line.72"></a>
<span class="sourceLineNo">073</span> * {@doc ExtHTML5.tabular-data#attr-tdth-headers headers} attribute.<a name="line.73"></a>
<span class="sourceLineNo">074</span> *<a name="line.74"></a>
<span class="sourceLineNo">075</span> * &lt;p&gt;<a name="line.75"></a>
<span class="sourceLineNo">076</span> * The headers for this cell.<a name="line.76"></a>
<span class="sourceLineNo">077</span> *<a name="line.77"></a>
<span class="sourceLineNo">078</span> * @param headers The new value for this attribute.<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @return This object (for method chaining).<a name="line.79"></a>
<span class="sourceLineNo">080</span> */<a name="line.80"></a>
<span class="sourceLineNo">081</span> public final Th headers(String headers) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> attr("headers", headers);<a name="line.82"></a>
<span class="sourceLineNo">083</span> return this;<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> /**<a name="line.86"></a>
<span class="sourceLineNo">087</span> * {@doc ExtHTML5.tabular-data#attr-tdth-rowspan rowspan} attribute.<a name="line.87"></a>
<span class="sourceLineNo">088</span> *<a name="line.88"></a>
<span class="sourceLineNo">089</span> * &lt;p&gt;<a name="line.89"></a>
<span class="sourceLineNo">090</span> * Number of rows that the cell is to span.<a name="line.90"></a>
<span class="sourceLineNo">091</span> *<a name="line.91"></a>
<span class="sourceLineNo">092</span> * @param rowspan<a name="line.92"></a>
<span class="sourceLineNo">093</span> * The new value for this attribute.<a name="line.93"></a>
<span class="sourceLineNo">094</span> * Typically a {@link Number} or {@link String}.<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @return This object (for method chaining).<a name="line.95"></a>
<span class="sourceLineNo">096</span> */<a name="line.96"></a>
<span class="sourceLineNo">097</span> public final Th rowspan(Object rowspan) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> attr("rowspan", rowspan);<a name="line.98"></a>
<span class="sourceLineNo">099</span> return this;<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> /**<a name="line.102"></a>
<span class="sourceLineNo">103</span> * {@doc ExtHTML5.tabular-data#attr-th-scope scope} attribute.<a name="line.103"></a>
<span class="sourceLineNo">104</span> *<a name="line.104"></a>
<span class="sourceLineNo">105</span> * &lt;p&gt;<a name="line.105"></a>
<span class="sourceLineNo">106</span> * Specifies which cells the header cell applies to.<a name="line.106"></a>
<span class="sourceLineNo">107</span> *<a name="line.107"></a>
<span class="sourceLineNo">108</span> * @param scope The new value for this attribute.<a name="line.108"></a>
<span class="sourceLineNo">109</span> * @return This object (for method chaining).<a name="line.109"></a>
<span class="sourceLineNo">110</span> */<a name="line.110"></a>
<span class="sourceLineNo">111</span> public final Th scope(String scope) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> attr("scope", scope);<a name="line.112"></a>
<span class="sourceLineNo">113</span> return this;<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> /**<a name="line.116"></a>
<span class="sourceLineNo">117</span> * {@doc ExtHTML5.tabular-data#attr-th-sorted sorted} attribute.<a name="line.117"></a>
<span class="sourceLineNo">118</span> *<a name="line.118"></a>
<span class="sourceLineNo">119</span> * &lt;p&gt;<a name="line.119"></a>
<span class="sourceLineNo">120</span> * Column sort direction and ordinality.<a name="line.120"></a>
<span class="sourceLineNo">121</span> *<a name="line.121"></a>
<span class="sourceLineNo">122</span> * @param sorted The new value for this attribute.<a name="line.122"></a>
<span class="sourceLineNo">123</span> * @return This object (for method chaining).<a name="line.123"></a>
<span class="sourceLineNo">124</span> */<a name="line.124"></a>
<span class="sourceLineNo">125</span> public final Th sorted(String sorted) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> attr("sorted", sorted);<a name="line.126"></a>
<span class="sourceLineNo">127</span> return this;<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.131"></a>
<span class="sourceLineNo">132</span> // Overridden methods<a name="line.132"></a>
<span class="sourceLineNo">133</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span> @Override /* HtmlElement */<a name="line.135"></a>
<span class="sourceLineNo">136</span> public final Th _class(String _class) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> super._class(_class);<a name="line.137"></a>
<span class="sourceLineNo">138</span> return this;<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> @Override /* HtmlElement */<a name="line.141"></a>
<span class="sourceLineNo">142</span> public final Th id(String id) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> super.id(id);<a name="line.143"></a>
<span class="sourceLineNo">144</span> return this;<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> @Override /* HtmlElement */<a name="line.147"></a>
<span class="sourceLineNo">148</span> public final Th style(String style) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> super.style(style);<a name="line.149"></a>
<span class="sourceLineNo">150</span> return this;<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> @Override /* HtmlElementMixed */<a name="line.153"></a>
<span class="sourceLineNo">154</span> public Th children(Object...children) {<a name="line.154"></a>
<span class="sourceLineNo">155</span> super.children(children);<a name="line.155"></a>
<span class="sourceLineNo">156</span> return this;<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> @Override /* HtmlElementMixed */<a name="line.159"></a>
<span class="sourceLineNo">160</span> public Th child(Object child) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> super.child(child);<a name="line.161"></a>
<span class="sourceLineNo">162</span> return this;<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span>}<a name="line.164"></a>
</pre>
</div>
</body>
</html>