|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.usermodel.HSSFShape
org.apache.poi.hssf.usermodel.HSSFSimpleShape
org.apache.poi.hssf.usermodel.HSSFTextbox
public class HSSFTextbox
A textbox is a shape that may hold a rich text string.
Field Summary | |
---|---|
static short |
HORIZONTAL_ALIGNMENT_CENTERED
|
static short |
HORIZONTAL_ALIGNMENT_DISTRIBUTED
|
static short |
HORIZONTAL_ALIGNMENT_JUSTIFIED
|
static short |
HORIZONTAL_ALIGNMENT_LEFT
How to align text horizontally |
static short |
HORIZONTAL_ALIGNMENT_RIGHT
|
static short |
OBJECT_TYPE_TEXT
|
static short |
VERTICAL_ALIGNMENT_BOTTOM
|
static short |
VERTICAL_ALIGNMENT_CENTER
|
static short |
VERTICAL_ALIGNMENT_DISTRIBUTED
|
static short |
VERTICAL_ALIGNMENT_JUSTIFY
|
static short |
VERTICAL_ALIGNMENT_TOP
How to align text vertically |
Fields inherited from class org.apache.poi.hssf.usermodel.HSSFSimpleShape |
---|
OBJECT_TYPE_COMBO_BOX, OBJECT_TYPE_COMMENT, OBJECT_TYPE_LINE, OBJECT_TYPE_OVAL, OBJECT_TYPE_PICTURE, OBJECT_TYPE_RECTANGLE |
Fields inherited from class org.apache.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 | |
---|---|
HSSFTextbox(HSSFShape parent,
HSSFAnchor anchor)
Construct a new textbox with the given parent and anchor. |
Method Summary | |
---|---|
java.lang.String |
getAuthor()
Name of the original comment author |
int |
getColumn()
Return the column of the cell that contains the comment |
short |
getHorizontalAlignment()
Gets the horizontal alignment. |
int |
getMarginBottom()
Gets the bottom margin within the textbox. |
int |
getMarginLeft()
|
int |
getMarginRight()
|
int |
getMarginTop()
|
int |
getRow()
Return the row of the cell that contains the comment |
RichTextString |
getString()
Fetches the rich text string of the comment |
short |
getVerticalAlignment()
Gets the vertical alignment. |
boolean |
isVisible()
Sets whether this comment is visible. |
void |
setAuthor(java.lang.String author)
Name of the original comment author |
void |
setColumn(int column)
Set the column of the cell that contains the comment |
void |
setHorizontalAlignment(short align)
Sets the horizontal alignment. |
void |
setMarginBottom(int marginBottom)
Sets the bottom margin within the textbox. |
void |
setMarginLeft(int marginLeft)
Sets the left margin within the textbox. |
void |
setMarginRight(int marginRight)
Sets the right margin within the textbox. |
void |
setMarginTop(int marginTop)
Sets the top margin within the textbox. |
void |
setRow(int row)
Set the row of the cell that contains the comment |
void |
setString(RichTextString string)
Sets the rich text string used by this comment. |
void |
setVerticalAlignment(short align)
Sets the vertical alignment. |
void |
setVisible(boolean visible)
Returns whether this comment is visible. |
Methods inherited from class org.apache.poi.hssf.usermodel.HSSFSimpleShape |
---|
getShapeType, setShapeType |
Methods inherited from class org.apache.poi.hssf.usermodel.HSSFShape |
---|
countOfAllChildren, getAnchor, getFillColor, getLineStyle, getLineStyleColor, getLineWidth, getParent, isNoFill, setAnchor, setFillColor, setFillColor, setLineStyle, setLineStyleColor, setLineStyleColor, setLineWidth, setNoFill |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final short OBJECT_TYPE_TEXT
public static final short HORIZONTAL_ALIGNMENT_LEFT
public static final short HORIZONTAL_ALIGNMENT_CENTERED
public static final short HORIZONTAL_ALIGNMENT_RIGHT
public static final short HORIZONTAL_ALIGNMENT_JUSTIFIED
public static final short HORIZONTAL_ALIGNMENT_DISTRIBUTED
public static final short VERTICAL_ALIGNMENT_TOP
public static final short VERTICAL_ALIGNMENT_CENTER
public static final short VERTICAL_ALIGNMENT_BOTTOM
public static final short VERTICAL_ALIGNMENT_JUSTIFY
public static final short VERTICAL_ALIGNMENT_DISTRIBUTED
Constructor Detail |
---|
public HSSFTextbox(HSSFShape parent, HSSFAnchor anchor)
parent
- anchor
- One of HSSFClientAnchor or HSSFChildAnchorMethod Detail |
---|
public RichTextString getString()
Comment
getString
in interface Comment
public void setString(RichTextString string)
Comment
setString
in interface Comment
string
- Sets the rich text string used by this object.public int getMarginLeft()
public void setMarginLeft(int marginLeft)
public int getMarginRight()
public void setMarginRight(int marginRight)
public int getMarginTop()
public void setMarginTop(int marginTop)
public int getMarginBottom()
public void setMarginBottom(int marginBottom)
public short getHorizontalAlignment()
public void setHorizontalAlignment(short align)
public short getVerticalAlignment()
public void setVerticalAlignment(short align)
public void setVisible(boolean visible)
Comment
setVisible
in interface Comment
visible
- true
if the comment is visible, false
otherwisepublic boolean isVisible()
Comment
isVisible
in interface Comment
true
if the comment is visible, false
otherwisepublic int getRow()
Comment
getRow
in interface Comment
public void setRow(int row)
Comment
setRow
in interface Comment
row
- the 0-based row of the cell that contains the commentpublic int getColumn()
Comment
getColumn
in interface Comment
public void setColumn(int column)
Comment
setColumn
in interface Comment
column
- the 0-based column of the cell that contains the commentpublic java.lang.String getAuthor()
Comment
getAuthor
in interface Comment
public void setAuthor(java.lang.String author)
Comment
setAuthor
in interface Comment
author
- the name of the original author of the comment
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |