Top Description Fields Constructors Methods
org.apache.poi.hssf.model

public Class DrawingManager2

extends Object
Class Inheritance
Imports
java.util.ArrayList, .List, org.apache.poi.ddf.EscherDgRecord, .EscherDggRecord

Provides utilities to manage drawing groups.

Field Summary

Modifier and TypeField and Description
private final EscherDggRecord
private final List<EscherDgRecord>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

a new shape id.
allocateShapeId
(EscherDgRecord
the EscherDgRecord which receives the new shape
dg
)

Allocates new shape id for the drawing group

public void
clearDrawingGroups()

Clears the cached list of drawing groups

public EscherDgRecord

Returns:

a new drawing group
createDgRecord
()

Creates a new drawing group

public short

Returns:

the next available drawing group id
findNewDrawingGroupId
()

Finds the next available (1 based) drawing group id

public EscherDggRecord

Returns:

the drawing group container record
getDgg
()

Returns the drawing group container record

public void
incrementDrawingsSaved()

Increment the drawing counter

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

dggback to summary
private final EscherDggRecord dgg
drawingGroupsback to summary
private final List<EscherDgRecord> drawingGroups

Constructor Detail

DrawingManager2back to summary
public DrawingManager2(EscherDggRecord dgg)

Method Detail

allocateShapeIdback to summary
public int allocateShapeId(EscherDgRecord dg)

Allocates new shape id for the drawing group

Parameters
dg:EscherDgRecord

the EscherDgRecord which receives the new shape

Returns:int

a new shape id.

clearDrawingGroupsback to summary
public void clearDrawingGroups()

Clears the cached list of drawing groups

createDgRecordback to summary
public EscherDgRecord createDgRecord()

Creates a new drawing group

Returns:EscherDgRecord

a new drawing group

findNewDrawingGroupIdback to summary
public short findNewDrawingGroupId()

Finds the next available (1 based) drawing group id

Returns:short

the next available drawing group id

getDggback to summary
public EscherDggRecord getDgg()

Returns the drawing group container record

Returns:EscherDggRecord

the drawing group container record

incrementDrawingsSavedback to summary
public void incrementDrawingsSaved()

Increment the drawing counter