Sets of FOs as expressed in 6.2 Formatting Object Content.

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/FOP_0-20-0_Alt-Design@195445 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/org/apache/fop/fo/FObjectSets.java b/src/org/apache/fop/fo/FObjectSets.java
new file mode 100644 (file)
index 0000000..49a9985
--- /dev/null
+++ b/src/org/apache/fop/fo/FObjectSets.java
@@ -0,0 +1,124 @@
+/*
+ * $Id$
+ * Copyright (C) 2001 The Apache Software Foundation. All rights reserved.
+ * For details on use and redistribution please refer to the
+ * LICENSE file included with these sources.
+ *
+ * @author <a href="mailto:pbwest@powerup.com.au">Peter B. West</a>
+ * @version $Rev$ $Name$
+ */
+
+package org.apache.fop.fo;
+
+import org.apache.fop.fo.FObjectNames;
+import org.apache.fop.datastructs.ROBitSet;
+
+import java.util.BitSet;
+
+/**
+ * Data class containing sets of Flow Objects included in certain FO set
+ * specifications.
+ */
+
+public class FObjectSets {
+
+    private static final String tag = "$Name$";
+    private static final String revision = "$Revision$";
+
+    /**  The set of FOs comprising the block entity.
+     *    See 6.14 Formatting Object Content. */
+    private static final BitSet block;
+    /** The publicly accessible block entity set.
+     *    See 6.14 Formatting Object Content. */
+    public static final ROBitSet blockEntity;
+    static {
+        block = new BitSet();
+        block.set(FObjectNames.TABLE_AND_CAPTION);
+        block.set(FObjectNames.TABLE);
+        block.set(FObjectNames.BLOCK);
+        block.set(FObjectNames.BLOCK_CONTAINER);
+        block.set(FObjectNames.LIST_BLOCK);
+        blockEntity = new ROBitSet(block);
+    }
+
+    /** The set of FOs comprising the inline entity.
+     *    See 6.14 Formatting Object Content. */
+    private static final BitSet inline;
+    /** The publicly accessible inline entity set.
+     *    See 6.14 Formatting Object Content. */
+    public static final ROBitSet inlineEntity;
+    static {
+        inline = new BitSet();
+        inline.set(FObjectNames.PAGE_NUMBER_CITATION);
+        inline.set(FObjectNames.PAGE_NUMBER);
+        inline.set(FObjectNames.BIDI_OVERRIDE);
+        inline.set(FObjectNames.CHARACTER);
+        inline.set(FObjectNames.EXTERNAL_GRAPHIC);
+        inline.set(FObjectNames.INSTREAM_FOREIGN_OBJECT);
+        inline.set(FObjectNames.INLINE);
+        inline.set(FObjectNames.INLINE_CONTAINER);
+        inline.set(FObjectNames.LEADER);
+        inline.set(FObjectNames.BASIC_LINK);
+        inline.set(FObjectNames.MULTI_TOGGLE);
+        inlineEntity = new ROBitSet(inline);
+    }
+
+    /** The set of FOs available wherever #PCDATA|%block;|%inline; is allowed
+     * including within descendents of out-of-line FOs.
+     *    See 6.14 Formatting Object Content. */
+    private static final BitSet pcdataBlockInline;
+
+    /** The publicly accessible set of FOs available wherever
+     * #PCDATA|%block;|%inline; is allowed, including within descendents from
+     * out-of-line FOs.
+     *    See 6.14 Formatting Object Content. */
+    public static final ROBitSet pcdataBlockInlineSet;
+    static {
+        pcdataBlockInline = new BitSet();
+        pcdataBlockInline.set(FObjectNames.WRAPPER);;
+        pcdataBlockInline.set(FObjectNames.RETRIEVE_MARKER);;
+        pcdataBlockInline.set(FObjectNames.MULTI_SWITCH);;
+        pcdataBlockInline.set(FObjectNames.MULTI_PROPERTIES);;
+        pcdataBlockInline.or(block);;
+        pcdataBlockInline.or(inline);;
+        pcdataBlockInlineSet = new ROBitSet(pcdataBlockInline);
+    }
+
+    /**
+     * The set of FOs available wherever #PCDATA|%block;|%inline; is allowed
+     * except within descendents of out-of-line FOs.
+     *     See 6.14 Formatting Object Content. */
+    private static final BitSet normalPcdataBlockInline;
+
+    /** The publicly accessible set of FOs available wherever
+     * #PCDATA|%block;|%inline; is allowed except within descendents of
+     * out-of-line FOs.  See 6.14 Formatting Object Content. */
+    public static final ROBitSet normalPcdataBlockInlineSet;
+    static {
+        normalPcdataBlockInline = new BitSet();
+        normalPcdataBlockInline.or(pcdataBlockInline);
+        normalPcdataBlockInline.set(FObjectNames.FLOAT);
+        normalPcdataBlockInlineSet = new ROBitSet(normalPcdataBlockInline);
+    }
+
+    /**
+     * The set of FOs available wherever #PCDATA|%inline; is allowed
+     * except within descendents of out-of-line FOs.
+     *     See 6.14 Formatting Object Content. */
+    private static final BitSet normalPcdataInline;
+
+    /** The publicly accessible set of FOs available wherever
+     * #PCDATA|%inline; is allowed except within descendents of
+     * out-of-line FOs.  See 6.14 Formatting Object Content. */
+    public static final ROBitSet normalPcdataInlineSet;
+    static {
+        normalPcdataInline = new BitSet();
+        normalPcdataInline.or(inline);
+        normalPcdataInline.set(FObjectNames.FLOAT);
+        normalPcdataInline.set(FObjectNames.FOOTNOTE);
+        normalPcdataInlineSet = new ROBitSet(normalPcdataInline);
+    }
+
+    private FObjectSets() {}
+
+}