org.apache.poi.xssf.usermodel
Class XSSFShape

java.lang.Object
  extended by org.apache.poi.xssf.usermodel.XSSFShape
All Implemented Interfaces:
Shape
Direct Known Subclasses:
XSSFConnector, XSSFGraphicFrame, XSSFPicture, XSSFShapeGroup, XSSFSimpleShape

public abstract class XSSFShape
extends java.lang.Object
implements Shape

Represents a shape in a SpreadsheetML drawing.


Field Summary
protected  XSSFAnchor anchor
          anchor that is used by this shape
protected  XSSFDrawing drawing
          Parent drawing
static int EMU_PER_PIXEL
          Deprecated. POI 3.17 beta 1
static int EMU_PER_POINT
          Deprecated. POI 3.17 beta 1
protected  XSSFShapeGroup parent
          The parent shape, always not-null for shapes in groups
static int PIXEL_DPI
          Deprecated. POI 3.17 beta 1
static int POINT_DPI
          Deprecated. POI 3.17 beta 1
 
Constructor Summary
XSSFShape()
           
 
Method Summary
 XSSFAnchor getAnchor()
           
 XSSFDrawing getDrawing()
          Return the drawing that owns this shape
 XSSFShapeGroup getParent()
           
protected abstract  org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties getShapeProperties()
          Returns xml bean with shape properties.
 boolean isNoFill()
           
 void setFillColor(int red, int green, int blue)
           
 void setLineStyle(int lineStyle)
          Sets the line style.
 void setLineStyleColor(int red, int green, int blue)
           
 void setLineWidth(double lineWidth)
          Specifies the width to be used for the underline stroke.
 void setNoFill(boolean noFill)
           
 
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.ss.usermodel.Shape
getShapeName
 

Field Detail

EMU_PER_PIXEL

@Removal(version="3.19")
public static final int EMU_PER_PIXEL
Deprecated. POI 3.17 beta 1
See Also:
Units.EMU_PER_PIXEL, Constant Field Values

EMU_PER_POINT

@Removal(version="3.19")
public static final int EMU_PER_POINT
Deprecated. POI 3.17 beta 1
See Also:
Units.EMU_PER_POINT, Constant Field Values

POINT_DPI

@Removal(version="3.19")
public static final int POINT_DPI
Deprecated. POI 3.17 beta 1
See Also:
Units.POINT_DPI, Constant Field Values

PIXEL_DPI

@Removal(version="3.19")
public static final int PIXEL_DPI
Deprecated. POI 3.17 beta 1
See Also:
Units.PIXEL_DPI, Constant Field Values

drawing

protected XSSFDrawing drawing
Parent drawing


parent

protected XSSFShapeGroup parent
The parent shape, always not-null for shapes in groups


anchor

protected XSSFAnchor anchor
anchor that is used by this shape

Constructor Detail

XSSFShape

public XSSFShape()
Method Detail

getDrawing

public XSSFDrawing getDrawing()
Return the drawing that owns this shape

Returns:
the parent drawing that owns this shape

getParent

public XSSFShapeGroup getParent()
Specified by:
getParent in interface Shape

getAnchor

public XSSFAnchor getAnchor()
Specified by:
getAnchor in interface Shape
Returns:
the anchor that is used by this shape.

getShapeProperties

protected abstract org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties getShapeProperties()
Returns xml bean with shape properties.

Returns:
xml bean with shape properties.

isNoFill

public boolean isNoFill()
Specified by:
isNoFill in interface Shape

setNoFill

public void setNoFill(boolean noFill)
Specified by:
setNoFill in interface Shape

setFillColor

public void setFillColor(int red,
                         int green,
                         int blue)
Specified by:
setFillColor in interface Shape

setLineStyleColor

public void setLineStyleColor(int red,
                              int green,
                              int blue)
Specified by:
setLineStyleColor in interface Shape

setLineWidth

public void setLineWidth(double lineWidth)
Specifies the width to be used for the underline stroke.

Parameters:
lineWidth - width in points

setLineStyle

public void setLineStyle(int lineStyle)
Sets the line style.

Parameters:
lineStyle -