Top Description Inners Fields Constructors Methods
org.apache.poi.hssf.record

public final Class DrawingSelectionRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.common.usermodel.GenericRecord, org.apache.poi.util.GenericRecordUtil, .LittleEndianInput, .LittleEndianOutput
MsoDrawingSelection (0x00ED)

Reference: [MS-OGRAPH].pdf sec 2.4.69

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
DrawingSelectionRecord.OfficeArtRecordHeader

From [MS-ODRAW].pdf sec 2.2.1

TODO - make EscherRecordHeader LittleEndianInput aware and refactor with this

Field Summary

Modifier and TypeField and Description
private int
_cpsp

private int
_dgslk

a MSODGSLK enum value for the current selection mode

private DrawingSelectionRecord.OfficeArtRecordHeader
_header

private int[]
_shapeIds

selected shape IDs (e.g. from EscherSpRecord.ShapeId)

private int
_spidFocus

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
DrawingSelectionRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public DrawingSelectionRecord
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

_cpspback to summary
private int _cpsp
_dgslkback to summary
private int _dgslk

a MSODGSLK enum value for the current selection mode

_headerback to summary
private DrawingSelectionRecord.OfficeArtRecordHeader _header
_shapeIdsback to summary
private int[] _shapeIds

selected shape IDs (e.g. from EscherSpRecord.ShapeId)

_spidFocusback to summary
private int _spidFocus
sidback to summary
public static final short sid

Constructor Detail

DrawingSelectionRecordback to summary
public DrawingSelectionRecord(RecordInputStream in)

Method Detail

copyback to summary
public DrawingSelectionRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:DrawingSelectionRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

org.apache.poi.hssf.record back to summary

private final Class DrawingSelectionRecord.OfficeArtRecordHeader

extends Object
implements GenericRecord
Class Inheritance
  • java.lang.Object
  • org.apache.poi.hssf.record.DrawingSelectionRecord.OfficeArtRecordHeader
All Implemented Interfaces
org.apache.poi.common.usermodel.GenericRecord
From [MS-ODRAW].pdf sec 2.2.1

TODO - make EscherRecordHeader LittleEndianInput aware and refactor with this

Field Summary

Modifier and TypeField and Description
private final int
_length

private final int
_type

value should be between 0xF000 and 0xFFFF

private final int
_verAndInstance

lower 4 bits is 'version' usually 0x01 or 0x0F (for containers) upper 12 bits is 'instance'

public static final int
ENCODED_SIZE

Constructor Summary

AccessConstructor and Description
public
OfficeArtRecordHeader(LittleEndianInput in)

Method Summary

Modifier and TypeMethod and Description
public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public void
serialize(LittleEndianOutput out)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_lengthback to summary
private final int _length
_typeback to summary
private final int _type

value should be between 0xF000 and 0xFFFF

_verAndInstanceback to summary
private final int _verAndInstance

lower 4 bits is 'version' usually 0x01 or 0x0F (for containers) upper 12 bits is 'instance'

ENCODED_SIZEback to summary
public static final int ENCODED_SIZE

Constructor Detail

OfficeArtRecordHeaderback to summary
public OfficeArtRecordHeader(LittleEndianInput in)

Method Detail

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
serializeback to summary
public void serialize(LittleEndianOutput out)