[aXSL-commit] SF.net SVN: axsl: [573] trunk/axsl/axsl-area-w/src/java/org/axsl/areaW

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

Revision: 573
Author:   victormote
Date:     2006-05-08 15:22:30 -0700 (Mon, 08 May 2006)
ViewCVS:  http://svn.sourceforge.net/axsl/?rev=573&view=rev

Log Message:
-----------
Add event class and listener interface for the Area Tree.

Added Paths:
-----------
    trunk/axsl/axsl-area-w/src/java/org/axsl/areaW/AreaTreeEvent.java
    trunk/axsl/axsl-area-w/src/java/org/axsl/areaW/AreaTreeListener.java
Added: trunk/axsl/axsl-area-w/src/java/org/axsl/areaW/AreaTreeEvent.java
===================================================================
--- trunk/axsl/axsl-area-w/src/java/org/axsl/areaW/AreaTreeEvent.java	                        (rev 0)
+++ trunk/axsl/axsl-area-w/src/java/org/axsl/areaW/AreaTreeEvent.java	2006-05-08 22:22:30 UTC (rev 573)
@@ -0,0 +1,62 @@
+/*
+ * 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.areaW;
+
+import java.util.EventObject;
+
+/**
+ * An Event used for notification that various stages of the building of an
+ * Area tree have been completed.
+ * Events are fired when an a page is complete, and when the document (AreaTree)
+ * is complete.
+ */
+public class AreaTreeEvent extends EventObject {
+    static final long serialVersionUID = 126074768253146781L;
+
+    private PageArea page;
+
+    /**
+     * Constructor for a "Page complete" event.
+     * @param source the Object that fired the event.
+     * @param page The PageArea instance that was just completed.
+     */
+    public AreaTreeEvent (Object source, PageArea page) {
+        super(source);
+        this.page = page;
+    }
+
+    /**
+     * Constructor for a "Document complete" event.
+     * @param source the Object that fired the event.
+     */
+    public AreaTreeEvent (Object source) {
+        super(source);
+    }
+
+    /**
+     * @return The PageArea object attached to this event.
+     * This will return null for non-PageArea events.
+     */
+    public PageArea getPage () {
+        return this.page;
+    }
+
+}


Property changes on: trunk/axsl/axsl-area-w/src/java/org/axsl/areaW/AreaTreeEvent.java
___________________________________________________________________
Name: svn:keywords
   + "Author Id Rev Date URL"
Name: svn:eol-style
   + native

Added: trunk/axsl/axsl-area-w/src/java/org/axsl/areaW/AreaTreeListener.java
===================================================================
--- trunk/axsl/axsl-area-w/src/java/org/axsl/areaW/AreaTreeListener.java	                        (rev 0)
+++ trunk/axsl/axsl-area-w/src/java/org/axsl/areaW/AreaTreeListener.java	2006-05-08 22:22:30 UTC (rev 573)
@@ -0,0 +1,45 @@
+/*
+ * 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.areaW;
+
+import java.util.EventListener;
+
+/**
+ * An interface for classes that need to handle {@link AreaTreeEvent} objects
+ * as they are fired.
+ * @see AreaTreeEvent
+ */
+
+public interface AreaTreeListener extends EventListener {
+
+    /**
+     * Method for handling a completed Area Tree page.
+     * @param event The event that has been fired.
+     */
+    void pageComplete (AreaTreeEvent event);
+
+    /**
+     * Method for handling a completed Area Tree.
+     * @param event The event that has been fired.
+     */
+    void areaTreeComplete (AreaTreeEvent event);
+
+}


Property changes on: trunk/axsl/axsl-area-w/src/java/org/axsl/areaW/AreaTreeListener.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.