Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / draw / Frame.html
blob: 5a74d95a9278c81c36a69319e836254c0341f3ee [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:16 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Frame (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="Frame (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/Frame.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/draw/ControlStyleHandler.html" title="class in org.odftoolkit.simple.draw"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/draw/Frame.html" target="_top">Frames</a></li>
<li><a href="Frame.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&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.draw</div>
<h2 title="Class Frame" class="title">Class Frame</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><a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">org.odftoolkit.simple.Component</a></li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.simple.draw.Frame</li>
</ul>
</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/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Frame</span>
extends <a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></pre>
<div class="block">This class presents frame object. It provides method to get/set frame
properties, content, and and styles. A frame is a container for enhanced
content like text boxes, images or objects. A frame may contain multiple
renditions of content.</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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.odftoolkit.odfdom.dom.element.draw.DrawFrameElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#mElement">mElement</a></strong></code>
<div class="block">Attributes:
draw:caption-id 19.115, draw:class-names 19.120, draw:copy-of 19.126,
draw:id 19.187.3, draw:layer 19.189, draw:name 19.197.10, draw:style-name
19.219.13, draw:text-style-name 19.227, draw:transform 19.228,
draw:z-index 19.231, presentation:class 19.389, presentation:class-names
19.390, presentation:placeholder 19.407, presentation:style-name 19.422,
presentation:user-transformed 19.427, style:rel-height 19.509,
style:rel-width 19.510.2, svg:height 19.539.8, svg:width 19.571.10, svg:x
19.573.5, svg:y 19.577.5, table:end-cell-address 19.627, table:end-x
19.632, table:end-y 19.633, table:table-background 19.728,
text:anchor-page-number 19.753, text:anchor-type 19.754 xml:id 19.914.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw">FrameContainer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#mFrameContainer">mFrameContainer</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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/draw/Frame.html#mOwnerDocument">mOwnerDocument</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/odftoolkit/simple/draw/FrameStyleHandler.html" title="class in org.odftoolkit.simple.draw">FrameStyleHandler</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#mStyleHandler">mStyleHandler</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#Frame(org.odftoolkit.odfdom.dom.element.draw.DrawFrameElement)">Frame</a></strong>(org.odftoolkit.odfdom.dom.element.draw.DrawFrameElement&nbsp;element)</code>&nbsp;</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><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/simple/draw/Frame.html#getDesciption()">getDesciption</a></strong>()</code>
<div class="block">Get the description of this text box</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.draw.DrawFrameElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#getDrawFrameElement()">getDrawFrameElement</a></strong>()</code>
<div class="block">Get the instance of <code>DrawFrameElement</code> which represents this
frame.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#getHyperlink()">getHyperlink</a></strong>()</code>
<div class="block">Return the URI of hypertext reference if exists, or else, return null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static <a href="../../../../org/odftoolkit/simple/draw/Frame.html" title="class in org.odftoolkit.simple.draw">Frame</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#getInstanceof(org.odftoolkit.odfdom.dom.element.draw.DrawFrameElement)">getInstanceof</a></strong>(org.odftoolkit.odfdom.dom.element.draw.DrawFrameElement&nbsp;element)</code>
<div class="block">Get a frame instance by an instance of <code>DrawFrameElement</code>.</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/simple/draw/Frame.html#getName()">getName</a></strong>()</code>
<div class="block">Get the name of this frame.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.pkg.OdfElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#getOdfElement()">getOdfElement</a></strong>()</code>
<div class="block">Get the instance of <code>DrawFrameElement</code> which represents this
frame.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/draw/FrameRectangle.html" title="class in org.odftoolkit.simple.draw">FrameRectangle</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#getRectangle()">getRectangle</a></strong>()</code>
<div class="block">Return the rectangle used by this frame</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/draw/FrameStyleHandler.html" title="class in org.odftoolkit.simple.draw">FrameStyleHandler</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#getStyleHandler()">getStyleHandler</a></strong>()</code>
<div class="block">Return style handler for this frame</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/simple/draw/Frame.html#getTitle()">getTitle</a></strong>()</code>
<div class="block">Get the title of this text box</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static <a href="../../../../org/odftoolkit/simple/draw/Frame.html" title="class in org.odftoolkit.simple.draw">Frame</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#newFrame(org.odftoolkit.simple.draw.FrameContainer)">newFrame</a></strong>(<a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw">FrameContainer</a>&nbsp;container)</code>
<div class="block">Create an instance of frame
The frame will be added at the end of this container.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#setBackgroundColor(org.odftoolkit.odfdom.type.Color)">setBackgroundColor</a></strong>(org.odftoolkit.odfdom.type.Color&nbsp;color)</code>
<div class="block">Set the background color of this frame.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#setDescription(java.lang.String)">setDescription</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;description)</code>
<div class="block">Set the description of this text box.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#setHyperlink(java.net.URI)">setHyperlink</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;linkto)</code>
<div class="block">Add a hypertext reference to this frame.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#setImage(java.net.URI)">setImage</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;uri)</code>
<div class="block">Add a image to the frame after all the contents get removed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#setName(java.lang.String)">setName</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">Set the name of this frame.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#setRectangle(org.odftoolkit.simple.draw.FrameRectangle)">setRectangle</a></strong>(<a href="../../../../org/odftoolkit/simple/draw/FrameRectangle.html" title="class in org.odftoolkit.simple.draw">FrameRectangle</a>&nbsp;rectangle)</code>
<div class="block">Set the rectangle used by this frame</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Frame.html#setTitle(java.lang.String)">setTitle</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;title)</code>
<div class="block">Set the title of this text box</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.Component">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.simple.<a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></h3>
<code><a href="../../../../org/odftoolkit/simple/Component.html#getComponentByElement(org.odftoolkit.odfdom.pkg.OdfElement)">getComponentByElement</a>, <a href="../../../../org/odftoolkit/simple/Component.html#getOwnerDocument()">getOwnerDocument</a>, <a href="../../../../org/odftoolkit/simple/Component.html#registerComponent(org.odftoolkit.simple.Component, org.odftoolkit.odfdom.pkg.OdfElement)">registerComponent</a>, <a href="../../../../org/odftoolkit/simple/Component.html#unregisterComponent(org.odftoolkit.odfdom.pkg.OdfElement)">unregisterComponent</a></code></li>
</ul>
<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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="mElement">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mElement</h4>
<pre>protected&nbsp;org.odftoolkit.odfdom.dom.element.draw.DrawFrameElement mElement</pre>
<div class="block">Attributes:
draw:caption-id 19.115, draw:class-names 19.120, draw:copy-of 19.126,
draw:id 19.187.3, draw:layer 19.189, draw:name 19.197.10, draw:style-name
19.219.13, draw:text-style-name 19.227, draw:transform 19.228,
draw:z-index 19.231, presentation:class 19.389, presentation:class-names
19.390, presentation:placeholder 19.407, presentation:style-name 19.422,
presentation:user-transformed 19.427, style:rel-height 19.509,
style:rel-width 19.510.2, svg:height 19.539.8, svg:width 19.571.10, svg:x
19.573.5, svg:y 19.577.5, table:end-cell-address 19.627, table:end-x
19.632, table:end-y 19.633, table:table-background 19.728,
text:anchor-page-number 19.753, text:anchor-type 19.754 xml:id 19.914.</div>
</li>
</ul>
<a name="mOwnerDocument">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mOwnerDocument</h4>
<pre>protected&nbsp;<a href="../../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a> mOwnerDocument</pre>
</li>
</ul>
<a name="mFrameContainer">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mFrameContainer</h4>
<pre>protected&nbsp;<a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw">FrameContainer</a> mFrameContainer</pre>
</li>
</ul>
<a name="mStyleHandler">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>mStyleHandler</h4>
<pre>protected&nbsp;<a href="../../../../org/odftoolkit/simple/draw/FrameStyleHandler.html" title="class in org.odftoolkit.simple.draw">FrameStyleHandler</a> mStyleHandler</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Frame(org.odftoolkit.odfdom.dom.element.draw.DrawFrameElement)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Frame</h4>
<pre>protected&nbsp;Frame(org.odftoolkit.odfdom.dom.element.draw.DrawFrameElement&nbsp;element)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstanceof(org.odftoolkit.odfdom.dom.element.draw.DrawFrameElement)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstanceof</h4>
<pre>protected static&nbsp;<a href="../../../../org/odftoolkit/simple/draw/Frame.html" title="class in org.odftoolkit.simple.draw">Frame</a>&nbsp;getInstanceof(org.odftoolkit.odfdom.dom.element.draw.DrawFrameElement&nbsp;element)</pre>
<div class="block">Get a frame instance by an instance of <code>DrawFrameElement</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - - the instance of DrawFrameElement</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of frame</dd></dl>
</li>
</ul>
<a name="newFrame(org.odftoolkit.simple.draw.FrameContainer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newFrame</h4>
<pre>protected static&nbsp;<a href="../../../../org/odftoolkit/simple/draw/Frame.html" title="class in org.odftoolkit.simple.draw">Frame</a>&nbsp;newFrame(<a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw">FrameContainer</a>&nbsp;container)</pre>
<div class="block">Create an instance of frame
<p>
The frame will be added at the end of this container.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - - the frame container that contains this frame.</dd></dl>
</li>
</ul>
<a name="setName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>public&nbsp;void&nbsp;setName(<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">Set the name of this frame.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - - the name of the frame</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</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;getName()</pre>
<div class="block">Get the name of this frame.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the frame</dd></dl>
</li>
</ul>
<a name="getOdfElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOdfElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.pkg.OdfElement&nbsp;getOdfElement()</pre>
<div class="block">Get the instance of <code>DrawFrameElement</code> which represents this
frame.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/Component.html#getOdfElement()">getOdfElement</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the instance of <code>DrawFrameElement</code></dd></dl>
</li>
</ul>
<a name="getDrawFrameElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDrawFrameElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.dom.element.draw.DrawFrameElement&nbsp;getDrawFrameElement()</pre>
<div class="block">Get the instance of <code>DrawFrameElement</code> which represents this
frame.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the instance of <code>DrawFrameElement</code></dd></dl>
</li>
</ul>
<a name="setRectangle(org.odftoolkit.simple.draw.FrameRectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRectangle</h4>
<pre>public&nbsp;void&nbsp;setRectangle(<a href="../../../../org/odftoolkit/simple/draw/FrameRectangle.html" title="class in org.odftoolkit.simple.draw">FrameRectangle</a>&nbsp;rectangle)</pre>
<div class="block">Set the rectangle used by this frame</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rectangle</code> - - the rectangle used by this frame</dd></dl>
</li>
</ul>
<a name="getRectangle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRectangle</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/draw/FrameRectangle.html" title="class in org.odftoolkit.simple.draw">FrameRectangle</a>&nbsp;getRectangle()</pre>
<div class="block">Return the rectangle used by this frame</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>- the rectangle</dd></dl>
</li>
</ul>
<a name="setTitle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTitle</h4>
<pre>public&nbsp;void&nbsp;setTitle(<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;title)</pre>
<div class="block">Set the title of this text box</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - - the title of this text box</dd></dl>
</li>
</ul>
<a name="getTitle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTitle</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;getTitle()</pre>
<div class="block">Get the title of this text box</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>- the title of this text box</dd></dl>
</li>
</ul>
<a name="getDesciption()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDesciption</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;getDesciption()</pre>
<div class="block">Get the description of this text box</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>- the description of this text box</dd></dl>
</li>
</ul>
<a name="setDescription(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDescription</h4>
<pre>public&nbsp;void&nbsp;setDescription(<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;description)</pre>
<div class="block">Set the description of this text box.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>description</code> - - the description of this text box</dd></dl>
</li>
</ul>
<a name="setHyperlink(java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHyperlink</h4>
<pre>public&nbsp;void&nbsp;setHyperlink(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;linkto)</pre>
<div class="block">Add a hypertext reference to this frame.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>linkto</code> - the hyperlink</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6.5</dd></dl>
</li>
</ul>
<a name="getHyperlink()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHyperlink</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;getHyperlink()</pre>
<div class="block">Return the URI of hypertext reference if exists, or else, return null.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the URI of hyperlink if exists</dd></dl>
</li>
</ul>
<a name="getStyleHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStyleHandler</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/draw/FrameStyleHandler.html" title="class in org.odftoolkit.simple.draw">FrameStyleHandler</a>&nbsp;getStyleHandler()</pre>
<div class="block">Return style handler for this frame</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the style handler</dd></dl>
</li>
</ul>
<a name="setBackgroundColor(org.odftoolkit.odfdom.type.Color)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBackgroundColor</h4>
<pre>public&nbsp;void&nbsp;setBackgroundColor(org.odftoolkit.odfdom.type.Color&nbsp;color)</pre>
<div class="block">Set the background color of this frame.
<p>
If the parameter is null, there will be no background color defined for
this frame. The old setting of background color will be removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>color</code> - - the background color to be set</dd></dl>
</li>
</ul>
<a name="setImage(java.net.URI)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setImage</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/draw/Image.html" title="class in org.odftoolkit.simple.draw">Image</a>&nbsp;setImage(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;uri)</pre>
<div class="block">Add a image to the frame after all the contents get removed.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.5.5</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/Frame.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/draw/ControlStyleHandler.html" title="class in org.odftoolkit.simple.draw"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/draw/Frame.html" target="_top">Frames</a></li>
<li><a href="Frame.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&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>