Package org.apache.poi.hslf.usermodel
Class HSLFShape
java.lang.Object
org.apache.poi.hslf.usermodel.HSLFShape
- All Implemented Interfaces:
Shape<HSLFShape,
HSLFTextParagraph>
- Direct Known Subclasses:
HSLFBackground
,HSLFGroupShape
,HSLFSimpleShape
Represents a Shape which is the elemental object that composes a drawing. This class is a wrapper around EscherSpContainer which holds all information about a shape in PowerPoint document.
When you add a shape, you usually specify the dimensions of the shape and the position of the upper'left corner of the bounding box for the shape relative to the upper'left corner of the page, worksheet, or slide. Distances in the drawing layer are measured in points (72 points = 1 inch).
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
HSLFShape
(EscherContainerRecord escherRecord, ShapeContainer<HSLFShape, HSLFTextParagraph> parent) Create a Shape object. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
afterInsert
(HSLFSheet sh) Event which fires when a shape is inserted in the sheet.protected EscherContainerRecord
createSpContainer
(boolean isChild) Create and assign the lower level escher record to this shapevoid
draw
(Graphics2D graphics, Rectangle2D bounds) Convenience method to draw a single shapeReturns the anchor (the bounding box rectangle) of this shape.protected HSLFEscherClientDataRecord
getClientData
(boolean create) Create a new HSLF-specific EscherClientDataRecord<T extends Record>
TgetClientDataRecord
(int recordType) Find a record in the underlying EscherClientDataRecordSearch for EscherClientDataRecord, if found, convert its contents into an array of HSLF records<T extends EscherRecord>
TgetEscherChild
(int recordId) static <T extends EscherRecord>
TgetEscherChild
(EscherContainerRecord owner, int recordId) Helper method to return escher child by record IDstatic <T extends EscherRecord>
TgetEscherChild
(EscherContainerRecord owner, RecordTypes recordId) <T extends EscherRecord>
TgetEscherChild
(RecordTypes recordId) int
getEscherProperty
(short propId) Get the value of a simple escher property for this shape.int
getEscherProperty
(short propId, int defaultValue) Get the value of a simple escher property for this shape.static <T extends EscherProperty>
TgetEscherProperty
(AbstractEscherOptRecord opt, int propId) Returns escher property by id.getFill()
Fill properties of this shapeboolean
boolean
double
int
Returns a unique identifier for this shape within the current slide.getSheet()
boolean
final void
moveTo
(double x, double y) Moves the top left corner of the shape to the specified point.void
setAnchor
(Rectangle2D anchor) Sets the anchor (the bounding box rectangle) of this shape.void
setEscherProperty
(short propId, int value) Set an simple escher property for this shape.static void
setEscherProperty
(AbstractEscherOptRecord opt, short propId, int value) Set an escher property for this shape.void
setFlipHorizontal
(boolean flip) void
setFlipVertical
(boolean flip) void
setRotation
(double theta) void
setShapeId
(int id) Sets shape IDvoid
setShapeType
(ShapeType type) void
Assign theSlideShow
this shape belongs to
-
Constructor Details
-
HSLFShape
protected HSLFShape(EscherContainerRecord escherRecord, ShapeContainer<HSLFShape, HSLFTextParagraph> parent) Create a Shape object. This constructor is used when an existing Shape is read from from a PowerPoint document.- Parameters:
escherRecord
-EscherSpContainer
container which holds information about this shapeparent
- the parent of this Shape
-
-
Method Details
-
createSpContainer
Create and assign the lower level escher record to this shape -
getParent
- Specified by:
getParent
in interfaceShape<HSLFShape,
HSLFTextParagraph> - Returns:
- the parent of this shape
-
getShapeName
- Specified by:
getShapeName
in interfaceShape<HSLFShape,
HSLFTextParagraph> - Returns:
- name of the shape.
-
getShapeType
-
setShapeType
-
getAnchor
Returns the anchor (the bounding box rectangle) of this shape. All coordinates are expressed in points (72 dpi).- Specified by:
getAnchor
in interfaceShape<HSLFShape,
HSLFTextParagraph> - Returns:
- the anchor of this shape
-
setAnchor
Sets the anchor (the bounding box rectangle) of this shape. All coordinates should be expressed in points (72 dpi).- Parameters:
anchor
- new anchor
-
moveTo
public final void moveTo(double x, double y) Moves the top left corner of the shape to the specified point.- Parameters:
x
- the x coordinate of the top left corner of the shapey
- the y coordinate of the top left corner of the shape
-
getEscherChild
Helper method to return escher child by record ID- Returns:
- escher record or
null
if not found.
-
getEscherChild
public static <T extends EscherRecord> T getEscherChild(EscherContainerRecord owner, RecordTypes recordId) - Since:
- POI 3.14-Beta2
-
getEscherChild
-
getEscherChild
- Since:
- POI 3.14-Beta2
-
getEscherProperty
public static <T extends EscherProperty> T getEscherProperty(AbstractEscherOptRecord opt, int propId) Returns escher property by id.- Returns:
- escher property or
null
if not found.
-
setEscherProperty
Set an escher property for this shape.- Parameters:
opt
- The opt record to set the properties to.propId
- The id of the property. One of the constants defined in EscherOptRecord.value
- value of the property. If value = -1 then the property is removed.
-
setEscherProperty
public void setEscherProperty(short propId, int value) Set an simple escher property for this shape.- Parameters:
propId
- The id of the property. One of the constants defined in EscherOptRecord.value
- value of the property. If value = -1 then the property is removed.
-
getEscherProperty
public int getEscherProperty(short propId) Get the value of a simple escher property for this shape.- Parameters:
propId
- The id of the property. One of the constants defined in EscherOptRecord.
-
getEscherProperty
public int getEscherProperty(short propId, int defaultValue) Get the value of a simple escher property for this shape.- Parameters:
propId
- The id of the property. One of the constants defined in EscherOptRecord.
-
getSpContainer
- Returns:
- The shape container and it's children that can represent this shape.
-
afterInsert
Event which fires when a shape is inserted in the sheet. In some cases we need to propagate changes to upper level containers.
Default implementation does nothing.- Parameters:
sh
- - owning shape
-
getSheet
- Specified by:
getSheet
in interfaceShape<HSLFShape,
HSLFTextParagraph> - Returns:
- the
SlideShow
this shape belongs to
-
setSheet
Assign theSlideShow
this shape belongs to- Parameters:
sheet
- owner of this shape
-
getShapeId
public int getShapeId()Description copied from interface:Shape
Returns a unique identifier for this shape within the current slide. This ID may be used to assist in uniquely identifying this object so that it can be referred to by other parts of the document.If multiple objects within the same slide share the same id attribute value, then the document shall be considered non-conformant.
- Specified by:
getShapeId
in interfaceShape<HSLFShape,
HSLFTextParagraph> - Returns:
- unique id of this shape
-
setShapeId
public void setShapeId(int id) Sets shape ID- Parameters:
id
- of the shape
-
getFill
Fill properties of this shape- Returns:
- fill properties of this shape
-
getFillStyle
-
draw
Description copied from interface:Shape
Convenience method to draw a single shape- Specified by:
draw
in interfaceShape<HSLFShape,
HSLFTextParagraph> - Parameters:
graphics
- the graphics contextbounds
- the rectangle to fit the shape to. if null, the bounds of the shape are used.
-
getEscherOptRecord
-
getFlipHorizontal
public boolean getFlipHorizontal() -
setFlipHorizontal
public void setFlipHorizontal(boolean flip) -
getFlipVertical
public boolean getFlipVertical() -
setFlipVertical
public void setFlipVertical(boolean flip) -
getRotation
public double getRotation() -
setRotation
public void setRotation(double theta) -
isPlaceholder
public boolean isPlaceholder() -
getClientDataRecord
Find a record in the underlying EscherClientDataRecord- Parameters:
recordType
- type of the record to search
-
getClientRecords
Search for EscherClientDataRecord, if found, convert its contents into an array of HSLF records- Returns:
- an array of HSLF records contained in the shape's EscherClientDataRecord or
null
-
getClientData
Create a new HSLF-specific EscherClientDataRecord- Parameters:
create
- if true, create the missing record- Returns:
- the client record or null if it was missing and create wasn't activated
-