org.apache.poi.hslf.model: public class: TextBox

org.apache.poi.hslf.model
public class: TextBox [javadoc | source]

java.lang.Object
   org.apache.poi.hslf.model.Shape
      org.apache.poi.hslf.model.SimpleShape
         org.apache.poi.hslf.model.TextShape
            org.apache.poi.hslf.model.TextBox

Direct Known Subclasses:
TableCell, Placeholder

Represents a TextFrame shape in PowerPoint.

Contains the text in a text frame as well as the properties and methods that control alignment and anchoring of the text.

author: Yegor - Kozlov

Fields inherited from org.apache.poi.hslf.model.TextShape:
AnchorTop, AnchorMiddle, AnchorBottom, AnchorTopCentered, AnchorMiddleCentered, AnchorBottomCentered, AnchorTopBaseline, AnchorBottomBaseline, AnchorTopCenteredBaseline, AnchorBottomCenteredBaseline, WrapSquare, WrapByPoints, WrapNone, WrapTopBottom, WrapThrough, AlignLeft, AlignCenter, AlignRight, AlignJustify, _txtrun, _txtbox, _frc

Fields inherited from org.apache.poi.hslf.model.Shape:
logger, EMU_PER_INCH, EMU_PER_POINT, EMU_PER_CENTIMETER, MASTER_DPI, PIXEL_DPI, POINT_DPI, _escherContainer, _parent, _sheet, _fill

Constructor:

Constructor:
public TextBox() { this(null); } Create a new TextBox. This constructor is used when a new shape is created.
public TextBox(Shape parent) { super(parent); } Create a new TextBox. This constructor is used when a new shape is created. Parameters: `parent` - the parent of this Shape. For example, if this text box is a cell in a table then the parent is Table.
protected TextBox(EscherContainerRecord escherRecord, Shape parent) { super(escherRecord, parent); } Create a TextBox object and initialize it from the supplied Record container. Parameters: `escherRecord` - `EscherSpContainer` container which holds information about this shape `parent` - the parent of the shape

 public TextBox() {
        this(null);
}

Create a new TextBox. This constructor is used when a new shape is created.

 public TextBox(Shape parent) {
        super(parent);
}

Create a new TextBox. This constructor is used when a new shape is created.

Parameters:

parent - the parent of this Shape. For example, if this text box is a cell in a table then the parent is Table.

 protected TextBox(EscherContainerRecord escherRecord,
    Shape parent) {
        super(escherRecord, parent);
}

Create a TextBox object and initialize it from the supplied Record container.

Parameters:

escherRecord - EscherSpContainer container which holds information about this shape

parent - the parent of the shape

Method from org.apache.poi.hslf.model.TextBox Summary:
createSpContainer, setDefaultTextProperties

Methods from org.apache.poi.hslf.model.TextShape:
afterInsert, createTextRun, draw, getEscherTextboxWrapper, getHorizontalAlignment, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPlaceholderAtom, getText, getTextId, getTextRun, getVerticalAlignment, getWordWrap, initTextRun, resizeToFitText, setDefaultTextProperties, setHorizontalAlignment, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setSheet, setText, setTextId, setVerticalAlignment, setWordWrap

Methods from org.apache.poi.hslf.model.TextShape:

afterInsert, createTextRun, draw, getEscherTextboxWrapper, getHorizontalAlignment, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPlaceholderAtom, getText, getTextId, getTextRun, getVerticalAlignment, getWordWrap, initTextRun, resizeToFitText, setDefaultTextProperties, setHorizontalAlignment, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setSheet, setText, setTextId, setVerticalAlignment, setWordWrap

Methods from org.apache.poi.hslf.model.SimpleShape:
createSpContainer, draw, getClientDataRecord, getFillColor, getFlipHorizontal, getFlipVertical, getLineColor, getLineDashing, getLineStyle, getLineWidth, getLogicalAnchor2D, getRotation, setFillColor, setLineColor, setLineDashing, setLineStyle, setLineWidth

Methods from org.apache.poi.hslf.model.Shape:
afterInsert, createSpContainer, draw, getAnchor, getAnchor2D, getColor, getEscherChild, getEscherProperty, getEscherProperty, getEscherProperty, getFill, getHyperlink, getLogicalAnchor2D, getOutline, getParent, getShapeId, getShapeName, getShapeType, getSheet, getSpContainer, moveTo, setAnchor, setEscherProperty, setEscherProperty, setShapeId, setShapeType, setSheet

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.poi.hslf.model.TextBox Detail:
protected EscherContainerRecord createSpContainer(boolean isChild) { _escherContainer = super.createSpContainer(isChild); setShapeType(ShapeTypes.TextBox); //set default properties for a TextBox setEscherProperty(EscherProperties.FILL__FILLCOLOR, 0x8000004); setEscherProperty(EscherProperties.FILL__FILLBACKCOLOR, 0x8000000); setEscherProperty(EscherProperties.FILL__NOFILLHITTEST, 0x100000); setEscherProperty(EscherProperties.LINESTYLE__COLOR, 0x8000001); setEscherProperty(EscherProperties.LINESTYLE__NOLINEDRAWDASH, 0x80000); setEscherProperty(EscherProperties.SHADOWSTYLE__COLOR, 0x8000002); _txtrun = createTextRun(); return _escherContainer; } Create a new TextBox and initialize its internal structures
protected void setDefaultTextProperties(TextRun _txtrun) { setVerticalAlignment(TextBox.AnchorTop); setEscherProperty(EscherProperties.TEXT__SIZE_TEXT_TO_FIT_SHAPE, 0x20002); }

Method from org.apache.poi.hslf.model.TextBox Detail:

 protected EscherContainerRecord createSpContainer(boolean isChild) {
        _escherContainer = super.createSpContainer(isChild);
        setShapeType(ShapeTypes.TextBox);
        //set default properties for a TextBox
        setEscherProperty(EscherProperties.FILL__FILLCOLOR, 0x8000004);
        setEscherProperty(EscherProperties.FILL__FILLBACKCOLOR, 0x8000000);
        setEscherProperty(EscherProperties.FILL__NOFILLHITTEST, 0x100000);
        setEscherProperty(EscherProperties.LINESTYLE__COLOR, 0x8000001);
        setEscherProperty(EscherProperties.LINESTYLE__NOLINEDRAWDASH, 0x80000);
        setEscherProperty(EscherProperties.SHADOWSTYLE__COLOR, 0x8000002);
        _txtrun = createTextRun();
        return _escherContainer;
}

Create a new TextBox and initialize its internal structures

 protected  void setDefaultTextProperties(TextRun _txtrun) {
        setVerticalAlignment(TextBox.AnchorTop);
        setEscherProperty(EscherProperties.TEXT__SIZE_TEXT_TO_FIT_SHAPE, 0x20002);
}