Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.xslf.usermodel
Class XSLFGroupShape

java.lang.Object
  extended by org.apache.poi.xslf.usermodel.XSLFShape
      extended by org.apache.poi.xslf.usermodel.XSLFGroupShape
All Implemented Interfaces:
java.lang.Iterable<XSLFShape>, GroupShape<XSLFShape,XSLFTextParagraph>, PlaceableShape<XSLFShape,XSLFTextParagraph>, Shape<XSLFShape,XSLFTextParagraph>, ShapeContainer<XSLFShape,XSLFTextParagraph>, XSLFShapeContainer
@Beta
public class XSLFGroupShape
extends XSLFShape
implements XSLFShapeContainer, GroupShape<XSLFShape,XSLFTextParagraph>

Represents a group shape that consists of many shapes grouped together.

Field Summary
 
Fields inherited from class org.apache.poi.xslf.usermodel.XSLFShape
PML_NS
 
Constructor Summary
protected XSLFGroupShape(org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape shape, XSLFSheet sheet)
           
 
Method Summary
 void addShape(XSLFShape shape)
           
 void clear()
          Removes all of the elements from this container (optional operation).
 XSLFAutoShape createAutoShape()
           
 XSLFConnectorShape createConnector()
           
 XSLFFreeformShape createFreeform()
           
 XSLFGroupShape createGroup()
           
 XSLFPictureShape createPicture(PictureData pictureData)
           
 XSLFTable createTable()
           
 XSLFTable createTable(int numRows, int numCols)
           
 XSLFTextBox createTextBox()
           
 java.awt.geom.Rectangle2D getAnchor()
           
 boolean getFlipHorizontal()
           
 boolean getFlipVertical()
           
protected  org.openxmlformats.schemas.drawingml.x2006.main.CTGroupShapeProperties getGrpSpPr()
           
 java.awt.geom.Rectangle2D getInteriorAnchor()
           
 double getRotation()
           
protected  org.openxmlformats.schemas.drawingml.x2006.main.CTGroupTransform2D getSafeXfrm()
           
 java.util.List<XSLFShape> getShapes()
           
protected  org.openxmlformats.schemas.drawingml.x2006.main.CTGroupTransform2D getXfrm()
           
 java.util.Iterator<XSLFShape> iterator()
          Returns an iterator over the shapes in this sheet
 boolean removeShape(XSLFShape xShape)
          Remove the specified shape from this group
 void setAnchor(java.awt.geom.Rectangle2D anchor)
           
 void setFlipHorizontal(boolean flip)
           
 void setFlipVertical(boolean flip)
           
 void setInteriorAnchor(java.awt.geom.Rectangle2D anchor)
           
 void setRotation(double theta)
           
 
Methods inherited from class org.apache.poi.xslf.usermodel.XSLFShape
draw, fetchShapeProperty, getBgPr, getBgRef, getChild, getCNvPr, getCTPlaceholder, getFillPaint, getParent, getPlaceholder, getShapeId, getShapeName, getShapeProperties, getSheet, getSpStyle, getXmlObject, selectPaint, selectPaint, selectPaint, selectPaint, selectPaint, selectProperty, setParent, setPlaceholder
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.poi.sl.usermodel.Shape
draw, getParent, getSheet
 
Methods inherited from interface org.apache.poi.sl.usermodel.PlaceableShape
getParent, getSheet
 

Constructor Detail

XSLFGroupShape

protected XSLFGroupShape(org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape shape,
                         XSLFSheet sheet)
Method Detail

getGrpSpPr

protected org.openxmlformats.schemas.drawingml.x2006.main.CTGroupShapeProperties getGrpSpPr()
Overrides:
getGrpSpPr in class XSLFShape

getSafeXfrm

protected org.openxmlformats.schemas.drawingml.x2006.main.CTGroupTransform2D getSafeXfrm()

getXfrm

protected org.openxmlformats.schemas.drawingml.x2006.main.CTGroupTransform2D getXfrm()

getAnchor

