| <!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>GraphicProperties (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="GraphicProperties (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/GraphicProperties.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/style/Font.html" title="class in org.odftoolkit.simple.style"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/simple/style/MasterPage.html" title="class in org.odftoolkit.simple.style"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/odftoolkit/simple/style/GraphicProperties.html" target="_top">Frames</a></li> |
| <li><a href="GraphicProperties.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.style</div> |
| <h2 title="Class GraphicProperties" class="title">Class GraphicProperties</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.style.GraphicProperties</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">GraphicProperties</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 represents the graphic style settings. It provides methods to |
| access borders and background styles. More functions will be added later. |
| <p> |
| This class is a corresponded high level class for element |
| "style:graphic-properties". It provides methods to access the attributes and |
| children of "style:graphic-properties".</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="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/style/GraphicProperties.html#GraphicProperties(org.odftoolkit.odfdom.dom.element.style.StyleGraphicPropertiesElement)">GraphicProperties</a></strong>(org.odftoolkit.odfdom.dom.element.style.StyleGraphicPropertiesElement properties)</code> |
| <div class="block">Create a paragraph style setting object, which has the association with |
| an element "style:paragraph-properties".</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"> </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="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#getBorder()">getBorder</a></strong>()</code> |
| <div class="block">Return the border setting for all four borders.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#getBottomBorder()">getBottomBorder</a></strong>()</code> |
| <div class="block">Return the border setting for the bottom border.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html" title="class in org.odftoolkit.simple.style">GraphicProperties</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#getGraphicProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase)">getGraphicProperties</a></strong>(org.odftoolkit.odfdom.dom.element.OdfStyleBase style)</code> |
| <div class="block">Return an instance of |
| <code>GraphicProperties to represent the "style:graphic-properties" in a style element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.FrameHorizontalPosition.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.FrameHorizontalPosition</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#getHorizontalPosition()">getHorizontalPosition</a></strong>()</code> |
| <div class="block">Return the horizontal position</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalRelative.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalRelative</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#getHorizontalRelative()">getHorizontalRelative</a></strong>()</code> |
| <div class="block">Return the horizontal relative</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#getLeftBorder()">getLeftBorder</a></strong>()</code> |
| <div class="block">Return the border setting for the left border.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html" title="class in org.odftoolkit.simple.style">GraphicProperties</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#getOrCreateGraphicProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase)">getOrCreateGraphicProperties</a></strong>(org.odftoolkit.odfdom.dom.element.OdfStyleBase style)</code> |
| <div class="block">Return an instance of |
| <code>GraphicProperties to represent the "style:graphic-properties" in a style element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#getRightBorder()">getRightBorder</a></strong>()</code> |
| <div class="block">Return the border setting for the right border.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#getTopBorder()">getTopBorder</a></strong>()</code> |
| <div class="block">Return the border setting for the top border.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.FrameVerticalPosition.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.FrameVerticalPosition</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#getVerticalPosition()">getVerticalPosition</a></strong>()</code> |
| <div class="block">Return the vertical position</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalRelative.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalRelative</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#getVerticalRelative()">getVerticalRelative</a></strong>()</code> |
| <div class="block">Return the vertical relative</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#setBorder(org.odftoolkit.simple.style.Border)">setBorder</a></strong>(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> border)</code> |
| <div class="block">Set the border definition for all four borders.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#setBorders(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType, org.odftoolkit.simple.style.Border)">setBorders</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.CellBordersType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.CellBordersType</a> bordersType, |
| <a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> border)</code> |
| <div class="block">Set the border style.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#setBottomBorder(org.odftoolkit.simple.style.Border)">setBottomBorder</a></strong>(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> border)</code> |
| <div class="block">Set the border definition for the bottom border.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#setFill(org.odftoolkit.simple.style.StyleTypeDefinitions.OdfDrawFill, org.odftoolkit.odfdom.type.Color)">setFill</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.OdfDrawFill.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.OdfDrawFill</a> fillType, |
| org.odftoolkit.odfdom.type.Color color)</code> |
| <div class="block">Set the fill style for a graphic object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#setHorizontalPosition(org.odftoolkit.simple.style.StyleTypeDefinitions.FrameHorizontalPosition)">setHorizontalPosition</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.FrameHorizontalPosition.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.FrameHorizontalPosition</a> horizontalPos)</code> |
| <div class="block">Set the horizontal position</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#setHorizontalRelative(org.odftoolkit.simple.style.StyleTypeDefinitions.HorizontalRelative)">setHorizontalRelative</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalRelative.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalRelative</a> relative)</code> |
| <div class="block">Set the horizontal relative</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#setLeftBorder(org.odftoolkit.simple.style.Border)">setLeftBorder</a></strong>(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> border)</code> |
| <div class="block">Set the border definition for the left border.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#setRightBorder(org.odftoolkit.simple.style.Border)">setRightBorder</a></strong>(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> border)</code> |
| <div class="block">Set the border definition for the right border.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#setStroke(org.odftoolkit.simple.style.StyleTypeDefinitions.OdfDrawStroke, org.odftoolkit.odfdom.type.Color, java.lang.String, java.lang.String)">setStroke</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.OdfDrawStroke.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.OdfDrawStroke</a> stroke, |
| org.odftoolkit.odfdom.type.Color color, |
| <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> widthDesc, |
| <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> dashStyleName)</code> |
| <div class="block">Set the style of stroke.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#setStyleRunThrough(boolean)">setStyleRunThrough</a></strong>(boolean isBackgroundObject)</code> |
| <div class="block">Set whether the content of a graphic object is displayed in the |
| background or foreground.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#setTopBorder(org.odftoolkit.simple.style.Border)">setTopBorder</a></strong>(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> border)</code> |
| <div class="block">Set the border definition for the top border.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#setVerticalPosition(org.odftoolkit.simple.style.StyleTypeDefinitions.FrameVerticalPosition)">setVerticalPosition</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.FrameVerticalPosition.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.FrameVerticalPosition</a> verticalPos)</code> |
| <div class="block">Set the vertical position</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html#setVerticalRelative(org.odftoolkit.simple.style.StyleTypeDefinitions.VerticalRelative)">setVerticalRelative</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalRelative.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalRelative</a> relative)</code> |
| <div class="block">Set the vertical relative</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="GraphicProperties(org.odftoolkit.odfdom.dom.element.style.StyleGraphicPropertiesElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>GraphicProperties</h4> |
| <pre>protected GraphicProperties(org.odftoolkit.odfdom.dom.element.style.StyleGraphicPropertiesElement properties)</pre> |
| <div class="block">Create a paragraph style setting object, which has the association with |
| an element "style:paragraph-properties".</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - - the element "style:paragraph-properties"</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getOrCreateGraphicProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrCreateGraphicProperties</h4> |
| <pre>public static <a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html" title="class in org.odftoolkit.simple.style">GraphicProperties</a> getOrCreateGraphicProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase style)</pre> |
| <div class="block">Return an instance of |
| <code>GraphicProperties</p> to represent the "style:graphic-properties" in a style element. |
| <p>If there is no "style:graphic-properties" defined in the style element, a new "style:graphic-properties" element will be created.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>style</code> - - a style element</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an instance of <code>GraphicProperties</p></dd></dl> |
| </li> |
| </ul> |
| <a name="getGraphicProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGraphicProperties</h4> |
| <pre>public static <a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html" title="class in org.odftoolkit.simple.style">GraphicProperties</a> getGraphicProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase style)</pre> |
| <div class="block">Return an instance of |
| <code>GraphicProperties</p> to represent the "style:graphic-properties" in a style element. |
| <p>If there is no "style:graphic-properties" defined in the style element, null will be returned.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>style</code> - - a style element</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an instance of <code>GraphicProperties</p>;Null if there is no |
| "style:graphic-properties" defined</dd></dl> |
| </li> |
| </ul> |
| <a name="setBorders(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType, org.odftoolkit.simple.style.Border)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBorders</h4> |
| <pre>public void setBorders(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.CellBordersType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.CellBordersType</a> bordersType, |
| <a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> border)</pre> |
| <div class="block">Set the border style. |
| <p> |
| The first parameter <code>bordersType</code> describes which borders you |
| want to apply the style to, e.g. up border, bottom border, left border, |
| right border, diagonal lines or four borders. |
| <p> |
| The border style information will be removed if the parameter |
| <code>bordersType</code> is NONE.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>bordersType</code> - - the type of the borders</dd><dd><code>border</code> - - the border style description</dd></dl> |
| </li> |
| </ul> |
| <a name="getBorder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBorder</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> getBorder()</pre> |
| <div class="block">Return the border setting for all four borders. |
| <p> |
| Null will be returned if there is no border setting for all four borders.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the border setting</dd></dl> |
| </li> |
| </ul> |
| <a name="getTopBorder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTopBorder</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> getTopBorder()</pre> |
| <div class="block">Return the border setting for the top border. |
| <p> |
| Null will be returned if there is no border setting for the top border.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the border setting</dd></dl> |
| </li> |
| </ul> |
| <a name="getLeftBorder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLeftBorder</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> getLeftBorder()</pre> |
| <div class="block">Return the border setting for the left border. |
| <p> |
| Null will be returned if there is no border setting for the left border.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the border setting</dd></dl> |
| </li> |
| </ul> |
| <a name="getRightBorder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRightBorder</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> getRightBorder()</pre> |
| <div class="block">Return the border setting for the right border. |
| <p> |
| Null will be returned if there is no border setting for the right border.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the border setting</dd></dl> |
| </li> |
| </ul> |
| <a name="getBottomBorder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBottomBorder</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> getBottomBorder()</pre> |
| <div class="block">Return the border setting for the bottom border. |
| <p> |
| Null will be returned if there is no border setting for the bottom |
| border.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the border setting</dd></dl> |
| </li> |
| </ul> |
| <a name="setBottomBorder(org.odftoolkit.simple.style.Border)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBottomBorder</h4> |
| <pre>public void setBottomBorder(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> border)</pre> |
| <div class="block">Set the border definition for the bottom border. |
| <p> |
| If the parameter <code>border</code> is null, the border definition for |
| the bottom border will be removed. |
| <p> |
| If the line type in the border definition is NONE, the border definition |
| for the bottom border will be removed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - - the border setting</dd></dl> |
| </li> |
| </ul> |
| <a name="setTopBorder(org.odftoolkit.simple.style.Border)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTopBorder</h4> |
| <pre>public void setTopBorder(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> border)</pre> |
| <div class="block">Set the border definition for the top border. |
| <p> |
| If the parameter <code>border</code> is null, the border definition for |
| the top border will be removed. |
| <p> |
| If the line type in the border definition is NONE, the border definition |
| for the top border will be removed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - - the border setting</dd></dl> |
| </li> |
| </ul> |
| <a name="setLeftBorder(org.odftoolkit.simple.style.Border)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLeftBorder</h4> |
| <pre>public void setLeftBorder(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> border)</pre> |
| <div class="block">Set the border definition for the left border. |
| <p> |
| If the parameter <code>border</code> is null, the border definition for |
| the left border will be removed. |
| <p> |
| If the line type in the border definition is NONE, the border definition |
| for the left border will be removed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - - the border setting</dd></dl> |
| </li> |
| </ul> |
| <a name="setRightBorder(org.odftoolkit.simple.style.Border)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRightBorder</h4> |
| <pre>public void setRightBorder(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> border)</pre> |
| <div class="block">Set the border definition for the right border. |
| <p> |
| If the parameter <code>border</code> is null, the border definition for |
| the right border will be removed. |
| <p> |
| If the line type in the border definition is NONE, the border definition |
| for the right border will be removed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - - the border setting</dd></dl> |
| </li> |
| </ul> |
| <a name="setBorder(org.odftoolkit.simple.style.Border)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBorder</h4> |
| <pre>public void setBorder(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a> border)</pre> |
| <div class="block">Set the border definition for all four borders. |
| <p> |
| If the parameter <code>border</code> is null, the border definition for |
| all four borders will be removed. |
| <p> |
| If the line type in the border definition is NONE, the border definition |
| for all four borders will be removed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - - the border setting</dd></dl> |
| </li> |
| </ul> |
| <a name="setStroke(org.odftoolkit.simple.style.StyleTypeDefinitions.OdfDrawStroke, org.odftoolkit.odfdom.type.Color, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStroke</h4> |
| <pre>public void setStroke(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.OdfDrawStroke.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.OdfDrawStroke</a> stroke, |
| org.odftoolkit.odfdom.type.Color color, |
| <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> widthDesc, |
| <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> dashStyleName)</pre> |
| <div class="block">Set the style of stroke. |
| <p> |
| There are three types of stroke: none, solid and dash. |
| <p> |
| If the stroke is NONE, there is no stroke around the frame. |
| <p> |
| If the stroke is SOLID, there is solid line around the frame. color and |
| width need to be specified. |
| <p> |
| If the stroke is DASH, there is dash line around the frame. color, width |
| and the style name of dash line need to be specified.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>stroke</code> - the stroke type</dd><dd><code>color</code> - the color of the stroke</dd><dd><code>widthDesc</code> - the width description of the stroke, e.g. "0.01in"</dd><dd><code>dashStyleName</code> - the dash style name</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.OdfDrawStroke.html" title="enum in org.odftoolkit.simple.style"><code>StyleTypeDefinitions.OdfDrawStroke</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setFill(org.odftoolkit.simple.style.StyleTypeDefinitions.OdfDrawFill, org.odftoolkit.odfdom.type.Color)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFill</h4> |
| <pre>public void setFill(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.OdfDrawFill.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.OdfDrawFill</a> fillType, |
| org.odftoolkit.odfdom.type.Color color)</pre> |
| <div class="block">Set the fill style for a graphic object. |
| |
| <p> |
| This method supports 2 types of fill: none and solid. |
| <p> |
| If the fill type is NONE, the object is no filled at all. |
| <p> |
| If the fill type is SOLID, the drawing object is filled with the color |
| specified by the second parameter.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fillType</code> - the fill style type</dd><dd><code>color</code> - the specified color</dd></dl> |
| </li> |
| </ul> |
| <a name="setStyleRunThrough(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStyleRunThrough</h4> |
| <pre>public void setStyleRunThrough(boolean isBackgroundObject)</pre> |
| <div class="block">Set whether the content of a graphic object is displayed in the |
| background or foreground. If it's displayed in the background, the |
| content wouldn't be selected or moved.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>isBackgroundObject</code> - If <code>true</code>, the graphic object is displayed in the |
| background.</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.5.5</dd></dl> |
| </li> |
| </ul> |
| <a name="setHorizontalPosition(org.odftoolkit.simple.style.StyleTypeDefinitions.FrameHorizontalPosition)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHorizontalPosition</h4> |
| <pre>public void setHorizontalPosition(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.FrameHorizontalPosition.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.FrameHorizontalPosition</a> horizontalPos)</pre> |
| <div class="block">Set the horizontal position</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>horizontalPos</code> - the horizontal position</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.5.5</dd></dl> |
| </li> |
| </ul> |
| <a name="setHorizontalRelative(org.odftoolkit.simple.style.StyleTypeDefinitions.HorizontalRelative)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHorizontalRelative</h4> |
| <pre>public void setHorizontalRelative(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalRelative.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalRelative</a> relative)</pre> |
| <div class="block">Set the horizontal relative</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>relative</code> - the horizontal relative</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.5.5</dd></dl> |
| </li> |
| </ul> |
| <a name="setVerticalRelative(org.odftoolkit.simple.style.StyleTypeDefinitions.VerticalRelative)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVerticalRelative</h4> |
| <pre>public void setVerticalRelative(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalRelative.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalRelative</a> relative)</pre> |
| <div class="block">Set the vertical relative</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>relative</code> - the vertical relative</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.5.5</dd></dl> |
| </li> |
| </ul> |
| <a name="setVerticalPosition(org.odftoolkit.simple.style.StyleTypeDefinitions.FrameVerticalPosition)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVerticalPosition</h4> |
| <pre>public void setVerticalPosition(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.FrameVerticalPosition.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.FrameVerticalPosition</a> verticalPos)</pre> |
| <div class="block">Set the vertical position</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>verticalPos</code> - the vertical position</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.5.5</dd></dl> |
| </li> |
| </ul> |
| <a name="getHorizontalPosition()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHorizontalPosition</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.FrameHorizontalPosition.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.FrameHorizontalPosition</a> getHorizontalPosition()</pre> |
| <div class="block">Return the horizontal position</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the horizontal position</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.5.5</dd></dl> |
| </li> |
| </ul> |
| <a name="getVerticalPosition()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVerticalPosition</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.FrameVerticalPosition.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.FrameVerticalPosition</a> getVerticalPosition()</pre> |
| <div class="block">Return the vertical position</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the vertical position</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.5.5</dd></dl> |
| </li> |
| </ul> |
| <a name="getVerticalRelative()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVerticalRelative</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.VerticalRelative.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.VerticalRelative</a> getVerticalRelative()</pre> |
| <div class="block">Return the vertical relative</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the vertical relative</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.5.5</dd></dl> |
| </li> |
| </ul> |
| <a name="getHorizontalRelative()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getHorizontalRelative</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalRelative.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalRelative</a> getHorizontalRelative()</pre> |
| <div class="block">Return the horizontal relative</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the horizontal relative</dd><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/GraphicProperties.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/style/Font.html" title="class in org.odftoolkit.simple.style"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/simple/style/MasterPage.html" title="class in org.odftoolkit.simple.style"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/odftoolkit/simple/style/GraphicProperties.html" target="_top">Frames</a></li> |
| <li><a href="GraphicProperties.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> |