| <!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:16 CET 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>Component (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="Component (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/Component.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/ChartDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/odftoolkit/simple/Component.html" target="_top">Frames</a></li> |
| <li><a href="Component.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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</div> |
| <h2 title="Class Component" class="title">Class Component</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.simple.Component</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../org/odftoolkit/simple/table/Cell.html" title="class in org.odftoolkit.simple.table">Cell</a>, <a href="../../../org/odftoolkit/simple/table/Column.html" title="class in org.odftoolkit.simple.table">Column</a>, <a href="../../../org/odftoolkit/simple/draw/Control.html" title="class in org.odftoolkit.simple.draw">Control</a>, <a href="../../../org/odftoolkit/simple/common/field/Field.html" title="class in org.odftoolkit.simple.common.field">Field</a>, <a href="../../../org/odftoolkit/simple/text/Footer.html" title="class in org.odftoolkit.simple.text">Footer</a>, <a href="../../../org/odftoolkit/simple/form/FormControl.html" title="class in org.odftoolkit.simple.form">FormControl</a>, <a href="../../../org/odftoolkit/simple/draw/Frame.html" title="class in org.odftoolkit.simple.draw">Frame</a>, <a href="../../../org/odftoolkit/simple/text/Header.html" title="class in org.odftoolkit.simple.text">Header</a>, <a href="../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</a>, <a href="../../../org/odftoolkit/simple/presentation/Notes.html" title="class in org.odftoolkit.simple.presentation">Notes</a>, <a href="../../../org/odftoolkit/simple/form/OOForm.html" title="class in org.odftoolkit.simple.form">OOForm</a>, <a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>, <a href="../../../org/odftoolkit/simple/table/Row.html" title="class in org.odftoolkit.simple.table">Row</a>, <a href="../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</a>, <a href="../../../org/odftoolkit/simple/presentation/Slide.html" title="class in org.odftoolkit.simple.presentation">Slide</a>, <a href="../../../org/odftoolkit/simple/text/Span.html" title="class in org.odftoolkit.simple.text">Span</a>, <a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>, <a href="../../../org/odftoolkit/simple/text/TextHyperlink.html" title="class in org.odftoolkit.simple.text">TextHyperlink</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="strong">Component</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">This class is the parent of classes that present all kinds of document |
| structures.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.5</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../org/odftoolkit/simple/Component.html#Component()">Component</a></strong>()</code> </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"> </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>protected static <a href="../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/Component.html#getComponentByElement(org.odftoolkit.odfdom.pkg.OdfElement)">getComponentByElement</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement element)</code> |
| <div class="block">Get the component instance by the element instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>abstract org.odftoolkit.odfdom.pkg.OdfElement</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/Component.html#getOdfElement()">getOdfElement</a></strong>()</code> |
| <div class="block">Return the instance of OdfElement which presents this structure.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/Component.html#getOwnerDocument()">getOwnerDocument</a></strong>()</code> |
| <div class="block">Get the owner document of this component</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/Component.html#registerComponent(org.odftoolkit.simple.Component, org.odftoolkit.odfdom.pkg.OdfElement)">registerComponent</a></strong>(<a href="../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a> component, |
| org.odftoolkit.odfdom.pkg.OdfElement element)</code> |
| <div class="block">Register component to the map repository</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/Component.html#unregisterComponent(org.odftoolkit.odfdom.pkg.OdfElement)">unregisterComponent</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement element)</code> |
| <div class="block">Unregister component from the map repository</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 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Component()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Component</h4> |
| <pre>public Component()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getOdfElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOdfElement</h4> |
| <pre>public abstract org.odftoolkit.odfdom.pkg.OdfElement getOdfElement()</pre> |
| <div class="block">Return the instance of OdfElement which presents this structure.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the instance of OdfElement</dd></dl> |
| </li> |
| </ul> |
| <a name="registerComponent(org.odftoolkit.simple.Component, org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerComponent</h4> |
| <pre>protected static void registerComponent(<a href="../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a> component, |
| org.odftoolkit.odfdom.pkg.OdfElement element)</pre> |
| <div class="block">Register component to the map repository</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>component</code> - the component to be registered.</dd><dd><code>element</code> - the instance of OdfElement which presents this component.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/odftoolkit/simple/Document.html#getComponentMap()"><code>Document.getComponentMap()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="unregisterComponent(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unregisterComponent</h4> |
| <pre>protected static void unregisterComponent(org.odftoolkit.odfdom.pkg.OdfElement element)</pre> |
| <div class="block">Unregister component from the map repository</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - the instance of OdfElement which presents this component.</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.6.5</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/odftoolkit/simple/Document.html#getComponentMap()"><code>Document.getComponentMap()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getComponentByElement(org.odftoolkit.odfdom.pkg.OdfElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentByElement</h4> |
| <pre>protected static <a href="../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a> getComponentByElement(org.odftoolkit.odfdom.pkg.OdfElement element)</pre> |
| <div class="block">Get the component instance by the element instance. Return null if there |
| is no such element registered.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - the instance of OdfElement which presents this component.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the component instance</dd></dl> |
| </li> |
| </ul> |
| <a name="getOwnerDocument()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getOwnerDocument</h4> |
| <pre>public <a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a> getOwnerDocument()</pre> |
| <div class="block">Get the owner document of this component</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>- the owner document</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/Component.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/ChartDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/odftoolkit/simple/Component.html" target="_top">Frames</a></li> |
| <li><a href="Component.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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 © 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |