Modified: poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFShape.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFShape.html?rev=1692602&r1=1692601&r2=1692602&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFShape.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFShape.html Sat Jul 25 06:26:33 2015 @@ -93,14 +93,19 @@ <ul class="blockList"> <li class="blockList"> <dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/poi/sl/usermodel/Shape.html" title="interface in org.apache.poi.sl.usermodel">Shape</a></dd> +</dl> +<dl> <dt>Direct Known Subclasses:</dt> -<dd><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFGraphicFrame.html" title="class in org.apache.poi.xslf.usermodel">XSLFGraphicFrame</a>, <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFGroupShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFGroupShape</a>, <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSimpleShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFSimpleShape</a></dd> +<dd><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFGraphicFrame.html" title="class in org.apache.poi.xslf.usermodel">XSLFGraphicFrame</a>, <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFGroupShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFGroupShape</a>, <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShadow.html" title="class in org.apache.poi.xslf.usermodel">XSLFShadow</a>, <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSimpleShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFSimpleShape</a></dd> </dl> <hr> <br> <pre><a href="../../../../../org/apache/poi/util/Beta.html" title="annotation in org.apache.poi.util">@Beta</a> public abstract class <span class="strong">XSLFShape</span> -extends java.lang.Object</pre> +extends java.lang.Object +implements <a href="../../../../../org/apache/poi/sl/usermodel/Shape.html" title="interface in org.apache.poi.sl.usermodel">Shape</a></pre> <div class="block">Base super-class class for all shapes in PresentationML</div> <dl><dt><span class="strong">Author:</span></dt> <dd>Yegor Kozlov</dd></dl> @@ -119,10 +124,13 @@ extends java.lang.Object</pre> <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> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#XSLFShape()">XSLFShape</a></strong>()</code> </td> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#XSLFShape(org.apache.xmlbeans.XmlObject,%20org.apache.poi.xslf.usermodel.XSLFSheet)">XSLFShape</a></strong>(org.apache.xmlbeans.XmlObject shape, + <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html" title="class in org.apache.poi.xslf.usermodel">XSLFSheet</a> sheet)</code> </td> </tr> </table> </li> @@ -140,71 +148,118 @@ extends java.lang.Object</pre> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#applyTransform(java.awt.Graphics2D)">applyTransform</a></strong>(java.awt.Graphics2D graphics)</code> -<div class="block">Apply 2-D transforms before drawing this shape.</div> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#fetchShapeProperty(org.apache.poi.xslf.model.PropertyFetcher)">fetchShapeProperty</a></strong>(<a href="../../../../../org/apache/poi/xslf/model/PropertyFetcher.html" title="class in org.apache.poi.xslf.model">PropertyFetcher</a><?> visitor)</code> +<div class="block">Walk up the inheritance tree and fetch shape properties.</div> </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code>abstract void</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#draw(java.awt.Graphics2D)">draw</a></strong>(java.awt.Graphics2D graphics)</code> -<div class="block">Draw this shape into the supplied canvas</div> -</td> +<td class="colFirst"><code>protected org.openxmlformats.schemas.presentationml.x2006.main.CTBackgroundProperties</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getBgPr()">getBgPr</a></strong>()</code> </td> </tr> <tr class="altColor"> -<td class="colFirst"><code>abstract java.awt.geom.Rectangle2D</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getAnchor()">getAnchor</a></strong>()</code> </td> +<td class="colFirst"><code>protected org.openxmlformats.schemas.drawingml.x2006.main.CTStyleMatrixReference</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getBgRef()">getBgRef</a></strong>()</code> </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code>abstract boolean</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getFlipHorizontal()">getFlipHorizontal</a></strong>()</code> -<div class="block">Whether the shape is horizontally flipped</div> -</td> +<td class="colFirst"><code>protected org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualDrawingProps</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getCNvPr()">getCNvPr</a></strong>()</code> </td> </tr> <tr class="altColor"> -<td class="colFirst"><code>abstract boolean</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getFlipVertical()">getFlipVertical</a></strong>()</code> -<div class="block">Whether the shape is vertically flipped</div> -</td> +<td class="colFirst"><code>protected org.openxmlformats.schemas.presentationml.x2006.main.CTPlaceholder</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getCTPlaceholder()">getCTPlaceholder</a></strong>()</code> </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code>abstract double</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getRotation()">getRotation</a></strong>()</code> -<div class="block">Rotation angle in degrees</div> -</td> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getFillPaint()">getFillPaint</a></strong>()</code> </td> </tr> <tr class="altColor"> -<td class="colFirst"><code>abstract int</code></td> +<td class="colFirst"><code>protected org.openxmlformats.schemas.drawingml.x2006.main.CTGroupShapeProperties</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getGrpSpPr()">getGrpSpPr</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getPaint(org.apache.xmlbeans.XmlObject,%20org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor)">getPaint</a></strong>(org.apache.xmlbeans.XmlObject spPr, + org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor phClr)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" title="interface in org.apache.poi.xslf.usermodel">XSLFShapeContainer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getParent()">getParent</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getShapeId()">getShapeId</a></strong>()</code> <div class="block">Returns a unique identifier for this shape within the current document.</div> </td> </tr> -<tr class="rowColor"> -<td class="colFirst"><code>abstract java.lang.String</code></td> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getShapeName()">getShapeName</a></strong>()</code> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html" title="class in org.apache.poi.xslf.usermodel">XSLFSheet</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getSheet()">getSheet</a></strong>()</code> </td> +</tr> <tr class="altColor"> -<td class="colFirst"><code>abstract org.apache.xmlbeans.XmlObject</code></td> +<td class="colFirst"><code>protected org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getSpPr()">getSpPr</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected org.openxmlformats.schemas.drawingml.x2006.main.CTShapeStyle</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getSpStyle()">getSpStyle</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.apache.xmlbeans.XmlObject</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#getXmlObject()">getXmlObject</a></strong>()</code> </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code>abstract void</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#setAnchor(java.awt.geom.Rectangle2D)">setAnchor</a></strong>(java.awt.geom.Rectangle2D anchor)</code> </td> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#selectPaint(org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties,%20org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor,%20org.apache.poi.openxml4j.opc.PackagePart)">selectPaint</a></strong>(org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties blipFill, + org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor phClr, + <a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a> parentPart)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#selectPaint(org.openxmlformats.schemas.drawingml.x2006.main.CTGradientFillProperties,%20org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor,%20org.apache.poi.openxml4j.opc.PackagePart)">selectPaint</a></strong>(org.openxmlformats.schemas.drawingml.x2006.main.CTGradientFillProperties gradFill, + org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor phClr, + <a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a> parentPart)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#selectPaint(org.openxmlformats.schemas.drawingml.x2006.main.CTSolidColorFillProperties,%20org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor,%20org.apache.poi.openxml4j.opc.PackagePart)">selectPaint</a></strong>(org.openxmlformats.schemas.drawingml.x2006.main.CTSolidColorFillProperties solidFill, + org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor phClr, + <a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a> parentPart)</code> </td> </tr> <tr class="altColor"> -<td class="colFirst"><code>abstract void</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#setFlipHorizontal(boolean)">setFlipHorizontal</a></strong>(boolean flip)</code> </td> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#selectPaint(org.openxmlformats.schemas.drawingml.x2006.main.CTStyleMatrixReference)">selectPaint</a></strong>(org.openxmlformats.schemas.drawingml.x2006.main.CTStyleMatrixReference fillRef)</code> </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code>abstract void</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#setFlipVertical(boolean)">setFlipVertical</a></strong>(boolean flip)</code> -<div class="block">Whether the shape is vertically flipped</div> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#selectPaint(org.apache.xmlbeans.XmlObject,%20org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor,%20org.apache.poi.openxml4j.opc.PackagePart)">selectPaint</a></strong>(org.apache.xmlbeans.XmlObject obj, + org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor phClr, + <a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a> parentPart)</code> +<div class="block">Convert shape fill into java.awt.Paint.</div> </td> </tr> <tr class="altColor"> -<td class="colFirst"><code>abstract void</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#setRotation(double)">setRotation</a></strong>(double theta)</code> -<div class="block">Rotate this shape.</div> +<td class="colFirst"><code>protected <T extends org.apache.xmlbeans.XmlObject> <br>T</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#selectProperty(java.lang.Class,%20java.lang.String)">selectProperty</a></strong>(java.lang.Class<T> resultClass, + java.lang.String xquery)</code> +<div class="block">As there's no xmlbeans hierarchy, but XSLF works with subclassing, not all + child classes work with a <code>CTShape</code> object, but often contain the same + properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#setParent(org.apache.poi.xslf.usermodel.XSLFShapeContainer)">setParent</a></strong>(<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" title="interface in org.apache.poi.xslf.usermodel">XSLFShapeContainer</a> parent)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html#setPlaceholder(org.apache.poi.xslf.usermodel.Placeholder)">setPlaceholder</a></strong>(<a href="../../../../../org/apache/poi/xslf/usermodel/Placeholder.html" title="enum in org.apache.poi.xslf.usermodel">Placeholder</a> placeholder)</code> +<div class="block">Specifies that the corresponding shape should be represented by the generating application + as a placeholder.</div> </td> </tr> </table> @@ -229,13 +284,14 @@ extends java.lang.Object</pre> <!-- --> </a> <h3>Constructor Detail</h3> -<a name="XSLFShape()"> +<a name="XSLFShape(org.apache.xmlbeans.XmlObject, org.apache.poi.xslf.usermodel.XSLFSheet)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>XSLFShape</h4> -<pre>public XSLFShape()</pre> +<pre>protected XSLFShape(org.apache.xmlbeans.XmlObject shape, + <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html" title="class in org.apache.poi.xslf.usermodel">XSLFSheet</a> sheet)</pre> </li> </ul> </li> @@ -246,36 +302,27 @@ extends java.lang.Object</pre> <!-- --> </a> <h3>Method Detail</h3> -<a name="getAnchor()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getAnchor</h4> -<pre>public abstract java.awt.geom.Rectangle2D getAnchor()</pre> -<dl><dt><span class="strong">Returns:</span></dt><dd>the position of this shape within the drawing canvas. - The coordinates are expressed in points</dd></dl> -</li> -</ul> -<a name="setAnchor(java.awt.geom.Rectangle2D)"> +<a name="getXmlObject()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setAnchor</h4> -<pre>public abstract void setAnchor(java.awt.geom.Rectangle2D anchor)</pre> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>anchor</code> - the position of this shape within the drawing canvas. - The coordinates are expressed in points</dd></dl> +<h4>getXmlObject</h4> +<pre>public final org.apache.xmlbeans.XmlObject getXmlObject()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the xml bean holding this shape's data</dd></dl> </li> </ul> -<a name="getXmlObject()"> +<a name="getSheet()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getXmlObject</h4> -<pre>public abstract org.apache.xmlbeans.XmlObject getXmlObject()</pre> -<dl><dt><span class="strong">Returns:</span></dt><dd>the xml bean holding this shape's data</dd></dl> +<h4>getSheet</h4> +<pre>public <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html" title="class in org.apache.poi.xslf.usermodel">XSLFSheet</a> getSheet()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/sl/usermodel/Shape.html#getSheet()">getSheet</a></code> in interface <code><a href="../../../../../org/apache/poi/sl/usermodel/Shape.html" title="interface in org.apache.poi.sl.usermodel">Shape</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the sheet this shape belongs to</dd></dl> </li> </ul> <a name="getShapeName()"> @@ -284,7 +331,7 @@ extends java.lang.Object</pre> <ul class="blockList"> <li class="blockList"> <h4>getShapeName</h4> -<pre>public abstract java.lang.String getShapeName()</pre> +<pre>public java.lang.String getShapeName()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>human-readable name of this shape, e.g. "Rectange 3"</dd></dl> </li> </ul> @@ -294,7 +341,7 @@ extends java.lang.Object</pre> <ul class="blockList"> <li class="blockList"> <h4>getShapeId</h4> -<pre>public abstract int getShapeId()</pre> +<pre>public int getShapeId()</pre> <div class="block">Returns a unique identifier for this shape within the current document. This ID may be used to assist in uniquely identifying this object so that it can be referred to by other parts of the document. @@ -305,99 +352,221 @@ extends java.lang.Object</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>unique id of this shape</dd></dl> </li> </ul> -<a name="setRotation(double)"> +<a name="setParent(org.apache.poi.xslf.usermodel.XSLFShapeContainer)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setRotation</h4> -<pre>public abstract void setRotation(double theta)</pre> -<div class="block">Rotate this shape. - <p> - Positive angles are clockwise (i.e., towards the positive y axis); - negative angles are counter-clockwise (i.e., towards the negative y axis). - </p></div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theta</code> - the rotation angle in degrees.</dd></dl> +<h4>setParent</h4> +<pre>public void setParent(<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" title="interface in org.apache.poi.xslf.usermodel">XSLFShapeContainer</a> parent)</pre> +</li> +</ul> +<a name="getParent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParent</h4> +<pre>public <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" title="interface in org.apache.poi.xslf.usermodel">XSLFShapeContainer</a> getParent()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/sl/usermodel/Shape.html#getParent()">getParent</a></code> in interface <code><a href="../../../../../org/apache/poi/sl/usermodel/Shape.html" title="interface in org.apache.poi.sl.usermodel">Shape</a></code></dd> +</dl> +</li> +</ul> +<a name="getFillPaint()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFillPaint</h4> +<pre>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a> getFillPaint()</pre> +</li> +</ul> +<a name="getBgPr()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBgPr</h4> +<pre>protected org.openxmlformats.schemas.presentationml.x2006.main.CTBackgroundProperties getBgPr()</pre> +</li> +</ul> +<a name="getBgRef()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBgRef</h4> +<pre>protected org.openxmlformats.schemas.drawingml.x2006.main.CTStyleMatrixReference getBgRef()</pre> +</li> +</ul> +<a name="getGrpSpPr()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGrpSpPr</h4> +<pre>protected org.openxmlformats.schemas.drawingml.x2006.main.CTGroupShapeProperties getGrpSpPr()</pre> +</li> +</ul> +<a name="getCNvPr()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCNvPr</h4> +<pre>protected org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualDrawingProps getCNvPr()</pre> +</li> +</ul> +<a name="getSpPr()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSpPr</h4> +<pre>protected org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties getSpPr()</pre> +</li> +</ul> +<a name="getSpStyle()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSpStyle</h4> +<pre>protected org.openxmlformats.schemas.drawingml.x2006.main.CTShapeStyle getSpStyle()</pre> +</li> +</ul> +<a name="getCTPlaceholder()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCTPlaceholder</h4> +<pre>protected org.openxmlformats.schemas.presentationml.x2006.main.CTPlaceholder getCTPlaceholder()</pre> +</li> +</ul> +<a name="setPlaceholder(org.apache.poi.xslf.usermodel.Placeholder)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPlaceholder</h4> +<pre>protected void setPlaceholder(<a href="../../../../../org/apache/poi/xslf/usermodel/Placeholder.html" title="enum in org.apache.poi.xslf.usermodel">Placeholder</a> placeholder)</pre> +<div class="block">Specifies that the corresponding shape should be represented by the generating application + as a placeholder. When a shape is considered a placeholder by the generating application + it can have special properties to alert the user that they may enter content into the shape. + Different types of placeholders are allowed and can be specified by using the placeholder + type attribute for this element</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>placeholder</code> - </dd></dl> +</li> +</ul> +<a name="selectProperty(java.lang.Class, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectProperty</h4> +<pre>protected <T extends org.apache.xmlbeans.XmlObject> T selectProperty(java.lang.Class<T> resultClass, + java.lang.String xquery)</pre> +<div class="block">As there's no xmlbeans hierarchy, but XSLF works with subclassing, not all + child classes work with a <code>CTShape</code> object, but often contain the same + properties. This method is the generalized form of selecting and casting those + properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>resultClass</code> - </dd><dd><code>xquery</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd></dd></dl> </li> </ul> -<a name="getRotation()"> +<a name="fetchShapeProperty(org.apache.poi.xslf.model.PropertyFetcher)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getRotation</h4> -<pre>public abstract double getRotation()</pre> -<div class="block">Rotation angle in degrees +<h4>fetchShapeProperty</h4> +<pre>protected boolean fetchShapeProperty(<a href="../../../../../org/apache/poi/xslf/model/PropertyFetcher.html" title="class in org.apache.poi.xslf.model">PropertyFetcher</a><?> visitor)</pre> +<div class="block">Walk up the inheritance tree and fetch shape properties. + + The following order of inheritance is assumed: <p> - Positive angles are clockwise (i.e., towards the positive y axis); - negative angles are counter-clockwise (i.e., towards the negative y axis). + slide <-- slideLayout <-- slideMaster </p></div> -<dl><dt><span class="strong">Returns:</span></dt><dd>rotation angle in degrees</dd></dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - the object that collects the desired property</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the property was fetched</dd></dl> </li> </ul> -<a name="setFlipHorizontal(boolean)"> +<a name="getPaint(org.apache.xmlbeans.XmlObject, org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setFlipHorizontal</h4> -<pre>public abstract void setFlipHorizontal(boolean flip)</pre> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>flip</code> - whether the shape is horizontally flipped</dd></dl> +<h4>getPaint</h4> +<pre>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a> getPaint(org.apache.xmlbeans.XmlObject spPr, + org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor phClr)</pre> </li> </ul> -<a name="setFlipVertical(boolean)"> +<a name="selectPaint(org.apache.xmlbeans.XmlObject, org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor, org.apache.poi.openxml4j.opc.PackagePart)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setFlipVertical</h4> -<pre>public abstract void setFlipVertical(boolean flip)</pre> -<div class="block">Whether the shape is vertically flipped</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>flip</code> - whether the shape is vertically flipped</dd></dl> +<h4>selectPaint</h4> +<pre>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a> selectPaint(org.apache.xmlbeans.XmlObject obj, + org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor phClr, + <a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a> parentPart)</pre> +<div class="block">Convert shape fill into java.awt.Paint. The result is either Color or + TexturePaint or GradientPaint or null</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>graphics</code> - the target graphics</dd><dd><code>obj</code> - the xml to read. Must contain elements from the EG_ColorChoice group: + <code> + a:scrgbClr RGB Color Model - Percentage Variant + a:srgbClr RGB Color Model - Hex Variant + a:hslClr Hue, Saturation, Luminance Color Model + a:sysClr System Color + a:schemeClr Scheme Color + a:prstClr Preset Color + </code></dd><dd><code>phClr</code> - context color</dd><dd><code>parentPart</code> - the parent package part. Any external references (images, etc.) are resolved relative to it.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the applied Paint or null if none was applied</dd></dl> </li> </ul> -<a name="getFlipHorizontal()"> +<a name="selectPaint(org.openxmlformats.schemas.drawingml.x2006.main.CTSolidColorFillProperties, org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor, org.apache.poi.openxml4j.opc.PackagePart)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getFlipHorizontal</h4> -<pre>public abstract boolean getFlipHorizontal()</pre> -<div class="block">Whether the shape is horizontally flipped</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>whether the shape is horizontally flipped</dd></dl> +<h4>selectPaint</h4> +<pre>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a> selectPaint(org.openxmlformats.schemas.drawingml.x2006.main.CTSolidColorFillProperties solidFill, + org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor phClr, + <a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a> parentPart)</pre> </li> </ul> -<a name="getFlipVertical()"> +<a name="selectPaint(org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties, org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor, org.apache.poi.openxml4j.opc.PackagePart)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getFlipVertical</h4> -<pre>public abstract boolean getFlipVertical()</pre> -<div class="block">Whether the shape is vertically flipped</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>whether the shape is vertically flipped</dd></dl> +<h4>selectPaint</h4> +<pre>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a> selectPaint(org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties blipFill, + org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor phClr, + <a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a> parentPart)</pre> </li> </ul> -<a name="draw(java.awt.Graphics2D)"> +<a name="selectPaint(org.openxmlformats.schemas.drawingml.x2006.main.CTGradientFillProperties, org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor, org.apache.poi.openxml4j.opc.PackagePart)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>draw</h4> -<pre>public abstract void draw(java.awt.Graphics2D graphics)</pre> -<div class="block">Draw this shape into the supplied canvas</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>graphics</code> - the graphics to draw into</dd></dl> +<h4>selectPaint</h4> +<pre>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a> selectPaint(org.openxmlformats.schemas.drawingml.x2006.main.CTGradientFillProperties gradFill, + org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor phClr, + <a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a> parentPart)</pre> </li> </ul> -<a name="applyTransform(java.awt.Graphics2D)"> +<a name="selectPaint(org.openxmlformats.schemas.drawingml.x2006.main.CTStyleMatrixReference)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> -<h4>applyTransform</h4> -<pre>protected void applyTransform(java.awt.Graphics2D graphics)</pre> -<div class="block">Apply 2-D transforms before drawing this shape. This includes rotation and flipping.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>graphics</code> - the graphics whos transform matrix will be modified</dd></dl> +<h4>selectPaint</h4> +<pre>protected <a href="../../../../../org/apache/poi/sl/usermodel/PaintStyle.html" title="interface in org.apache.poi.sl.usermodel">PaintStyle</a> selectPaint(org.openxmlformats.schemas.drawingml.x2006.main.CTStyleMatrixReference fillRef)</pre> </li> </ul> </li>
Modified: poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFShapeContainer.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFShapeContainer.html?rev=1692602&r1=1692601&r2=1692602&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFShapeContainer.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFShapeContainer.html Sat Jul 25 06:26:33 2015 @@ -35,7 +35,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeType.html" title="enum in org.apache.poi.xslf.usermodel"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html" title="class in org.apache.poi.xslf.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" target="_top">Frames</a></li> @@ -86,7 +86,7 @@ <li class="blockList"> <dl> <dt>All Superinterfaces:</dt> -<dd>java.lang.Iterable<<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>></dd> +<dd>java.lang.Iterable<<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>>, <a href="../../../../../org/apache/poi/sl/usermodel/ShapeContainer.html" title="interface in org.apache.poi.sl.usermodel">ShapeContainer</a><<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>></dd> </dl> <dl> <dt>All Known Implementing Classes:</dt> @@ -95,7 +95,7 @@ <hr> <br> <pre>public interface <span class="strong">XSLFShapeContainer</span> -extends java.lang.Iterable<<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>></pre> +extends <a href="../../../../../org/apache/poi/sl/usermodel/ShapeContainer.html" title="interface in org.apache.poi.sl.usermodel">ShapeContainer</a><<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>></pre> <div class="block">Common interface for shape containers, e.g. sheets or groups of shapes</div> </li> </ul> @@ -157,22 +157,15 @@ extends java.lang.Iterable<<a href=". <div class="block">create a text box</div> </td> </tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>[]</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html#getShapes()">getShapes</a></strong>()</code> -<div class="block">Returns an array containing all of the elements in this container in proper - sequence (from first to last element).</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html#removeShape(org.apache.poi.xslf.usermodel.XSLFShape)">removeShape</a></strong>(<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a> xShape)</code> -<div class="block">Removes the specified shape from this sheet, if it is present - (optional operation).</div> -</td> -</tr> </table> <ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.sl.usermodel.ShapeContainer"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.poi.sl.usermodel.<a href="../../../../../org/apache/poi/sl/usermodel/ShapeContainer.html" title="interface in org.apache.poi.sl.usermodel">ShapeContainer</a></h3> +<code><a href="../../../../../org/apache/poi/sl/usermodel/ShapeContainer.html#addShape(T)">addShape</a>, <a href="../../../../../org/apache/poi/sl/usermodel/ShapeContainer.html#getShapes()">getShapes</a>, <a href="../../../../../org/apache/poi/sl/usermodel/ShapeContainer.html#removeShape(T)">removeShape</a></code></li> +</ul> +<ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Iterable"> <!-- --> </a> @@ -253,36 +246,6 @@ extends java.lang.Iterable<<a href=". <div class="block">create a picture belonging to this container</div> </li> </ul> -<a name="getShapes()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getShapes</h4> -<pre><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>[] getShapes()</pre> -<div class="block">Returns an array containing all of the elements in this container in proper - sequence (from first to last element).</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing all of the elements in this container in proper - sequence</dd></dl> -</li> -</ul> -<a name="removeShape(org.apache.poi.xslf.usermodel.XSLFShape)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>removeShape</h4> -<pre>boolean removeShape(<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a> xShape)</pre> -<div class="block">Removes the specified shape from this sheet, if it is present - (optional operation). If this sheet does not contain the element, - it is unchanged.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xShape</code> - shape to be removed from this sheet, if present</dd> -<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this sheet contained the specified element</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code>java.lang.IllegalArgumentException</code> - if the type of the specified shape - is incompatible with this sheet (optional)</dd></dl> -</li> -</ul> <a name="clear()"> <!-- --> </a> @@ -321,7 +284,7 @@ extends java.lang.Iterable<<a href=". <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeType.html" title="enum in org.apache.poi.xslf.usermodel"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html" title="class in org.apache.poi.xslf.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" target="_top">Frames</a></li> Modified: poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFSheet.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFSheet.html?rev=1692602&r1=1692601&r2=1692602&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFSheet.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFSheet.html Sat Jul 25 06:26:33 2015 @@ -34,7 +34,7 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeType.html" title="enum in org.apache.poi.xslf.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" title="interface in org.apache.poi.xslf.usermodel"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSimpleShape.html" title="class in org.apache.poi.xslf.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> @@ -99,7 +99,7 @@ <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> -<dd>java.lang.Iterable<<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>>, <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" title="interface in org.apache.poi.xslf.usermodel">XSLFShapeContainer</a></dd> +<dd>java.lang.Iterable<<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>>, <a href="../../../../../org/apache/poi/sl/usermodel/ShapeContainer.html" title="interface in org.apache.poi.sl.usermodel">ShapeContainer</a><<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>>, <a href="../../../../../org/apache/poi/sl/usermodel/Sheet.html" title="interface in org.apache.poi.sl.usermodel">Sheet</a><<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>,<a href="../../../../../org/apache/poi/xslf/usermodel/XMLSlideShow.html" title="class in org.apache.poi.xslf.usermodel">XMLSlideShow</a>>, <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" title="interface in org.apache.poi.xslf.usermodel">XSLFShapeContainer</a></dd > </dl> <dl> <dt>Direct Known Subclasses:</dt> @@ -110,7 +110,7 @@ <pre><a href="../../../../../org/apache/poi/util/Beta.html" title="annotation in org.apache.poi.util">@Beta</a> public abstract class <span class="strong">XSLFSheet</span> extends <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a> -implements <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" title="interface in org.apache.poi.xslf.usermodel">XSLFShapeContainer</a></pre> +implements <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" title="interface in org.apache.poi.xslf.usermodel">XSLFShapeContainer</a>, <a href="../../../../../org/apache/poi/sl/usermodel/Sheet.html" title="interface in org.apache.poi.sl.usermodel">Sheet</a><<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>,<a href="../../../../../org/apache/poi/xslf/usermodel/XMLSlideShow.html" title="class in org.apache.poi.xslf.usermodel">XMLSlideShow</a>></pre> </li> </ul> </div> @@ -166,95 +166,95 @@ implements <a href="../../../../../org/a <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#addShape(org.apache.poi.xslf.usermodel.XSLFShape)">addShape</a></strong>(<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a> shape)</code> </td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html" title="class in org.apache.poi.xslf.usermodel">XSLFSheet</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#appendContent(org.apache.poi.xslf.usermodel.XSLFSheet)">appendContent</a></strong>(<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html" title="class in org.apache.poi.xslf.usermodel">XSLFSheet</a> src)</code> <div class="block">Append content to this sheet.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>protected java.util.List<<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#buildShapes(org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape)">buildShapes</a></strong>(org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape spTree)</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>protected boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#canDraw(org.apache.poi.xslf.usermodel.XSLFShape)">canDraw</a></strong>(<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a> shape)</code> <div class="block">Checks if this <code>sheet</code> displays the specified shape.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#clear()">clear</a></strong>()</code> <div class="block">Removes all of the elements from this container (optional operation).</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#commit()">commit</a></strong>()</code> <div class="block">Save the content in the underlying package part.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFAutoShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFAutoShape</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#createAutoShape()">createAutoShape</a></strong>()</code> <div class="block">create a new shape with a predefined geometry and add it to this shape container</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFConnectorShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFConnectorShape</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#createConnector()">createConnector</a></strong>()</code> <div class="block">create a connector</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFFreeformShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFFreeformShape</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#createFreeform()">createFreeform</a></strong>()</code> <div class="block">create a new shape with a custom geometry</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFGroupShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFGroupShape</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#createGroup()">createGroup</a></strong>()</code> <div class="block">create a group of shapes belonging to this container</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFPictureShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFPictureShape</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#createPicture(int)">createPicture</a></strong>(int pictureIndex)</code> <div class="block">create a picture belonging to this container</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFTable.html" title="class in org.apache.poi.xslf.usermodel">XSLFTable</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#createTable()">createTable</a></strong>()</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFTextBox.html" title="class in org.apache.poi.xslf.usermodel">XSLFTextBox</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#createTextBox()">createTextBox</a></strong>()</code> <div class="block">create a text box</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#draw(java.awt.Graphics2D)">draw</a></strong>(java.awt.Graphics2D graphics)</code> <div class="block">Render this sheet into the supplied graphics object</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFBackground.html" title="class in org.apache.poi.xslf.usermodel">XSLFBackground</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#getBackground()">getBackground</a></strong>()</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFCommonSlideData.html" title="class in org.apache.poi.xslf.usermodel">XSLFCommonSlideData</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#getCommonSlideData()">getCommonSlideData</a></strong>()</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#getFollowMasterGraphics()">getFollowMasterGraphics</a></strong>()</code> </td> </tr> -<tr class="altColor"> -<td class="colFirst"><code>abstract <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html" title="class in org.apache.poi.xslf.usermodel">XSLFSheet</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#getMasterSheet()">getMasterSheet</a></strong>()</code> </td> -</tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFTextShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFTextShape</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#getPlaceholder(int)">getPlaceholder</a></strong>(int idx)</code> </td> @@ -268,7 +268,7 @@ implements <a href="../../../../../org/a <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#getRootElementName()">getRootElementName</a></strong>()</code> </td> </tr> <tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>[]</code></td> +<td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html#getShapes()">getShapes</a></strong>()</code> <div class="block">Returns an array containing all of the shapes in this sheet</div> </td> @@ -327,6 +327,13 @@ implements <a href="../../../../../org/a <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> </ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.sl.usermodel.Sheet"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.poi.sl.usermodel.<a href="../../../../../org/apache/poi/sl/usermodel/Sheet.html" title="interface in org.apache.poi.sl.usermodel">Sheet</a></h3> +<code><a href="../../../../../org/apache/poi/sl/usermodel/Sheet.html#getMasterSheet()">getMasterSheet</a></code></li> +</ul> </li> </ul> </li> @@ -375,7 +382,10 @@ implements <a href="../../../../../org/a <li class="blockList"> <h4>getSlideShow</h4> <pre>public <a href="../../../../../org/apache/poi/xslf/usermodel/XMLSlideShow.html" title="class in org.apache.poi.xslf.usermodel">XMLSlideShow</a> getSlideShow()</pre> -<dl><dt><span class="strong">Returns:</span></dt><dd>the XMLSlideShow this sheet belongs to</dd></dl> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/sl/usermodel/Sheet.html#getSlideShow()">getSlideShow</a></code> in interface <code><a href="../../../../../org/apache/poi/sl/usermodel/Sheet.html" title="interface in org.apache.poi.sl.usermodel">Sheet</a><<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>,<a href="../../../../../org/apache/poi/xslf/usermodel/XMLSlideShow.html" title="class in org.apache.poi.xslf.usermodel">XMLSlideShow</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the XMLSlideShow this sheet belongs to</dd></dl> </li> </ul> <a name="buildShapes(org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape)"> @@ -521,11 +531,11 @@ public <a href="../../../../../org/ <ul class="blockList"> <li class="blockList"> <h4>getShapes</h4> -<pre>public <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>[] getShapes()</pre> +<pre>public java.util.List<<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>> getShapes()</pre> <div class="block">Returns an array containing all of the shapes in this sheet</div> <dl> <dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html#getShapes()">getShapes</a></code> in interface <code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" title="interface in org.apache.poi.xslf.usermodel">XSLFShapeContainer</a></code></dd> +<dd><code><a href="../../../../../org/apache/poi/sl/usermodel/ShapeContainer.html#getShapes()">getShapes</a></code> in interface <code><a href="../../../../../org/apache/poi/sl/usermodel/ShapeContainer.html" title="interface in org.apache.poi.sl.usermodel">ShapeContainer</a><<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>></code></dd> <dt><span class="strong">Returns:</span></dt><dd>an array of all shapes in this sheet</dd></dl> </li> </ul> @@ -543,6 +553,19 @@ public <a href="../../../../../org/ <dt><span class="strong">Returns:</span></dt><dd>an iterator over the shapes in this sheet</dd></dl> </li> </ul> +<a name="addShape(org.apache.poi.xslf.usermodel.XSLFShape)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addShape</h4> +<pre>public void addShape(<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a> shape)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/sl/usermodel/ShapeContainer.html#addShape(T)">addShape</a></code> in interface <code><a href="../../../../../org/apache/poi/sl/usermodel/ShapeContainer.html" title="interface in org.apache.poi.sl.usermodel">ShapeContainer</a><<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>></code></dd> +</dl> +</li> +</ul> <a name="removeShape(org.apache.poi.xslf.usermodel.XSLFShape)"> <!-- --> </a> @@ -555,7 +578,7 @@ public <a href="../../../../../org/ it is unchanged.</div> <dl> <dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html#removeShape(org.apache.poi.xslf.usermodel.XSLFShape)">removeShape</a></code> in interface <code><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" title="interface in org.apache.poi.xslf.usermodel">XSLFShapeContainer</a></code></dd> +<dd><code><a href="../../../../../org/apache/poi/sl/usermodel/ShapeContainer.html#removeShape(T)">removeShape</a></code> in interface <code><a href="../../../../../org/apache/poi/sl/usermodel/ShapeContainer.html" title="interface in org.apache.poi.sl.usermodel">ShapeContainer</a><<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>xShape</code> - shape to be removed from this sheet, if present</dd> <dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this sheet contained the specified element</dd> <dt><span class="strong">Throws:</span></dt> @@ -653,16 +676,6 @@ public <a href="../../../../../org/ <dt><span class="strong">Returns:</span></dt><dd>modified <code>this</code>.</dd></dl> </li> </ul> -<a name="getMasterSheet()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMasterSheet</h4> -<pre>public abstract <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSheet.html" title="class in org.apache.poi.xslf.usermodel">XSLFSheet</a> getMasterSheet()</pre> -<dl><dt><span class="strong">Returns:</span></dt><dd>master of this sheet.</dd></dl> -</li> -</ul> <a name="getTextShapeByType(org.apache.poi.xslf.usermodel.Placeholder)"> <!-- --> </a> @@ -713,7 +726,10 @@ public <a href="../../../../../org/ <li class="blockList"> <h4>getFollowMasterGraphics</h4> <pre>public boolean getFollowMasterGraphics()</pre> -<dl><dt><span class="strong">Returns:</span></dt><dd>whether shapes on the master sheet should be shown. By default master graphics is turned off. +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/sl/usermodel/Sheet.html#getFollowMasterGraphics()">getFollowMasterGraphics</a></code> in interface <code><a href="../../../../../org/apache/poi/sl/usermodel/Sheet.html" title="interface in org.apache.poi.sl.usermodel">Sheet</a><<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>,<a href="../../../../../org/apache/poi/xslf/usermodel/XMLSlideShow.html" title="class in org.apache.poi.xslf.usermodel">XMLSlideShow</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>whether shapes on the master sheet should be shown. By default master graphics is turned off. Sheets that support the notion of master (slide, slideLayout) should override it and check this setting in the sheet XML</dd></dl> </li> @@ -725,7 +741,10 @@ public <a href="../../../../../org/ <li class="blockList"> <h4>getBackground</h4> <pre>public <a href="../../../../../org/apache/poi/xslf/usermodel/XSLFBackground.html" title="class in org.apache.poi.xslf.usermodel">XSLFBackground</a> getBackground()</pre> -<dl><dt><span class="strong">Returns:</span></dt><dd>background for this sheet</dd></dl> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/sl/usermodel/Sheet.html#getBackground()">getBackground</a></code> in interface <code><a href="../../../../../org/apache/poi/sl/usermodel/Sheet.html" title="interface in org.apache.poi.sl.usermodel">Sheet</a><<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>,<a href="../../../../../org/apache/poi/xslf/usermodel/XMLSlideShow.html" title="class in org.apache.poi.xslf.usermodel">XMLSlideShow</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>background for this sheet</dd></dl> </li> </ul> <a name="draw(java.awt.Graphics2D)"> @@ -736,7 +755,10 @@ public <a href="../../../../../org/ <h4>draw</h4> <pre>public void draw(java.awt.Graphics2D graphics)</pre> <div class="block">Render this sheet into the supplied graphics object</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>graphics</code> - </dd></dl> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/sl/usermodel/Sheet.html#draw(java.awt.Graphics2D)">draw</a></code> in interface <code><a href="../../../../../org/apache/poi/sl/usermodel/Sheet.html" title="interface in org.apache.poi.sl.usermodel">Sheet</a><<a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShape.html" title="class in org.apache.poi.xslf.usermodel">XSLFShape</a>,<a href="../../../../../org/apache/poi/xslf/usermodel/XMLSlideShow.html" title="class in org.apache.poi.xslf.usermodel">XMLSlideShow</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>graphics</code> - </dd></dl> </li> </ul> </li> @@ -765,7 +787,7 @@ public <a href="../../../../../org/ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeType.html" title="enum in org.apache.poi.xslf.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFShapeContainer.html" title="interface in org.apache.poi.xslf.usermodel"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/xslf/usermodel/XSLFSimpleShape.html" title="class in org.apache.poi.xslf.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@poi.apache.org For additional commands, e-mail: commits-h...@poi.apache.org
