FileDocCategorySizeDatePackage
HSSFTextbox.javaAPI DocApache Poi 3.0.13244Mon Jan 01 12:39:36 GMT 2007org.apache.poi.hssf.usermodel

HSSFTextbox

public class HSSFTextbox extends HSSFSimpleShape
A textbox is a shape that may hold a rich text string.
author
Glen Stampoultzis (glens at apache.org)

Fields Summary
public static final short
OBJECT_TYPE_TEXT
int
marginLeft
int
marginRight
int
marginTop
int
marginBottom
HSSFRichTextString
string
Constructors Summary
public HSSFTextbox(HSSFShape parent, HSSFAnchor anchor)
Construct a new textbox with the given parent and anchor.

param
parent
param
anchor One of HSSFClientAnchor or HSSFChildAnchor


                             
          
    
        super( parent, anchor );
        setShapeType(OBJECT_TYPE_TEXT);
    
Methods Summary
public intgetMarginBottom()
Gets the bottom margin within the textbox.

        return marginBottom;
    
public intgetMarginLeft()

return
Returns the left margin within the textbox.

        return marginLeft;
    
public intgetMarginRight()

return
returns the right margin within the textbox.

        return marginRight;
    
public intgetMarginTop()

return
returns the top margin within the textbox.

        return marginTop;
    
public org.apache.poi.hssf.usermodel.HSSFRichTextStringgetString()

return
the rich text string for this textbox.

        return string;
    
public voidsetMarginBottom(int marginBottom)
Sets the bottom margin within the textbox.

        this.marginBottom = marginBottom;
    
public voidsetMarginLeft(int marginLeft)
Sets the left margin within the textbox.

        this.marginLeft = marginLeft;
    
public voidsetMarginRight(int marginRight)
Sets the right margin within the textbox.

        this.marginRight = marginRight;
    
public voidsetMarginTop(int marginTop)
Sets the top margin within the textbox.

        this.marginTop = marginTop;
    
public voidsetString(org.apache.poi.hssf.usermodel.HSSFRichTextString string)

param
string Sets the rich text string used by this object.

        this.string = string;