Package org.apache.poi.hssf.model
Class DrawingManager2
java.lang.Object
org.apache.poi.hssf.model.DrawingManager2
Provides utilities to manage drawing groups.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
allocateShapeId
(short drawingGroupId) Deprecated.in POI 3.17-beta2, use allocateShapeId(EscherDgRecord)int
allocateShapeId
(short drawingGroupId, EscherDgRecord dg) Deprecated.in POI 3.17-beta2, use allocateShapeId(EscherDgRecord)int
Allocates new shape id for the drawing groupvoid
Clears the cached list of drawing groupsCreates a new drawing groupshort
Finds the next available (1 based) drawing group idgetDgg()
Returns the drawing group container recordvoid
Increment the drawing counter
-
Constructor Details
-
DrawingManager2
-
-
Method Details
-
clearDrawingGroups
public void clearDrawingGroups()Clears the cached list of drawing groups -
createDgRecord
Creates a new drawing group- Returns:
- a new drawing group
-
allocateShapeId
Deprecated.in POI 3.17-beta2, use allocateShapeId(EscherDgRecord)Allocates new shape id for the drawing group id.- Parameters:
drawingGroupId
- the drawing group id- Returns:
- a new shape id
-
allocateShapeId
@Deprecated @Removal(version="4.0") public int allocateShapeId(short drawingGroupId, EscherDgRecord dg) Deprecated.in POI 3.17-beta2, use allocateShapeId(EscherDgRecord)Allocates new shape id for the drawing group- Parameters:
drawingGroupId
- the drawing group iddg
- the EscherDgRecord which receives the new shape- Returns:
- a new shape id.
-
allocateShapeId
Allocates new shape id for the drawing group- Parameters:
dg
- the EscherDgRecord which receives the new shape- Returns:
- a new shape id.
-
findNewDrawingGroupId
public short findNewDrawingGroupId()Finds the next available (1 based) drawing group id- Returns:
- the next available drawing group id
-
getDgg
Returns the drawing group container record- Returns:
- the drawing group container record
-
incrementDrawingsSaved
public void incrementDrawingsSaved()Increment the drawing counter
-