]> source.dussan.org Git - xmlgraphics-fop.git/commitdiff
Missing license header and javadocs.
authorJeremias Maerki <jeremias@apache.org>
Tue, 22 Mar 2005 14:35:06 +0000 (14:35 +0000)
committerJeremias Maerki <jeremias@apache.org>
Tue, 22 Mar 2005 14:35:06 +0000 (14:35 +0000)
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/Temp_KnuthStylePageBreaking@198535 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/fop/layoutmgr/KnuthSequence.java

index 35fd84d1b3e423543199fb15136bcb7e9befe6b5..fe52c6b87659f0250a4b27b3aa364838e746f3c8 100644 (file)
@@ -1,19 +1,50 @@
+/*
+ * Copyright 2004-2005 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.layoutmgr;
 
 import java.util.LinkedList;
 
+/**
+ * Represents a list of Knuth elements.
+ */
 public class KnuthSequence extends LinkedList {
-    // number of KnuthElements added by the LineLayoutManager
+    /** Number of elements to ignore at the beginning of the list. */ 
     public int ignoreAtStart = 0;
+    /** Number of elements to ignore at the end of the list. */
     public int ignoreAtEnd = 0;
 
+    /**
+     * Creates a new and empty list.
+     */
     public KnuthSequence() {
+        super();
     }
 
+    /**
+     * Marks the start of the sequence.
+     */
     public void startSequence() {
     }
 
+    /**
+     * @return a finalized sequence.
+     */
     public KnuthSequence endSequence() {
         // remove glue and penalty item at the end of the paragraph
         while (this.size() > ignoreAtStart
@@ -23,8 +54,8 @@ public class KnuthSequence extends LinkedList {
         if (this.size() > ignoreAtStart) {
             // add the elements representing the space at the end of the last line
             // and the forced break
-/*LF*/      this.add(new KnuthPenalty(0, KnuthElement.INFINITE, false, null, false));
-/*LF*/      this.add(new KnuthGlue(0, 10000000, 0, null, false));
+            this.add(new KnuthPenalty(0, KnuthElement.INFINITE, false, null, false));
+            this.add(new KnuthGlue(0, 10000000, 0, null, false));
             this.add(new KnuthPenalty(0, -KnuthElement.INFINITE, false, null, false));
             ignoreAtEnd = 3;
             return this;