public java.awt.geom.Rectangle2D getAnchor()
Specified by:
getAnchor in interface PlaceableShape<XSLFShape,XSLFTextParagraph>
Specified by:
getAnchor in interface Shape<XSLFShape,XSLFTextParagraph>

setAnchor

public void setAnchor(java.awt.geom.Rectangle2D anchor)
Specified by:
setAnchor in interface PlaceableShape<XSLFShape,XSLFTextParagraph>

getInteriorAnchor

public java.awt.geom.Rectangle2D getInteriorAnchor()
Specified by:
getInteriorAnchor in interface GroupShape<XSLFShape,XSLFTextParagraph>
Returns:
the coordinates of the child extents rectangle used for calculations of grouping, scaling, and rotation behavior of shapes placed within a group.

setInteriorAnchor

public void setInteriorAnchor(java.awt.geom.Rectangle2D anchor)
Specified by:
setInteriorAnchor in interface GroupShape<XSLFShape,XSLFTextParagraph>
Parameters:
anchor - the coordinates of the child extents rectangle used for calculations of grouping, scaling, and rotation behavior of shapes placed within a group.

getShapes

public java.util.List<XSLFShape> getShapes()
Specified by:
getShapes in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
Returns:
child shapes contained within this group

iterator

public java.util.Iterator<XSLFShape> iterator()
Returns an iterator over the shapes in this sheet

Specified by:
iterator in interface java.lang.Iterable<XSLFShape>
Returns:
an iterator over the shapes in this sheet

removeShape

public boolean removeShape(XSLFShape xShape)
Remove the specified shape from this group

Specified by:
removeShape in interface ShapeContainer<XSLFShape,XSLFTextParagraph>

createAutoShape

public XSLFAutoShape createAutoShape()
Specified by:
createAutoShape in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
Specified by:
createAutoShape in interface XSLFShapeContainer

createFreeform

public XSLFFreeformShape createFreeform()
Specified by:
createFreeform in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
Specified by:
createFreeform in interface XSLFShapeContainer

createTextBox

public XSLFTextBox createTextBox()
Specified by:
createTextBox in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
Specified by:
createTextBox in interface XSLFShapeContainer

createConnector

public XSLFConnectorShape createConnector()
Specified by:
createConnector in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
Specified by:
createConnector in interface XSLFShapeContainer

createGroup

public XSLFGroupShape createGroup()
Specified by:
createGroup in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
Specified by:
createGroup in interface XSLFShapeContainer

createPicture

public XSLFPictureShape createPicture(PictureData pictureData)
Specified by:
createPicture in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
Specified by:
createPicture in interface XSLFShapeContainer

createTable

public XSLFTable createTable()

createTable

public XSLFTable createTable(int numRows,
                             int numCols)
Specified by:
createTable in interface ShapeContainer<XSLFShape,XSLFTextParagraph>

setFlipHorizontal

public void setFlipHorizontal(boolean flip)
Specified by:
setFlipHorizontal in interface PlaceableShape<XSLFShape,XSLFTextParagraph>

setFlipVertical

public void setFlipVertical(boolean flip)
Specified by:
setFlipVertical in interface PlaceableShape<XSLFShape,XSLFTextParagraph>

getFlipHorizontal

public boolean getFlipHorizontal()
Specified by:
getFlipHorizontal in interface PlaceableShape<XSLFShape,XSLFTextParagraph>

getFlipVertical

public boolean getFlipVertical()
Specified by:
getFlipVertical in interface PlaceableShape<XSLFShape,XSLFTextParagraph>

setRotation

public void setRotation(double theta)
Specified by:
setRotation in interface PlaceableShape<XSLFShape,XSLFTextParagraph>

getRotation

public double getRotation()
Specified by:
getRotation in interface PlaceableShape<XSLFShape,XSLFTextParagraph>

clear

public void clear()
Removes all of the elements from this container (optional operation). The container will be empty after this call returns.

Specified by:
clear in interface XSLFShapeContainer

addShape

public void addShape(XSLFShape shape)
Specified by:
addShape in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD