org.apache.poi.xslf.usermodel
Class XSLFBackground

java.lang.Object
  extended by org.apache.poi.xslf.usermodel.XSLFShape
      extended by org.apache.poi.xslf.usermodel.XSLFSimpleShape
          extended by org.apache.poi.xslf.usermodel.XSLFBackground
All Implemented Interfaces:
IAdjustableShape, Background<XSLFShape,XSLFTextParagraph>, PlaceableShape<XSLFShape,XSLFTextParagraph>, Shape<XSLFShape,XSLFTextParagraph>, SimpleShape<XSLFShape,XSLFTextParagraph>

public class XSLFBackground
extends XSLFSimpleShape
implements Background<XSLFShape,XSLFTextParagraph>

Background shape

Author:
Yegor Kozlov

Method Summary
 java.awt.geom.Rectangle2D getAnchor()
          Returns the anchor (the bounding box rectangle) of this shape.
 java.awt.Color getFillColor()
          Returns the solid color fill.
protected  org.openxmlformats.schemas.drawingml.x2006.main.CTTransform2D getXfrm()
          background does not have a associated transform.
 void setPlaceholder(Placeholder placeholder)
          Specifies that the corresponding shape should be represented by the generating application as a placeholder.
 
Methods 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, getSafeXfrm, getShadow, getShapeType, getStrokeStyle, isPlaceholder, setAnchor, setFillColor, setFlipHorizontal, setFlipVertical, setLineCap, setLineColor, setLineCompound, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setRotation, setShapeType, setStrokeStyle
 
Methods inherited from class org.apache.poi.xslf.usermodel.XSLFShape
draw, fetchShapeProperty, getBgPr, getBgRef, getCNvPr, getCTPlaceholder, getFillPaint, getGrpSpPr, getPaint, getParent, getPlaceholder, getShapeId, getShapeName, getSheet, getSpPr, getSpStyle, getXmlObject, selectPaint, selectPaint, selectPaint, selectPaint, selectPaint, selectProperty, setParent
 
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.Background
getFillStyle
 
Methods inherited from interface org.apache.poi.sl.usermodel.Shape
draw, getParent, getSheet
 
Methods inherited from interface org.apache.poi.sl.usermodel.SimpleShape
getPlaceholder
 
Methods inherited from interface org.apache.poi.sl.usermodel.PlaceableShape
getParent, getSheet
 

Method Detail

getAnchor

public java.awt.geom.Rectangle2D getAnchor()
Description copied from interface: Shape
Returns the anchor (the bounding box rectangle) of this shape. All coordinates are expressed in points (72 dpi).

Specified by:
getAnchor in interface PlaceableShape<XSLFShape,XSLFTextParagraph>
Specified by:
getAnchor in interface Shape<XSLFShape,XSLFTextParagraph>
Overrides:
getAnchor in class XSLFSimpleShape
Returns:
the anchor of this shape

getFillColor

public java.awt.Color getFillColor()
Description copied from interface: SimpleShape
Returns the solid color fill.

Specified by:
getFillColor in interface SimpleShape<XSLFShape,XSLFTextParagraph>
Overrides:
getFillColor in class XSLFSimpleShape
Returns:
solid fill color of null if not set or fill color is not solid (pattern or gradient)

getXfrm

protected org.openxmlformats.schemas.drawingml.x2006.main.CTTransform2D getXfrm()
background does not have a associated transform. we return a dummy transform object to prevent exceptions in inherited methods.

Overrides:
getXfrm in class XSLFSimpleShape
Returns:
dummy CTTransform2D bean

setPlaceholder

public void setPlaceholder(Placeholder placeholder)
Description copied from class: XSLFShape
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

Specified by:
setPlaceholder in interface SimpleShape<XSLFShape,XSLFTextParagraph>
Overrides:
setPlaceholder in class XSLFSimpleShape
Parameters:
placeholder - the placeholder or null to remove the reference to the placeholder


Copyright 2016 The Apache Software Foundation or its licensors, as applicable.