1 files changed, 47 insertions, 7 deletions
diff --git a/src/org/apache/fop/area/TreeExt.java b/src/org/apache/fop/area/TreeExt.java
index cf4698918..8cca59cfd 100644
--- a/src/org/apache/fop/area/TreeExt.java
+++ b/src/org/apache/fop/area/TreeExt.java
@@ -1,6 +1,6 @@
 /*
  * $Id$
- * Copyright (C) 2001 The Apache Software Foundation. All rights reserved.
+ * Copyright (C) 2001-2002 The Apache Software Foundation. All rights reserved.
  * For details on use and redistribution please refer to the
  * LICENSE file included with these sources.
  */
@@ -8,13 +8,53 @@
 package org.apache.fop.area;
 
 /**
+ * Area tree extension interface.
+ * This interface is used by area tree extensions that are handled
+ * by the renderer.
+ * When this extension is handled by the area tree it is rendered
+ * according to the three possibilities, IMMEDIATELY, AFTER_PAGE
+ * or END_OF_DOC.
  */
 public interface TreeExt {
-    public final static int IMMEDIATELY = 0;
-    public final static int AFTER_PAGE = 1;
-    public final static int END_OF_DOC = 2;
+    /**
+     * Render this extension immediately when
+     * being handled by the area tree.
+     */
+    public static final int IMMEDIATELY = 0;
 
-    public boolean isResolveable();
-    public String getMimeType();
-    public String getName();
+    /**
+     * Render this extension after the next page is rendered
+     * or prepared when being handled by the area tree.
+     */
+    public static final int AFTER_PAGE = 1;
+
+    /**
+     * Render this extension at the end of the document once
+     * all pages have been fully rendered.
+     */
+    public static final int END_OF_DOC = 2;
+
+    /**
+     * Check if this tree extension is also resolveable so that
+     * the area tree can do id reference resolution when the
+     * extension is added to the area tree.
+     *
+     * @return true if this also implements resolveable
+     */
+    boolean isResolveable();
+
+    /**
+     * Get the mime type for the document that this area tree
+     * extension applies.
+     *
+     * @return the mime type of the document where this applies
+     */
+    String getMimeType();
+
+    /**
+     * Get the name of this extension.
+     *
+     * @return the name of this extension
+     */
+    String getName();
 }