Package org.apache.poi.xslf.usermodel
Class XSLFGroupShape
java.lang.Object
org.apache.poi.xslf.usermodel.XSLFShape
org.apache.poi.xslf.usermodel.XSLFGroupShape
- All Implemented Interfaces:
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.
- Author:
- Yegor Kozlov
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedXSLFGroupShape(org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape shape, XSLFSheet sheet) -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidclear()Removes all of the elements from this container (optional operation).create a new shape with a predefined geometry and add it to this shape containercreate a connectorcreate a new shape with a custom geometrycreate a group of shapes belonging to this containercreateOleShape(PictureData pictureData) Create a new OLE object shape with the given pictureData as preview imagecreatePicture(PictureData pictureData) create a picture belonging to this containercreateTable(int numRows, int numCols) Create a new Table of the given number of rows and columnscreate a text boxReturns the anchor (the bounding box rectangle) of this shape.booleanWhether the shape is horizontally flippedbooleanWhether the shape is vertically flippedprotected org.openxmlformats.schemas.drawingml.x2006.main.CTGroupShapePropertiesGets the coordinate space of this group.doubleRotation angle in degreesReturns an list containing all of the elements in this container in proper sequence (from first to last element).protected org.openxmlformats.schemas.drawingml.x2006.main.CTGroupTransform2DgetXfrm()iterator()Returns an iterator over the shapes in this sheetbooleanremoveShape(XSLFShape xShape) Remove the specified shape from this groupvoidsetAnchor(Rectangle2D anchor) voidsetFlipHorizontal(boolean flip) voidsetFlipVertical(boolean flip) Whether the shape is vertically flippedvoidsetInteriorAnchor(Rectangle2D anchor) Sets the coordinate space of this group.voidsetRotation(double theta) Rotate this shape.Methods inherited from class org.apache.poi.xslf.usermodel.XSLFShape
draw, fetchShapeProperty, getBgPr, getBgRef, getChild, getCNvPr, getFillPaint, getParent, getPlaceholder, getPlaceholderDetails, getShapeId, getShapeName, getShapeProperties, getSheet, getSpStyle, getXmlObject, isPlaceholder, selectPaint, selectPaint, selectPaint, selectPaint, selectPaint, selectProperty, setParent, setPlaceholderMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.apache.poi.sl.usermodel.PlaceableShape
getParent, getSheetMethods inherited from interface org.apache.poi.sl.usermodel.Shape
draw, getParent, getShapeId, getShapeName, getSheet
-
Constructor Details
-
XSLFGroupShape
protected XSLFGroupShape(org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape shape, XSLFSheet sheet)
-
-
Method Details
-
getGrpSpPr
protected org.openxmlformats.schemas.drawingml.x2006.main.CTGroupShapeProperties getGrpSpPr()- Overrides:
getGrpSpPrin classXSLFShape
-
getXfrm
protected org.openxmlformats.schemas.drawingml.x2006.main.CTGroupTransform2D getXfrm() -
getAnchor
Description copied from interface:ShapeReturns the anchor (the bounding box rectangle) of this shape. All coordinates are expressed in points (72 dpi).- Specified by:
getAnchorin interfacePlaceableShape<XSLFShape,XSLFTextParagraph> - Specified by:
getAnchorin interfaceShape<XSLFShape,XSLFTextParagraph> - Returns:
- the anchor of this shape
-
setAnchor
- Specified by:
setAnchorin interfacePlaceableShape<XSLFShape,XSLFTextParagraph> - Parameters:
anchor- the position of this shape within the drawing canvas. The coordinates are expressed in points
-
getInteriorAnchor
Description copied from interface:GroupShapeGets the coordinate space of this group. All children are constrained to these coordinates.- Specified by:
getInteriorAnchorin interfaceGroupShape<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
Description copied from interface:GroupShapeSets the coordinate space of this group. All children are constrained to these coordinates.- Specified by:
setInteriorAnchorin interfaceGroupShape<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
Description copied from interface:ShapeContainerReturns an list containing all of the elements in this container in proper sequence (from first to last element).- Specified by:
getShapesin interfaceShapeContainer<XSLFShape,XSLFTextParagraph> - Returns:
- child shapes contained within this group
-
iterator
Returns an iterator over the shapes in this sheet -
removeShape
Remove the specified shape from this group- Specified by:
removeShapein interfaceShapeContainer<XSLFShape,XSLFTextParagraph> - Parameters:
xShape- the shape to be removed from this sheet, if present- Returns:
- true if this sheet contained the specified element
-
createAutoShape
Description copied from interface:ShapeContainercreate a new shape with a predefined geometry and add it to this shape container- Specified by:
createAutoShapein interfaceShapeContainer<XSLFShape,XSLFTextParagraph> - Specified by:
createAutoShapein interfaceXSLFShapeContainer
-
createFreeform
Description copied from interface:ShapeContainercreate a new shape with a custom geometry- Specified by:
createFreeformin interfaceShapeContainer<XSLFShape,XSLFTextParagraph> - Specified by:
createFreeformin interfaceXSLFShapeContainer
-
createTextBox
Description copied from interface:ShapeContainercreate a text box- Specified by:
createTextBoxin interfaceShapeContainer<XSLFShape,XSLFTextParagraph> - Specified by:
createTextBoxin interfaceXSLFShapeContainer
-
createConnector
Description copied from interface:ShapeContainercreate a connector- Specified by:
createConnectorin interfaceShapeContainer<XSLFShape,XSLFTextParagraph> - Specified by:
createConnectorin interfaceXSLFShapeContainer
-
createGroup
Description copied from interface:ShapeContainercreate a group of shapes belonging to this container- Specified by:
createGroupin interfaceShapeContainer<XSLFShape,XSLFTextParagraph> - Specified by:
createGroupin interfaceXSLFShapeContainer
-
createPicture
Description copied from interface:ShapeContainercreate a picture belonging to this container- Specified by:
createPicturein interfaceShapeContainer<XSLFShape,XSLFTextParagraph> - Specified by:
createPicturein interfaceXSLFShapeContainer
-
createOleShape
Description copied from interface:ShapeContainerCreate a new OLE object shape with the given pictureData as preview image- Specified by:
createOleShapein interfaceShapeContainer<XSLFShape,XSLFTextParagraph> - Parameters:
pictureData- the preview image
-
createTable
-
createTable
Description copied from interface:ShapeContainerCreate a new Table of the given number of rows and columns- Specified by:
createTablein interfaceShapeContainer<XSLFShape,XSLFTextParagraph> - Parameters:
numRows- the number of rowsnumCols- the number of columns
-
setFlipHorizontal
public void setFlipHorizontal(boolean flip) - Specified by:
setFlipHorizontalin interfacePlaceableShape<XSLFShape,XSLFTextParagraph> - Parameters:
flip- whether the shape is horizontally flipped
-
setFlipVertical
public void setFlipVertical(boolean flip) Description copied from interface:PlaceableShapeWhether the shape is vertically flipped- Specified by:
setFlipVerticalin interfacePlaceableShape<XSLFShape,XSLFTextParagraph> - Parameters:
flip- whether the shape is vertically flipped
-
getFlipHorizontal
public boolean getFlipHorizontal()Description copied from interface:PlaceableShapeWhether the shape is horizontally flipped- Specified by:
getFlipHorizontalin interfacePlaceableShape<XSLFShape,XSLFTextParagraph> - Returns:
- whether the shape is horizontally flipped
-
getFlipVertical
public boolean getFlipVertical()Description copied from interface:PlaceableShapeWhether the shape is vertically flipped- Specified by:
getFlipVerticalin interfacePlaceableShape<XSLFShape,XSLFTextParagraph> - Returns:
- whether the shape is vertically flipped
-
setRotation
public void setRotation(double theta) Description copied from interface:PlaceableShapeRotate this shape.Positive angles are clockwise (i.e., towards the positive y axis); negative angles are counter-clockwise (i.e., towards the negative y axis).
- Specified by:
setRotationin interfacePlaceableShape<XSLFShape,XSLFTextParagraph> - Parameters:
theta- the rotation angle in degrees.
-
getRotation
public double getRotation()Description copied from interface:PlaceableShapeRotation angle in degreesPositive angles are clockwise (i.e., towards the positive y axis); negative angles are counter-clockwise (i.e., towards the negative y axis).
- Specified by:
getRotationin interfacePlaceableShape<XSLFShape,XSLFTextParagraph> - Returns:
- rotation angle in degrees
-
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:
clearin interfaceXSLFShapeContainer
-
addShape
- Specified by:
addShapein interfaceShapeContainer<XSLFShape,XSLFTextParagraph>
-