loci.poi.hssf.model

Class TextboxShape

java.lang.Object

loci.poi.hssf.model.AbstractShape

loci.poi.hssf.model.TextboxShape

Direct Known Subclasses:

CommentShape

public class TextboxShape
extends AbstractShape

Represents an textbox shape and converts between the highlevel records and lowlevel records for an oval.

Author:

Glen Stampoultzis (glens at apache.org)

Field Summary

Fields

Modifier and Type	Field and Description
private EscherTextboxRecord	escherTextbox
private ObjRecord	objRecord
private EscherContainerRecord	spContainer
private TextObjectRecord	textObjectRecord

Constructor Summary

Constructors

Constructor and Description
TextboxShape(HSSFTextbox hssfShape, int shapeId) Creates the low evel records for an textbox.

Method Summary

Methods

Modifier and Type	Method and Description
private ObjRecord	createObjRecord(HSSFTextbox hssfShape, int shapeId) Creates the low level OBJ record for this shape.
private EscherContainerRecord	createSpContainer(HSSFTextbox hssfShape, int shapeId) Generates the escher shape records for this shape.
private TextObjectRecord	createTextObjectRecord(HSSFTextbox hssfShape, int shapeId) Textboxes also have an extra TXO record associated with them that most other shapes dont have.
EscherRecord	getEscherTextbox()
ObjRecord	getObjRecord()
EscherContainerRecord	getSpContainer()
TextObjectRecord	getTextObjectRecord()

Methods inherited from class loci.poi.hssf.model.AbstractShape

addStandardOptions, createAnchor, createShape

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

spContainer

private EscherContainerRecord spContainer

textObjectRecord

private TextObjectRecord textObjectRecord

objRecord

private ObjRecord objRecord

escherTextbox

private EscherTextboxRecord escherTextbox

Constructor Detail

TextboxShape

TextboxShape(HSSFTextbox hssfShape,
            int shapeId)

Creates the low evel records for an textbox.

Parameters:

hssfShape - The highlevel shape.

shapeId - The shape id to use for this shape.

Method Detail

createObjRecord

private ObjRecord createObjRecord(HSSFTextbox hssfShape,
                        int shapeId)

Creates the low level OBJ record for this shape.

createSpContainer

private EscherContainerRecord createSpContainer(HSSFTextbox hssfShape,
                                      int shapeId)

Generates the escher shape records for this shape.

Parameters:

hssfShape -

shapeId -

createTextObjectRecord

private TextObjectRecord createTextObjectRecord(HSSFTextbox hssfShape,
                                      int shapeId)

Textboxes also have an extra TXO record associated with them that most other shapes dont have.

getSpContainer

public EscherContainerRecord getSpContainer()

Specified by:

getSpContainer in class AbstractShape

Returns:

The shape container and it's children that can represent this shape.

getObjRecord

public ObjRecord getObjRecord()

Specified by:

getObjRecord in class AbstractShape

Returns:

The object record that is associated with this shape.

getTextObjectRecord

public TextObjectRecord getTextObjectRecord()

getEscherTextbox

public EscherRecord getEscherTextbox()