blob: 7446b89112199b0ebc7cd2b53b62d5b94d12ec46 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri Feb 22 10:35:19 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>org.odftoolkit.simple.style (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)</title>
<meta name="date" content="2013-02-22">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.odftoolkit.simple.style (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/simple/presentation/package-summary.html">Prev Package</a></li>
<li><a href="../../../../org/odftoolkit/simple/table/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/style/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.odftoolkit.simple.style</h1>
<div class="docSummary">
<div class="block">Provide convenient methods to handle style definitions in ODF document.</div>
</div>
<p>See:&nbsp;<a href="#package_description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a></td>
<td class="colLast">
<div class="block">This class represents border style settings, including line style, color,
width, inner line width, outer line width and the distance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/DefaultStyleHandler.html" title="class in org.odftoolkit.simple.style">DefaultStyleHandler</a></td>
<td class="colLast">
<div class="block">This class is the default style handler.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/Font.html" title="class in org.odftoolkit.simple.style">Font</a></td>
<td class="colLast">
<div class="block">This class represents the font style settings, including font family name,
font style, size, front color.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html" title="class in org.odftoolkit.simple.style">GraphicProperties</a></td>
<td class="colLast">
<div class="block">This class represents the graphic style settings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/MasterPage.html" title="class in org.odftoolkit.simple.style">MasterPage</a></td>
<td class="colLast">
<div class="block">This class represents the master page style settings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html" title="class in org.odftoolkit.simple.style">PageLayoutProperties</a></td>
<td class="colLast">
<div class="block">This class represents the page layout style settings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/ParagraphProperties.html" title="class in org.odftoolkit.simple.style">ParagraphProperties</a></td>
<td class="colLast">
<div class="block">This class represents the paragraph style settings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.html" title="class in org.odftoolkit.simple.style">StyleTypeDefinitions</a></td>
<td class="colLast">
<div class="block">This class defines the common used types in style handling methods.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/TableCellProperties.html" title="class in org.odftoolkit.simple.style">TableCellProperties</a></td>
<td class="colLast">
<div class="block">This class represents the table cell style settings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/TableProperties.html" title="class in org.odftoolkit.simple.style">TableProperties</a></td>
<td class="colLast">
<div class="block">This class represents the table style settings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/TextProperties.html" title="class in org.odftoolkit.simple.style">TextProperties</a></td>
<td class="colLast">
<div class="block">This class represents text style settings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/TOCStyle.html" title="class in org.odftoolkit.simple.style">TOCStyle</a></td>
<td class="colLast">
<div class="block">This class represents the additional paragraph styles list that you want to
include in the TOC.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/NumberFormat.html" title="enum in org.odftoolkit.simple.style">NumberFormat</a></td>
<td class="colLast">
<div class="block">A <tt>NumberFormat</tt> specifies a numbering sequence.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.AdjustmentStyle.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.AdjustmentStyle</a></td>
<td class="colLast">
<div class="block">Common used font adjustment style from users perspective</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.AnchorType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.AnchorType</a></td>
<td class="colLast">
<div class="block">Anchor type from users perspective.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.CellBordersType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.CellBordersType</a></td>
<td class="colLast">
<div class="block">Common used border types from users perspective</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.FontStyle.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.FontStyle</a></td>
<td class="colLast">
<div class="block">Common used font style from users perspective</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.FrameHorizontalPosition.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.FrameHorizontalPosition</a></td>
<td class="colLast">
<div class="block">specifies the horizontal alignment of a frame relative to a specific area.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.FrameVerticalPosition.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.FrameVerticalPosition</a></td>
<td class="colLast">
<div class="block">specifies the vertical alignment of a frame relative to a specific area.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalAlignmentType</a></td>
<td class="colLast">
<div class="block">Common used horizontal alignment type from users perspective</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalRelative.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalRelative</a></td>
<td class="colLast">
<div class="block">Position horizontal relative from ODF specification perspective</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.LineStyle.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.LineStyle</a></td>
<td class="colLast">
<div class="block">Common used line style from users perspective</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.LineThroughStyle.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.LineThroughStyle</a></td>
<td class="colLast">
<div class="block">Common used style of line lining through text from users perspective</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.LineType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.LineType</a></td>
<td class="colLast">
<div class="block">Line type from ODF specification perspective</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.OdfDrawFill.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.OdfDrawFill</a></td>
<td class="colLast">
<div class="block">the fill style for a graphic object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.OdfDrawStroke.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.OdfDrawStroke</a></td>
<td class="colLast">
<div class="block">The style of the stroke from ODF perspective</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.OdfEmphasisMarkType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.OdfEmphasisMarkType</a></td>
<td class="colLast">
<div class="block">Emphasis mark type from ODF specification perspective</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.OdfFontStyle.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.OdfFontStyle</a></td>
<td class="colLast">
<div class="block">Font style from ODF specification perspective</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.OdfFontWeight.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.OdfFontWeight</a></td>
<td class="colLast">
<div class="block">Font weight from ODF specification perspective</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.OdfLineStyle.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.OdfLineStyle</a></td>
<td class="colLast">
<div class="block">Line style from ODF specification perspective</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.OdfLineWidth.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.OdfLineWidth</a></td>
<td class="colLast">
<div class="block">Line width from ODF specification perspective</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.PrintOrientation.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.PrintOrientation</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.SupportedLinearMeasure.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.SupportedLinearMeasure</a></td>
<td class="colLast">
<div class="block">The supported line measurement till now</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.TextLinePosition.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.TextLinePosition</a></td>
<td class="colLast">
<div class="block">Common used font text line position from users perspective.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalAlignmentType</a></td>
<td class="colLast">
<div class="block">Common used vertical alignment type from users perspective</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalRelative.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalRelative</a></td>
<td class="colLast">
<div class="block">Position vertical relative from ODF specification perspective</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.WritingMode.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.WritingMode</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package_description">
<!-- -->
</a>
<h2 title="Package org.odftoolkit.simple.style Description">Package org.odftoolkit.simple.style Description</h2>
<div class="block"><!--
##### THIS IS THE TEMPLATE FOR THE PACKAGE DOC COMMENTS. #####
##### TYPE YOUR PACKAGE COMMENTS HERE. BEGIN WITH A #####
##### ONE-SENTENCE SUMMARY STARTING WITH A VERB LIKE: #####
-->
Provide convenient methods to handle style definitions in ODF document.
<p>
There are two kinds of classes related with style handling in this package:
common used classes from user perspective, and common used style properties from ODF specification perspective.
</p>
<p>
Common used classes, such as Font and Border, are defined for users to easily set/get properties.
</p>
<p>
Common used style properties, such as TextProperties and TableCellProperties, directly manipulate the style properties defined in ODF document.
The users, who are familiar with ODF specification, can use these classes to achieve advanced functions.
</p>
<p>
More classes and functions will be added in future.
</p>
<!-- Put @see and @since tags down here. --></div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/simple/presentation/package-summary.html">Prev Package</a></li>
<li><a href="../../../../org/odftoolkit/simple/table/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/style/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>