blob: 944cb90f31fb294e855c605fd9c2e74f6f24d0b7 [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:26:21 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>OdfSlide (ODFDOM API v0.8.9-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="OdfSlide (ODFDOM API v0.8.9-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/OdfSlide.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/odfdom/doc/presentation/OdfPresentationNotes.html" title="class in org.odftoolkit.odfdom.doc.presentation"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/odftoolkit/odfdom/doc/presentation/OdfSlide.SlideLayout.html" title="enum in org.odftoolkit.odfdom.doc.presentation"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/odftoolkit/odfdom/doc/presentation/OdfSlide.html" target="_top">Frames</a></li>
<li><a href="OdfSlide.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.odfdom.doc.presentation</div>
<h2 title="Class OdfSlide" class="title">Class OdfSlide</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.odfdom.doc.presentation.OdfSlide</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>As of release 0.8.8, replaced by <a href="http://incubator.apache.org/odftoolkit/simple/index.html/apidocs/org/odftoolkit/simple/presentation/Slide.html?is-external=true" title="class or interface in org.odftoolkit.simple.presentation"><code>Slide</code></a> in Simple API.</i></div>
</div>
<br>
<pre>public class <span class="strong">OdfSlide</span>
extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block"><code>OdfSlide</code> represents the presentation slide feature of the ODF document.
<code>OdfSlide</code> provides methods to get the slide index,get the content of the current slide, etc.</div>
</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">Class 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/odfdom/doc/presentation/OdfSlide.SlideLayout.html" title="enum in org.odftoolkit.odfdom.doc.presentation">OdfSlide.SlideLayout</a></strong></code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">A slide layout is a slide with some predefine placeholder.</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>static <a href="../../../../../org/odftoolkit/odfdom/doc/presentation/OdfSlide.html" title="class in org.odftoolkit.odfdom.doc.presentation">OdfSlide</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/doc/presentation/OdfSlide.html#getInstance(org.odftoolkit.odfdom.dom.element.draw.DrawPageElement)">getInstance</a></strong>(<a href="../../../../../org/odftoolkit/odfdom/dom/element/draw/DrawPageElement.html" title="class in org.odftoolkit.odfdom.dom.element.draw">DrawPageElement</a>&nbsp;pageElement)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Get a presentation slide instance by an instance of <code>DrawPageElement</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/odftoolkit/odfdom/doc/presentation/OdfPresentationNotes.html" title="class in org.odftoolkit.odfdom.doc.presentation">OdfPresentationNotes</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/doc/presentation/OdfSlide.html#getNotesPage()">getNotesPage</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Get the Notes page of this slide</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/odftoolkit/odfdom/dom/element/draw/DrawPageElement.html" title="class in org.odftoolkit.odfdom.dom.element.draw">DrawPageElement</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/doc/presentation/OdfSlide.html#getOdfElement()">getOdfElement</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Return an instance of <code>DrawPageElement</code> which represents presentation slide feature.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/doc/presentation/OdfSlide.html#getSlideIndex()">getSlideIndex</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Get the current slide index in the owner document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/doc/presentation/OdfSlide.html#getSlideName()">getSlideName</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Get the current slide name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/odfdom/doc/presentation/OdfSlide.html#setSlideName(java.lang.String)">setSlideName</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Set the current slide name.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</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="getInstance(org.odftoolkit.odfdom.dom.element.draw.DrawPageElement)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public static&nbsp;<a href="../../../../../org/odftoolkit/odfdom/doc/presentation/OdfSlide.html" title="class in org.odftoolkit.odfdom.doc.presentation">OdfSlide</a>&nbsp;getInstance(<a href="../../../../../org/odftoolkit/odfdom/dom/element/draw/DrawPageElement.html" title="class in org.odftoolkit.odfdom.dom.element.draw">DrawPageElement</a>&nbsp;pageElement)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">Get a presentation slide instance by an instance of <code>DrawPageElement</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pageElement</code> - an instance of <code>DrawPageElement</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of <code>OdfSlide</code> that can represent <code>pageElement</code></dd></dl>
</li>
</ul>
<a name="getOdfElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOdfElement</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/odfdom/dom/element/draw/DrawPageElement.html" title="class in org.odftoolkit.odfdom.dom.element.draw">DrawPageElement</a>&nbsp;getOdfElement()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">Return an instance of <code>DrawPageElement</code> which represents presentation slide feature.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an instance of <code>DrawPageElement</code></dd></dl>
</li>
</ul>
<a name="getSlideIndex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSlideIndex</h4>
<pre>public&nbsp;int&nbsp;getSlideIndex()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">Get the current slide index in the owner document.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the slide index in the owner document
<p>
-1, if the odf element which can represent this slide is not in the document DOM tree</dd></dl>
</li>
</ul>
<a name="getSlideName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSlideName</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getSlideName()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">Get the current slide name.
<p>
If the "draw:name" attribute is not present there,
create an unique name for this slide</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the current slide</dd></dl>
</li>
</ul>
<a name="setSlideName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSlideName</h4>
<pre>public&nbsp;void&nbsp;setSlideName(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">Set the current slide name.
<p>
It must be unique slide name in the current presentation.
If not, an IllegalArgumentException will be thrown.
If the given name is null, an IllegalArgumentException will also be thrown.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the new name of the current slide</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the given name is null or it is not unique in the current presentation.</dd></dl>
</li>
</ul>
<a name="getNotesPage()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getNotesPage</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/odfdom/doc/presentation/OdfPresentationNotes.html" title="class in org.odftoolkit.odfdom.doc.presentation">OdfPresentationNotes</a>&nbsp;getNotesPage()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">Get the Notes page of this slide</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the instance of <code>OdfPresentationNotes</code> which represent the notes page of the current slide</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/OdfSlide.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/odfdom/doc/presentation/OdfPresentationNotes.html" title="class in org.odftoolkit.odfdom.doc.presentation"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/odftoolkit/odfdom/doc/presentation/OdfSlide.SlideLayout.html" title="enum in org.odftoolkit.odfdom.doc.presentation"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/odftoolkit/odfdom/doc/presentation/OdfSlide.html" target="_top">Frames</a></li>
<li><a href="OdfSlide.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; 2008-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>