aboutsummaryrefslogtreecommitdiffstats
path: root/src/java
diff options
context:
space:
mode:
authorMarius Volkhart <mariusvolkhart@apache.org>2021-02-17 15:10:17 +0000
committerMarius Volkhart <mariusvolkhart@apache.org>2021-02-17 15:10:17 +0000
commit26f3db7e1413b0c39fa97db0ac8c605a528c0d1c (patch)
tree794c82fc7ade6effadfa186c3af274bade513545 /src/java
parent5d9dcdf3df1a7c6996117c84f798d1ce6b94e215 (diff)
downloadpoi-26f3db7e1413b0c39fa97db0ac8c605a528c0d1c.tar.gz
poi-26f3db7e1413b0c39fa97db0ac8c605a528c0d1c.zip
Documentation for some EscherRecordTypes
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1886620 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/java')
-rw-r--r--src/java/org/apache/poi/ddf/EscherRecordTypes.java17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/java/org/apache/poi/ddf/EscherRecordTypes.java b/src/java/org/apache/poi/ddf/EscherRecordTypes.java
index 150bb4300b..b0c11ee5bd 100644
--- a/src/java/org/apache/poi/ddf/EscherRecordTypes.java
+++ b/src/java/org/apache/poi/ddf/EscherRecordTypes.java
@@ -25,7 +25,24 @@ import java.util.stream.Stream;
public enum EscherRecordTypes {
// records greater then 0xF000 belong to Microsoft Office Drawing format also known as Escher
+
+ /**
+ * {@link EscherContainerRecord Container} for all OfficeArt file records that contain document-wide data.
+ * <p>
+ * Contains, amongst others children, a {@link #BSTORE_CONTAINER}.
+ * <p>
+ * Referred to as an {@code OfficeArtDggContainer} in {@code [MS-ODRAW].pdf v20201117}.
+ */
DGG_CONTAINER(0xF000, "DggContainer", null, EscherContainerRecord::new),
+
+ /**
+ * {@link EscherContainerRecord Container} for all BLIPs (binary large image or picture) that are used in the
+ * drawings associated with the parent {@link #DGG_CONTAINER}.
+ * <p>
+ * Contains a list of {@link EscherBSERecord}s.
+ * <p>
+ * Referred to as an {@code OfficeArtBStoreContainer} in {@code [MS-ODRAW].pdf v20201117}.
+ */
BSTORE_CONTAINER(0xf001, "BStoreContainer", null, EscherContainerRecord::new),
DG_CONTAINER(0xf002, "DgContainer", null, EscherContainerRecord::new),
SPGR_CONTAINER(0xf003, "SpgrContainer", null, EscherContainerRecord::new),