Package loci.poi.hssf.usermodel
Class HSSFTextbox
java.lang.Object
loci.poi.hssf.usermodel.HSSFShape
loci.poi.hssf.usermodel.HSSFSimpleShape
loci.poi.hssf.usermodel.HSSFTextbox
- Direct Known Subclasses:
HSSFComment
A textbox is a shape that may hold a rich text string.
- Author:
- Glen Stampoultzis (glens at apache.org)
-
Field Summary
FieldsFields inherited from class loci.poi.hssf.usermodel.HSSFSimpleShape
OBJECT_TYPE_COMMENT, OBJECT_TYPE_LINE, OBJECT_TYPE_OVAL, OBJECT_TYPE_PICTURE, OBJECT_TYPE_RECTANGLEFields inherited from class loci.poi.hssf.usermodel.HSSFShape
LINESTYLE_DASHDOTDOTSYS, LINESTYLE_DASHDOTGEL, LINESTYLE_DASHDOTSYS, LINESTYLE_DASHGEL, LINESTYLE_DASHSYS, LINESTYLE_DOTGEL, LINESTYLE_DOTSYS, LINESTYLE_LONGDASHDOTDOTGEL, LINESTYLE_LONGDASHDOTGEL, LINESTYLE_LONGDASHGEL, LINESTYLE_NONE, LINESTYLE_SOLID, LINEWIDTH_DEFAULT, LINEWIDTH_ONE_PT -
Constructor Summary
ConstructorsConstructorDescriptionHSSFTextbox(HSSFShape parent, HSSFAnchor anchor) Construct a new textbox with the given parent and anchor. -
Method Summary
Modifier and TypeMethodDescriptionintGets the bottom margin within the textbox.intintintvoidsetMarginBottom(int marginBottom) Sets the bottom margin within the textbox.voidsetMarginLeft(int marginLeft) Sets the left margin within the textbox.voidsetMarginRight(int marginRight) Sets the right margin within the textbox.voidsetMarginTop(int marginTop) Sets the top margin within the textbox.voidsetString(HSSFRichTextString string) Methods inherited from class loci.poi.hssf.usermodel.HSSFSimpleShape
getShapeType, setShapeTypeMethods inherited from class loci.poi.hssf.usermodel.HSSFShape
countOfAllChildren, getAnchor, getFillColor, getLineStyle, getLineStyleColor, getLineWidth, getParent, isNoFill, setAnchor, setFillColor, setFillColor, setLineStyle, setLineStyleColor, setLineStyleColor, setLineWidth, setNoFill
-
Field Details
-
OBJECT_TYPE_TEXT
public static final short OBJECT_TYPE_TEXT- See Also:
-
-
Constructor Details
-
HSSFTextbox
Construct a new textbox with the given parent and anchor.- Parameters:
parent-anchor- One of HSSFClientAnchor or HSSFChildAnchor
-
-
Method Details
-
getString
- Returns:
- the rich text string for this textbox.
-
setString
- Parameters:
string- Sets the rich text string used by this object.
-
getMarginLeft
public int getMarginLeft()- Returns:
- Returns the left margin within the textbox.
-
setMarginLeft
public void setMarginLeft(int marginLeft) Sets the left margin within the textbox. -
getMarginRight
public int getMarginRight()- Returns:
- returns the right margin within the textbox.
-
setMarginRight
public void setMarginRight(int marginRight) Sets the right margin within the textbox. -
getMarginTop
public int getMarginTop()- Returns:
- returns the top margin within the textbox.
-
setMarginTop
public void setMarginTop(int marginTop) Sets the top margin within the textbox. -
getMarginBottom
public int getMarginBottom()Gets the bottom margin within the textbox. -
setMarginBottom
public void setMarginBottom(int marginBottom) Sets the bottom margin within the textbox.
-