Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / text / list / ListDecorator.html
blob: 0dae36066b449e7b729ca785e25a675791ed31c3 [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:17 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ListDecorator (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="ListDecorator (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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ListDecorator.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/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/odftoolkit/simple/text/list/ListDecorator.ListType.html" title="enum in org.odftoolkit.simple.text.list"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/odftoolkit/simple/text/list/ListDecorator.html" target="_top">Frames</a></li>
<li><a href="ListDecorator.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.odftoolkit.simple.text.list</div>
<h2 title="Interface ListDecorator" class="title">Interface ListDecorator</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/odftoolkit/simple/text/list/BulletDecorator.html" title="class in org.odftoolkit.simple.text.list">BulletDecorator</a>, <a href="../../../../../org/odftoolkit/simple/text/list/ImageDecorator.html" title="class in org.odftoolkit.simple.text.list">ImageDecorator</a>, <a href="../../../../../org/odftoolkit/simple/text/list/NumberDecorator.html" title="class in org.odftoolkit.simple.text.list">NumberDecorator</a>, <a href="../../../../../org/odftoolkit/simple/text/list/OutLineDecorator.html" title="class in org.odftoolkit.simple.text.list">OutLineDecorator</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ListDecorator</span></pre>
<div class="block">ListDecorator is a decorator which decides how to decorate a List and its
ListItems.
<p>
Every list, including sub lists, may have a list style which is applied to
its list items and sub lists. ListDecorator holds this style and decides the
appearance of a list. List style is applied by invoking decorateList(List),
while list item style is applied by invoking decorateListItem(ListItem).
<p>
A ListDecorator specified for a sub list overrides the ListDecorator
specified for the list in which the sub list is contained.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.4</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListDecorator.ListType.html" title="enum in org.odftoolkit.simple.text.list">ListDecorator.ListType</a></strong></code>
<div class="block">The supported list types till now.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListDecorator.html#decorateList(org.odftoolkit.simple.text.list.List)">decorateList</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;list)</code>
<div class="block">Decorate the specifies <code>list</code>, of which style is set.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListDecorator.html#decorateListItem(org.odftoolkit.simple.text.list.ListItem)">decorateListItem</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;item)</code>
<div class="block">Decorate the specifies <code>item</code> in a List, of which style is
set.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/text/list/ListDecorator.ListType.html" title="enum in org.odftoolkit.simple.text.list">ListDecorator.ListType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListDecorator.html#getListType()">getListType</a></strong>()</code>
<div class="block">Get the ListType of this ListDecorator.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="decorateList(org.odftoolkit.simple.text.list.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decorateList</h4>
<pre>void&nbsp;decorateList(<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;list)</pre>
<div class="block">Decorate the specifies <code>list</code>, of which style is set.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list</code> - the List is decorated.</dd></dl>
</li>
</ul>
<a name="decorateListItem(org.odftoolkit.simple.text.list.ListItem)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decorateListItem</h4>
<pre>void&nbsp;decorateListItem(<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;item)</pre>
<div class="block">Decorate the specifies <code>item</code> in a List, of which style is
set.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>item</code> - the ListItem is decorated.</dd></dl>
</li>
</ul>
<a name="getListType()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getListType</h4>
<pre><a href="../../../../../org/odftoolkit/simple/text/list/ListDecorator.ListType.html" title="enum in org.odftoolkit.simple.text.list">ListDecorator.ListType</a>&nbsp;getListType()</pre>
<div class="block">Get the ListType of this ListDecorator.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the ListType of this ListDecorator.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ListDecorator.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/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/odftoolkit/simple/text/list/ListDecorator.ListType.html" title="enum in org.odftoolkit.simple.text.list"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/odftoolkit/simple/text/list/ListDecorator.html" target="_top">Frames</a></li>
<li><a href="ListDecorator.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</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>