aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/render/afp/modca/IncludePageSegment.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/java/org/apache/fop/render/afp/modca/IncludePageSegment.java')
-rw-r--r--src/java/org/apache/fop/render/afp/modca/IncludePageSegment.java114
1 files changed, 114 insertions, 0 deletions
diff --git a/src/java/org/apache/fop/render/afp/modca/IncludePageSegment.java b/src/java/org/apache/fop/render/afp/modca/IncludePageSegment.java
new file mode 100644
index 000000000..5db736d57
--- /dev/null
+++ b/src/java/org/apache/fop/render/afp/modca/IncludePageSegment.java
@@ -0,0 +1,114 @@
+/*
+ * Copyright 2006 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.render.afp.modca;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.UnsupportedEncodingException;
+
+import org.apache.fop.render.afp.tools.BinaryUtils;
+
+/**
+ * The Include Page Segment structured field references a page segment resource
+ * object that is to be presented on the page or overlay presentation space. The IPS
+ * specifies a reference point on the including page or overlay coordinate system that
+ * may be used to position objects contained in the page segment. A page segment
+ * can be referenced at any time during page or overlay state, but not during an
+ * object state. The page segment inherits the active environment group definition of
+ * the including page or overlay.
+ *
+ * Note : No use for Triplets.
+ *
+ * A 'real' example for where this will be used is for
+ * the dynamic placing of overlay objects, such as signatures
+ * that may have to be placed at different positions on a document.
+ *
+ */
+public class IncludePageSegment extends AbstractNamedAFPObject{
+
+ /**
+ * The x position where we need to put this object on the page
+ */
+ private byte [] _xCoor;
+
+ /**
+ * The y position where we need to put this object on the page
+ */
+ private byte [] _yCoor;
+
+ /**
+ * Constructor for the Include Page Segment
+ * @param name Name of the page segment
+ * @param xVal The x position
+ * @param yVal The y position
+ */
+ public IncludePageSegment(String name, int xVal, int yVal){
+
+ super(name);
+ _xCoor = BinaryUtils.convert(xVal, 3);
+ _yCoor = BinaryUtils.convert(yVal, 3);
+
+ }
+
+ /**
+ * Accessor method to write the AFP datastream for the Include Page Segment
+ * @param os The stream to write to
+ * @throws java.io.IOException
+ */
+ public void writeDataStream(OutputStream os)
+ throws IOException {
+
+ byte[] data = new byte[23]; //(9 +14)
+
+ data[0] = 0x5A;
+
+ // Set the total record length
+ byte[] rl1 = BinaryUtils.convert(22, 2); //Ignore first byte
+ data[1] = rl1[0];
+ data[2] = rl1[1];
+
+ // Structured field ID for a IPS
+ data[3] = (byte) 0xD3;
+ data[4] = (byte) 0xAF;
+ data[5] = (byte) 0x5F;
+
+ data[6] = 0x00; // Reserved
+ data[7] = 0x00; // Reserved
+ data[8] = 0x00; // Reserved
+
+ for (int i = 0; i < _nameBytes.length; i++) {
+
+ data[9 + i] = _nameBytes[i];
+
+ }
+
+ data[17] = _xCoor[0]; // x coordinate
+ data[18] = _xCoor[1];
+ data[19] = _xCoor[2];
+
+ data[20] = _yCoor[0]; // y coordinate
+ data[21] = _yCoor[1];
+ data[22] = _yCoor[2];
+
+ os.write(data);
+
+ }
+
+
+}