Package loci.poi.hssf.usermodel
Class HSSFShape
java.lang.Object
loci.poi.hssf.usermodel.HSSFShape
- Direct Known Subclasses:
HSSFPolygon,HSSFShapeGroup,HSSFSimpleShape
An abstract shape.
- Author:
- Glen Stampoultzis (glens at apache.org)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final int -
Method Summary
Modifier and TypeMethodDescriptionintCount of all children and their childrens children.intThe color used to fill this shape.intintThe color applied to the lines of this shape.intGets the parent shape.booleanisNoFill()voidsetAnchor(HSSFAnchor anchor) Sets a particular anchor.voidsetFillColor(int fillColor) The color used to fill this shape.voidsetFillColor(int red, int green, int blue) The color used to fill this shape.voidsetLineStyle(int lineStyle) Sets the line style.voidsetLineStyleColor(int lineStyleColor) The color applied to the lines of this shape.voidsetLineStyleColor(int red, int green, int blue) The color applied to the lines of this shape.voidsetLineWidth(int lineWidth) Sets the width of the line.voidsetNoFill(boolean noFill) Sets whether this shape is filled or transparent.
-
Field Details
-
LINEWIDTH_ONE_PT
public static final int LINEWIDTH_ONE_PT- See Also:
-
LINEWIDTH_DEFAULT
public static final int LINEWIDTH_DEFAULT- See Also:
-
LINESTYLE_SOLID
public static final int LINESTYLE_SOLID- See Also:
-
LINESTYLE_DASHSYS
public static final int LINESTYLE_DASHSYS- See Also:
-
LINESTYLE_DOTSYS
public static final int LINESTYLE_DOTSYS- See Also:
-
LINESTYLE_DASHDOTSYS
public static final int LINESTYLE_DASHDOTSYS- See Also:
-
LINESTYLE_DASHDOTDOTSYS
public static final int LINESTYLE_DASHDOTDOTSYS- See Also:
-
LINESTYLE_DOTGEL
public static final int LINESTYLE_DOTGEL- See Also:
-
LINESTYLE_DASHGEL
public static final int LINESTYLE_DASHGEL- See Also:
-
LINESTYLE_LONGDASHGEL
public static final int LINESTYLE_LONGDASHGEL- See Also:
-
LINESTYLE_DASHDOTGEL
public static final int LINESTYLE_DASHDOTGEL- See Also:
-
LINESTYLE_LONGDASHDOTGEL
public static final int LINESTYLE_LONGDASHDOTGEL- See Also:
-
LINESTYLE_LONGDASHDOTDOTGEL
public static final int LINESTYLE_LONGDASHDOTDOTGEL- See Also:
-
LINESTYLE_NONE
public static final int LINESTYLE_NONE- See Also:
-
-
Method Details
-
getParent
Gets the parent shape. -
getAnchor
- Returns:
- the anchor that is used by this shape.
-
setAnchor
Sets a particular anchor. A top-level shape must have an anchor of HSSFClientAnchor. A child anchor must have an anchor of HSSFChildAnchor- Parameters:
anchor- the anchor to use.- Throws:
IllegalArgumentException- when the wrong anchor is used for this particular shape.- See Also:
-
getLineStyleColor
public int getLineStyleColor()The color applied to the lines of this shape. -
setLineStyleColor
public void setLineStyleColor(int lineStyleColor) The color applied to the lines of this shape. -
setLineStyleColor
public void setLineStyleColor(int red, int green, int blue) The color applied to the lines of this shape. -
getFillColor
public int getFillColor()The color used to fill this shape. -
setFillColor
public void setFillColor(int fillColor) The color used to fill this shape. -
setFillColor
public void setFillColor(int red, int green, int blue) The color used to fill this shape. -
getLineWidth
public int getLineWidth()- Returns:
- returns with width of the line in EMUs. 12700 = 1 pt.
-
setLineWidth
public void setLineWidth(int lineWidth) Sets the width of the line. 12700 = 1 pt.- Parameters:
lineWidth- width in EMU's. 12700EMU's = 1 pt- See Also:
-
getLineStyle
public int getLineStyle()- Returns:
- One of the constants in LINESTYLE_*
-
setLineStyle
public void setLineStyle(int lineStyle) Sets the line style.- Parameters:
lineStyle- One of the constants in LINESTYLE_*
-
isNoFill
public boolean isNoFill()- Returns:
- true if this shape is not filled with a color.
-
setNoFill
public void setNoFill(boolean noFill) Sets whether this shape is filled or transparent. -
countOfAllChildren
public int countOfAllChildren()Count of all children and their childrens children.
-