|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.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_ARC, OBJECT_TYPE_COMBO_BOX, OBJECT_TYPE_COMMENT, OBJECT_TYPE_LINE, OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING, OBJECT_TYPE_OVAL, OBJECT_TYPE_PICTURE, OBJECT_TYPE_RECTANGLE, WRAP_BY_POINTS, WRAP_NONE, WRAP_SQUARE |
Constructor Summary | |
---|---|
HSSFTextbox(EscherContainerRecord spContainer,
ObjRecord objRecord,
TextObjectRecord textObjectRecord)
|
|
HSSFTextbox(HSSFShape parent,
HSSFAnchor anchor)
Construct a new textbox with the given parent and anchor. |
Method Summary | |
---|---|
protected void |
afterRemove(HSSFPatriarch patriarch)
remove escher container from the patriarch.escherAggregate remove obj, textObj and note records if it's necessary in case of ShapeGroup remove all contained shapes |
protected HSSFShape |
cloneShape()
|
protected ObjRecord |
createObjRecord()
|
protected EscherContainerRecord |
createSpContainer()
|
short |
getHorizontalAlignment()
Gets the horizontal alignment. |
int |
getMarginBottom()
Gets the bottom margin within the textbox. |
int |
getMarginLeft()
|
int |
getMarginRight()
|
int |
getMarginTop()
|
short |
getVerticalAlignment()
Gets the vertical alignment. |
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 |
setShapeType(int shapeType)
|
void |
setVerticalAlignment(short align)
Sets the vertical alignment. |
Methods inherited from class org.apache.poi.hssf.usermodel.HSSFSimpleShape |
---|
createTextObjRecord, getShapeId, getShapeType, getString, getTextObjectRecord, getWrapText, setString, setWrapText |
Methods inherited from class org.apache.poi.hssf.usermodel.HSSFShape |
---|
countOfAllChildren, getAnchor, getEscherContainer, getFillColor, getLineStyle, getLineStyleColor, getLineWidth, getObjRecord, getOptRecord, getParent, getPatriarch, getRotationDegree, getShapeName, isFlipHorizontal, isFlipVertical, isNoFill, setAnchor, setFillColor, setFillColor, setFlipHorizontal, setFlipVertical, setLineStyle, setLineStyleColor, setLineStyleColor, setLineWidth, setNoFill, setParent, setPatriarch, setPropertyValue, setRotationDegree |
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 |
---|
getAnchor, getParent, getShapeName, isNoFill, setFillColor, setLineStyleColor, setNoFill |
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(EscherContainerRecord spContainer, ObjRecord objRecord, TextObjectRecord textObjectRecord)
public HSSFTextbox(HSSFShape parent, HSSFAnchor anchor)
parent
- anchor
- One of HSSFClientAnchor or HSSFChildAnchorMethod Detail |
---|
protected ObjRecord createObjRecord()
createObjRecord
in class HSSFSimpleShape
protected EscherContainerRecord createSpContainer()
createSpContainer
in class HSSFSimpleShape
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 setShapeType(int shapeType)
setShapeType
in class HSSFSimpleShape
shapeType
- - shapeTypeHSSFShapeTypes
protected HSSFShape cloneShape()
cloneShape
in class HSSFSimpleShape
protected void afterRemove(HSSFPatriarch patriarch)
HSSFShape
afterRemove
in class HSSFSimpleShape
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |