Package org.apache.poi.xslf.usermodel
Class XSLFTableCell
java.lang.Object
org.apache.poi.xslf.usermodel.XSLFShape
org.apache.poi.xslf.usermodel.XSLFSimpleShape
org.apache.poi.xslf.usermodel.XSLFTextShape
org.apache.poi.xslf.usermodel.XSLFTableCell
- All Implemented Interfaces:
Iterable<XSLFTextParagraph>,IAdjustableShape,PlaceableShape<XSLFShape,,XSLFTextParagraph> Shape<XSLFShape,,XSLFTextParagraph> SimpleShape<XSLFShape,,XSLFTextParagraph> TableCell<XSLFShape,,XSLFTextParagraph> TextShape<XSLFShape,,XSLFTextParagraph> TextContainer
Represents a cell of a table in a .pptx presentation
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.TableCell
TableCell.BorderEdgeNested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.TextShape
TextShape.TextAutofit, TextShape.TextDirection, TextShape.TextPlaceholder -
Method Summary
Modifier and TypeMethodDescriptionReturns the anchor (the bounding box rectangle) of this shape.Return line style of given edge ornullif border is not definedprotected org.openxmlformats.schemas.drawingml.x2006.main.CTTableCellPropertiesgetCellProperties(boolean create) Returns the solid color fill.intGet the number of columns to be spanned/mergedintGet the number of rows to be spanned/mergedprotected org.apache.xmlbeans.XmlObjectReturn the shape specific (visual) propertiesprotected org.openxmlformats.schemas.drawingml.x2006.main.CTTextBodygetTextBody(boolean create) Returns the type of vertical alignment for the text.protected org.openxmlformats.schemas.drawingml.x2006.main.CTTransform2DgetXfrm()Return a fake-xfrm which is used for calculating the text heightbooleanisMerged()Return if this cell is part of a merged cell.protected org.apache.poi.xslf.usermodel.XSLFTableCell.XSLFCellTextParagraphnewTextParagraph(org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraph p) Helper method to allow subclasses to provide their own text paragraphvoidRemove all line attributes of the given border edgevoidsetAnchor(Rectangle2D anchor) There's no real anchor for table cells - this method is used to temporarily store the location of the cell for a later retrieval, e.g.voidsetBorderCap(TableCell.BorderEdge edge, StrokeStyle.LineCap cap) voidsetBorderColor(TableCell.BorderEdge edge, Color color) Convenience method for setting the border color.voidsetBorderCompound(TableCell.BorderEdge edge, StrokeStyle.LineCompound compound) Convenience method for setting the border line compound.voidsetBorderDash(TableCell.BorderEdge edge, StrokeStyle.LineDash dash) Convenience method for setting the border line dash.voidsetBorderStyle(TableCell.BorderEdge edge, StrokeStyle style) Sets theStrokeStyleof the given border edge.voidsetBorderWidth(TableCell.BorderEdge edge, double width) Convenience method for setting the border width.voidsetBottomInset(double margin) Sets the bottom margin.voidsetFillColor(Color color) Specifies a solid color fill.voidsetLeftInset(double margin) Sets the left margin.voidsetRightInset(double margin) Sets the right margin.voidsetTextDirection(TextShape.TextDirection orientation) sets the vertical orientationvoidsetTopInset(double margin) Sets the top margin.voidSets the type of vertical alignment for the text.Methods inherited from class org.apache.poi.xslf.usermodel.XSLFTextShape
addNewTextParagraph, appendText, clearText, findDefinedParagraphProperty, findDefinedRunProperty, getBottomInset, getInsets, getLeftInset, getRightInset, getText, getTextAutofit, getTextBody, getTextBodyPr, getTextBodyPr, getTextHeight, getTextHeight, getTextParagraphs, getTextPlaceholder, getTextRotation, getTextType, getTopInset, getWordWrap, initTextBody, isHorizontalCentered, iterator, resizeToFitText, resizeToFitText, setHorizontalCentered, setInsets, setPlaceholder, setText, setTextAutofit, setTextPlaceholder, setTextRotation, setWordWrapMethods inherited from class org.apache.poi.xslf.usermodel.XSLFSimpleShape
createHyperlink, getAdjustValue, getFillStyle, getFlipHorizontal, getFlipVertical, getGeometry, getHyperlink, getLineCap, getLineColor, getLineCompound, getLineDash, getLineDecoration, getLineHeadDecoration, getLineHeadLength, getLineHeadWidth, getLinePaint, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getRotation, getShadow, getShapeType, getStrokeStyle, getXfrm, setFlipHorizontal, setFlipVertical, setLineCap, setLineColor, setLineCompound, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setRotation, setShapeType, setStrokeStyleMethods inherited from class org.apache.poi.xslf.usermodel.XSLFShape
draw, fetchShapeProperty, getBgPr, getBgRef, getChild, getCNvPr, getGrpSpPr, getParent, getPlaceholder, getPlaceholderDetails, getShapeId, getShapeName, getSheet, getSpStyle, getXmlObject, isPlaceholder, selectPaint, selectPaint, selectPaint, selectPaint, selectPaint, selectProperty, setParentMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.poi.sl.draw.geom.IAdjustableShape
getAdjustValueMethods inherited from interface java.lang.Iterable
forEach, iterator, spliteratorMethods inherited from interface org.apache.poi.sl.usermodel.PlaceableShape
getFlipHorizontal, getFlipVertical, getParent, getRotation, getSheet, setFlipHorizontal, setFlipVertical, setRotationMethods inherited from interface org.apache.poi.sl.usermodel.Shape
draw, getParent, getShapeId, getShapeName, getSheetMethods inherited from interface org.apache.poi.sl.usermodel.SimpleShape
createHyperlink, getFillStyle, getGeometry, getHyperlink, getLineDecoration, getPlaceholder, getPlaceholderDetails, getShadow, getShapeType, getStrokeStyle, isPlaceholder, setPlaceholder, setShapeType, setStrokeStyleMethods inherited from interface org.apache.poi.sl.usermodel.TextShape
appendText, getInsets, getText, getTextHeight, getTextHeight, getTextParagraphs, getTextPlaceholder, getTextRotation, getWordWrap, isHorizontalCentered, resizeToFitText, resizeToFitText, setHorizontalCentered, setInsets, setText, setTextPlaceholder, setTextRotation, setWordWrap
-
Method Details
-
getTextBody
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTextBody getTextBody(boolean create) - Specified by:
getTextBodyin classXSLFTextShape
-
getCellProperties
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTableCellProperties getCellProperties(boolean create) -
setLeftInset
public void setLeftInset(double margin) Description copied from class:XSLFTextShapeSets the left margin.- Overrides:
setLeftInsetin classXSLFTextShape- Parameters:
margin- the left margin- See Also:
-
setRightInset
public void setRightInset(double margin) Description copied from class:XSLFTextShapeSets the right margin.- Overrides:
setRightInsetin classXSLFTextShape- Parameters:
margin- the right margin- See Also:
-
setTopInset
public void setTopInset(double margin) Description copied from class:XSLFTextShapeSets the top margin.- Overrides:
setTopInsetin classXSLFTextShape- Parameters:
margin- the top margin- See Also:
-
setBottomInset
public void setBottomInset(double margin) Description copied from class:XSLFTextShapeSets the bottom margin.- Overrides:
setBottomInsetin classXSLFTextShape- Parameters:
margin- the bottom margin- See Also:
-
removeBorder
Description copied from interface:TableCellRemove all line attributes of the given border edge- Specified by:
removeBorderin interfaceTableCell<XSLFShape,XSLFTextParagraph> - Parameters:
edge- the border edge to be cleared
-
getBorderStyle
Description copied from interface:TableCellReturn line style of given edge ornullif border is not defined- Specified by:
getBorderStylein interfaceTableCell<XSLFShape,XSLFTextParagraph> - Parameters:
edge- the border edge- Returns:
- line style of given edge or
nullif border is not defined
-
setBorderStyle
Description copied from interface:TableCellSets theStrokeStyleof the given border edge. Anullproperty of the style is ignored.- Specified by:
setBorderStylein interfaceTableCell<XSLFShape,XSLFTextParagraph> - Parameters:
edge- border edgestyle- the new stroke style
-
getBorderWidth
-
setBorderWidth
Description copied from interface:TableCellConvenience method for setting the border width.- Specified by:
setBorderWidthin interfaceTableCell<XSLFShape,XSLFTextParagraph> - Parameters:
edge- border edgewidth- the new border width
-
setBorderColor
Description copied from interface:TableCellConvenience method for setting the border color.- Specified by:
setBorderColorin interfaceTableCell<XSLFShape,XSLFTextParagraph> - Parameters:
edge- border edgecolor- the new border color
-
getBorderColor
-
getBorderCompound
-
setBorderCompound
Description copied from interface:TableCellConvenience method for setting the border line compound.- Specified by:
setBorderCompoundin interfaceTableCell<XSLFShape,XSLFTextParagraph> - Parameters:
edge- border edgecompound- the new border line compound
-
getBorderDash
-
setBorderDash
Description copied from interface:TableCellConvenience method for setting the border line dash.- Specified by:
setBorderDashin interfaceTableCell<XSLFShape,XSLFTextParagraph> - Parameters:
edge- border edgedash- the new border line dash
-
getBorderCap
-
setBorderCap
-
setFillColor
Specifies a solid color fill. The shape is filled entirely with the specified color.- Specified by:
setFillColorin interfaceSimpleShape<XSLFShape,XSLFTextParagraph> - Overrides:
setFillColorin classXSLFSimpleShape- Parameters:
color- the solid color fill. The value ofnullunsets the solidFIll attribute from the underlying xml
-
getFillColor
Description copied from interface:SimpleShapeReturns the solid color fill.- Specified by:
getFillColorin interfaceSimpleShape<XSLFShape,XSLFTextParagraph> - Overrides:
getFillColorin classXSLFSimpleShape- Returns:
- solid fill color of null if not set
-
getFillPaint
- Overrides:
getFillPaintin classXSLFShape
-
getGridSpan
public int getGridSpan()Description copied from interface:TableCellGet the number of columns to be spanned/merged- Specified by:
getGridSpanin interfaceTableCell<XSLFShape,XSLFTextParagraph> - Returns:
- the grid span
-
getRowSpan
public int getRowSpan()Description copied from interface:TableCellGet the number of rows to be spanned/merged- Specified by:
getRowSpanin interfaceTableCell<XSLFShape,XSLFTextParagraph> - Returns:
- the row span
-
setVerticalAlignment
Description copied from interface:TextShapeSets the type of vertical alignment for the text.- Specified by:
setVerticalAlignmentin interfaceTextShape<XSLFShape,XSLFTextParagraph> - Overrides:
setVerticalAlignmentin classXSLFTextShape- Parameters:
anchor- - the type of alignment. Anullvalues unsets this property.
-
getVerticalAlignment
Description copied from interface:TextShapeReturns the type of vertical alignment for the text.- Specified by:
getVerticalAlignmentin interfaceTextShape<XSLFShape,XSLFTextParagraph> - Overrides:
getVerticalAlignmentin classXSLFTextShape- Returns:
- the type of vertical alignment
-
setTextDirection
Description copied from interface:TextShapesets the vertical orientation- Specified by:
setTextDirectionin interfaceTextShape<XSLFShape,XSLFTextParagraph> - Overrides:
setTextDirectionin classXSLFTextShape- Parameters:
orientation- vertical orientation of the text- Since:
- POI 3.15-beta2
-
getTextDirection
- Specified by:
getTextDirectionin interfaceTextShape<XSLFShape,XSLFTextParagraph> - Overrides:
getTextDirectionin classXSLFTextShape- Returns:
- vertical orientation of the text
- Since:
- POI 3.15-beta2
-
getXfrm
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTransform2D getXfrm()Return a fake-xfrm which is used for calculating the text height -
setAnchor
There's no real anchor for table cells - this method is used to temporarily store the location of the cell for a later retrieval, e.g. for rendering- Specified by:
setAnchorin interfacePlaceableShape<XSLFShape,XSLFTextParagraph> - Overrides:
setAnchorin classXSLFSimpleShape- Parameters:
anchor- the position of this shape within the drawing canvas. The coordinates are expressed in points- Since:
- POI 3.15-beta2
-
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> - Overrides:
getAnchorin classXSLFSimpleShape- Returns:
- the anchor of this shape
- Since:
- POI 3.15-beta2
-
isMerged
public boolean isMerged()Description copied from interface:TableCellReturn if this cell is part of a merged cell. The top/left cell of a merged region is not regarded as merged - its grid and/or row span is greater than one.- Specified by:
isMergedin interfaceTableCell<XSLFShape,XSLFTextParagraph> - Returns:
- true if this a merged cell
- Since:
- POI 3.15-beta2
-
newTextParagraph
protected org.apache.poi.xslf.usermodel.XSLFTableCell.XSLFCellTextParagraph newTextParagraph(org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraph p) Description copied from class:XSLFTextShapeHelper method to allow subclasses to provide their own text paragraph- Overrides:
newTextParagraphin classXSLFTextShape- Parameters:
p- the xml reference- Returns:
- a new text paragraph
- Since:
- POI 3.15-beta2
-
getShapeProperties
protected org.apache.xmlbeans.XmlObject getShapeProperties()Description copied from class:XSLFShapeReturn the shape specific (visual) properties- Overrides:
getShapePropertiesin classXSLFShape- Returns:
- the shape specific properties
-