<html xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:jr="http://jasperreports.sourceforge.net/jasperreports">
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>JasperReports 4.0.2 - Styled Text Sample</title>
<style type="text/css">
.title {
font-family: Arial, Verdana, Helvetica, sans-serif;
font-size: 28px;
font-weight: normal;
}
.toc {
font-family: Courier New, Courier, serif;
font-size: 12px;
font-weight: normal;
}
.name {
font-family: Courier New, Courier, serif;
font-size: 16px;
font-weight: bold;
}
.label {
font-family: Arial, Verdana, Helvetica, sans-serif;
font-size: 12px;
font-weight: bold;
font-style: italic;
}
.description {
font-family: Arial, Verdana, Helvetica, sans-serif;
font-size: 12px;
font-weight: normal;
}
.value {
font-family: Courier New, Courier, serif;
font-size: 12px;
font-weight: normal;
}
.element {
font-family: Courier New, Courier, serif;
font-size: 12px;
font-weight: normal;
}
.attribute {
font-family: Courier New, Courier, serif;
font-size: 12px;
font-weight: bold;
}
.code {
font-family: Courier New, Courier, serif;
font-size: 12px;
font-weight: normal;
}
.copy {
font-decoration: none;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-size: 8pt;
font-style: normal;
color: #000000;
}
.subtitle {
font-family: inherit;
font-size: inherit;
font-style: inherit;
font-weight: bold;
text-decoration: none;
color: inherit;
}
</style>
</head>
<body bgcolor="#FFFFFF">
<a name="top"></a>
<table cellspacing="0" cellpadding="0" border="0" width="100%">
<tr>
<td colspan="2" align="right"><span class="element"><a href="../../sample.reference.html">Sample Reference</a> - <a href="../../schema.reference.html">Schema Reference</a> - <a href="../../config.reference.html">Configuration Reference</a> - <a href="http://jasperreports.sourceforge.net/api/index.html">API (Javadoc)</a></span>
<br>
</td>
</tr>
<tr>
<td colspan="2">
<hr size="1">
</td>
</tr>
<tr valign="middle">
<td nowrap="true"><span class="title">JasperReports - Styled Text Sample (version 4.0.2)</span></td><td align="right"><img src="../../resources/jasperreports.png" border="0"></td>
</tr>
<tr>
<td colspan="2">
<hr size="1">
</td>
</tr>
</table>
<br>
<span class="description"><span class="description">Shows how the styled-text feature works in static and dynamic text elements.</span></span>
<br>
<br>
<span class="element"><a href="http://sourceforge.net/projects/jasperreports/files/jasperreports/JasperReports%204.0.2/jasperreports-4.0.2-project.zip/download" target="_blank">Download All Sample Source Files</a></span>
<br>
<span class="element"><a href="http://jasperforge.org/scm/viewvc.php/tags/jr-4-0-2/jasperreports/demo/samples/styledtext/?root=jasperreports" target="_blank">Browse Sample Source Files on SVN</a></span>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td style="width: 20px;">
<br>
</td><td>
<br>
</td>
</tr>
<tr>
<td colspan="2"><span class="label">Main Features in This Sample</span></td>
</tr>
<tr>
<td>
<br>
</td><td><span class="element"><a href="#styledtext">Styled Text</a></span></td>
</tr>
<tr>
<td colspan="2">
<br>
</td>
</tr>
<tr>
<td colspan="2"><span class="label">Secondary Features</span></td>
</tr>
<tr>
<td></td><td><span class="element"><a href="../markup/index.html#markup">Creating Styled Text Using a Markup Language</a></span></td>
</tr>
</table>
<table width="100%" cellspacing="0" cellpadding="0" border="0">
<tr>
<td><img src="../../resources/px.gif" border="0" width="20" height="1"></td><td><img src="../../resources/px.gif" border="0" width="20" height="1"></td><td><img src="../../resources/px.gif" border="0" width="20" height="1"></td><td><img src="../../resources/px.gif" border="0" width="20" height="1"></td><td width="80%">
<br>
</td><td width="20%">
<br>
</td>
</tr>
<tr>
<td colspan="6" align="right"><a name="styledtext"></a><a href="#top" class="toc">top</a></td>
</tr>
<tr>
<td colspan="6">
<hr size="1">
</td>
</tr>
<tr valign="top">
<td><img src="../../resources/jr-16x16.png" border="0"></td><td colspan="4"><span class="name">Styled Text</span></td><td align="right"><span class="copy">Documented by
<a href="mailto:shertage@users.sourceforge.net" class="copy">Sanda Zaharia</a></span></td>
</tr>
<tr>
<td colspan="6">
<br>
</td>
</tr>
<tr valign="top">
<td>
<br>
</td><td nowrap="true"><span class="label">Description / Goal</span></td><td>
<br>
</td><td colspan="3"><span class="description">
How to format text using a styled text tags as markup language.
</span></td>
</tr>
<tr valign="top">
<td>
<br>
</td><td colspan="1"><span class="label">Since</span></td><td>
<br>
</td><td colspan="3"><span class="description">2.0.5</span></td>
</tr>
<tr>
<td colspan="6">
<br>
</td>
</tr>
<tr>
<td>
<br>
</td><td colspan="5"><span class="description">
<b>Styled Text</b>
<br>
<br>
The text content in text elements can be formatted using
some particular style attributes such as foreground color, background color,
font name, font size, font weight, etc. Document styles also contain text formatting attributes (<span class="code"><code>forecolor</code></span>,
<span class="code"><code>backcolor</code></span>, etc) and can be used to customize the text appearance inside the report element. All these style
attributes affect the entire text content in the report element.
<br>
But there are situations when one needs to apply a style only to some parts of the text paragraph. Users may want to
highlight only few words within the text, with no affecting the rest of the paragraph.
<br>
The solution formerly used was to set the <span class="code"><code>isStyledText</code></span> attribute of the text element. It is now a deprecated
solution and is replaced by the use of the <span class="code"><code>markup="styled"</code></span> setting.
<br>
If <span class="code"><code>isStyledText="true"</code></span> is set the engine gets notified that the text element contains a structured XML fragment
with JasperReports proprietary processing rules.
<br>
<br>
<b>Styled Text Markup Tags</b>
<br>
<br>
The JasperReports proprietary markup language is called styled text and is an XML
based format in which the style of any portion of text inside a text element can be
changed by embedding that portion inside a <style> tag or other simple HTML tag
from the following list:
<ul>
<li>
<span class="code"><code><b></code></span>
</li>
<li>
<span class="code"><code><u></code></span>
</li>
<li>
<span class="code"><code><i></code></span>
</li>
<li>
<span class="code"><code><font></code></span>
</li>
<li>
<span class="code"><code><sup></code></span>
</li>
<li>
<span class="code"><code><sub></code></span>
</li>
<li>
<span class="code"><code><li></code></span>
</li>
<li>
<span class="code"><code><br></code></span>
</li>
</ul>
The <span class="code"><code><style></code></span> tag has various attributes for altering the color, font, or other style
properties of the text. From the standard HTML <span class="code"><code><font></code></span> tag, only the fontFace, color,
and size attributes are recognized by the JasperReports engine. Each individual
style property is inherited from the overall text element or from the parent <span class="code"><code><style></code></span> tag
when nested <span class="code"><code><style></code></span> tags are used.
<br>
<br>
<b>The Styled Text Sample</b>
<br>
<br>
This sample contains various styled text paragraphs, illustrating the use of the styled text tags enumerated above.
<br>
The first paragraph is obtained by processing the following fragment:
<pre>
This is a <style isBold="true" isItalic="true" isUnderline="true">static text</style>
element containing styled text. <style backcolor="yellow" isBold="true" isItalic="true">Styled text</style>
elements are introduced by setting the <style forecolor="blue" isItalic="true">markup</style> attribute
available for the <style isBold="true" forecolor="magenta">textElement</style> tag to
<style forecolor="red" isItalic="true">styled</style> and by formatting the text content using nested
<style isBold="true" forecolor="green">style</style> tags and simple HTML tags. </pre>
The next one is obtained by processing the following fragment:
<pre>
This text field element contains styled text displaying the text-only version of the
<style size=\"12\" isBold=\"true\" forecolor=\"black\">^<style forecolor=\"#808080\">Jasper</style>
<style forecolor=\"#990000\">Reports</style></style> logo and some <font size=\"10\"><sup>superscript</sup></font>
text and <font size=\"10\"><sub>subscript</sub></font> text.</pre>
Then the text in the left column is obtained by processing the following fragment:
<pre>
Here is the list with the attributes supported by the <style isBold="true">style</style>
tag used to format the text content inside a styled text element:
fontName
<style size="32">size</style>
<style isBold="true">isBold</style>
<style isItalic="true">isItalic</style>
<style isUnderline="true">isUnderline</style>
<style isStrikeThrough="true">isStrikeThrough</style>
pdfFontName
pdfEncoding
isPdfEmbedded
<style forecolor="red">forecolor</style>
<style backcolor="blue" forecolor="white" isBold="true">backcolor</style></pre>
The text in the column to the right is obtained by processing the following fragment:
<pre>
Here is the list with the supported HTML tags :
<font size="12">&lt;font size=&quot;12&quot;&gt;</font>
<font color="red">&lt;font color=&quot;red&quot;&gt;</font>
<font face="DejaVu Serif">&lt;font face=&quot;DejaVu Serif&quot;&gt;</font>
<b>bold &lt;b&gt;</b> <i>italic &lt;i&gt;</i> <u>underlined &lt;u&gt;</u>
an empty line follows (&lt;br/&gt;):
<br/>
<sup>&lt;sup&gt;</sup> and <sub>&lt;sub&gt;</sub>
<br/>
A bulleted list:
<li>item 1 &lt;li&gt;</li></pre>
The next paragraph is obtained by processing the following fragment:
<pre>
ampersand &amp; less &lt; greater &gt; quote &quot; apostrophe &apos;</pre>
<pre>
ampersand &amp; less &lt; greater &gt; quote &quot; apostrophe &apos;</pre>
And the last fragment is obtained by processing the following:
<pre>
<style size=\"16\">1</style>\n<style size=\"24\">2</style>\n<style size=\"32\">3</style>\n
<style size=\"24\">2</style>\n<style size=\"16\">1</style>\n</pre>
For more information about the recommended text formatting solution, please take a look at the <a href="../markup/index.html" target="_blank" class="element">Markup Sample</a>.
<br>
<br>
<b>Running the Sample</b>
<br>
<br>
Running the sample requires the <a href="http://ant.apache.org/" target="_blank" class="element">Apache Ant</a> library. Make sure that <span class="code"><code>ant</code></span> is already installed on your system (version 1.5 or later).
<br>
In a command prompt/terminal window set the current folder to <span class="code"><code>demo/samples/styledtext</code></span> within the JasperReports source project and run the <span class="code"><code>> ant test view</code></span> command.
<br>
It will generate all supported document types containing the sample report in the <span class="code"><code>demo/samples/styledtext/build/reports</code></span> directory.
<br>
Then the report will open in the JasperReports internal viewer.
</span></td>
</tr>
<tr>
<td colspan="6">
<br>
</td>
</tr>
</table>
<br>
<table cellspacing="0" cellpadding="0" border="0" width="100%">
<tr>
<td>
<hr size="1">
</td>
</tr>
<tr>
<td align="center"><span class="copy">© 2001-2010 Jaspersoft Corporation <a href="http://www.jaspersoft.com" target="_blank" class="copy">www.jaspersoft.com</a></span></td>
</tr>
</table>
</body>
</html>
