[aXSL-commit] SF.net SVN: axsl: [519] trunk/axsl/axsl-fo-r/src/java/org/axsl/foR

[<vic...@us...>]

Revision: 519
Author:   victormote
Date:     2006-05-06 09:10:32 -0700 (Sat, 06 May 2006)
ViewCVS:  http://svn.sourceforge.net/axsl/?rev=519&view=rev

Log Message:
-----------
Add new marker interface to be used to store Area Tree "generated by" information, and require FONodes to set and get it.

Modified Paths:
--------------
    trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FONode.java

Added Paths:
-----------
    trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FONodeResult.java
Modified: trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FONode.java
===================================================================
--- trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FONode.java	2006-05-06 15:56:26 UTC (rev 518)
+++ trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FONode.java	2006-05-06 16:10:32 UTC (rev 519)
@@ -135,9 +135,21 @@
     public FONodeProxy getProxy() ;
 
     /**
+     * Sets a result set for this FONode.
+     * @param result The FONodeResult to be set for this node.
+     */
+    public void setResult(FONodeResult result) ;
+
+    /**
+     * Returns the FONodeResult instance, if any, associated with this object.
+     * @return The current result for this FONode instance.
+     */
+    public FONodeResult getResult() ;
+
+    /**
      * Resets this node and all child nodes so that they can be reused.
-     * Specifically, all references to FONodeProxy instances should be
-     * dereferenced by implementations.
+     * Specifically, all references to {@link FONodeProxy} and
+     * {@link FONodeResult} instances should be dereferenced by implementations.
      * Running reset on the FORoot instance should reset the entire FOTree
      * for reuse.
      */

Added: trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FONodeResult.java
===================================================================
--- trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FONodeResult.java	                        (rev 0)
+++ trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FONodeResult.java	2006-05-06 16:10:32 UTC (rev 519)
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2006 The aXSL Project.
+ *      http://www.axsl.org
+ *
+ * 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.axsl.foR;
+
+/**
+ * <p>Marker interface that allows an FOTree client to embed information about
+ * the results of the client's processing into the FONode without the FOTree
+ * needing to know the details of that those results.
+ * For example, a typical use of the FOTree is as input to a layout system that
+ * will create an AreaTree from it.
+ * The AreaTree or layout system can use the FONodeResult to store an object
+ * that will keep track of the which Area nodes were created by which FO
+ * nodes.</p>
+ */
+public interface FONodeResult {
+
+}


Property changes on: trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FONodeResult.java
___________________________________________________________________
Name: svn:keywords
   + "Author Id Rev Date URL"
Name: svn:eol-style
   + native


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.