[aXSL-commit] SF.net SVN: axsl: [575] trunk/axsl/axsl-fo-r/src/java/org/axsl/foR
An API for XSL-FO.
Status: Alpha
Brought to you by:
victormote
Menu
▾
▴
[aXSL-commit] SF.net SVN: axsl: [575] trunk/axsl/axsl-fo-r/src/java/org/axsl/foR
|
From: <vic...@us...> - 2006-05-24 15:18:20
|
Revision: 575 Author: victormote Date: 2006-05-24 08:18:04 -0700 (Wed, 24 May 2006) ViewCVS: http://svn.sourceforge.net/axsl/?rev=575&view=rev Log Message: ----------- Rename some interfaces and methods for clarity. Added Paths: ----------- trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTree.java trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeFactory.java Removed Paths: ------------- trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeBuilder.java trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeServer.java Copied: trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTree.java (from rev 509, trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeBuilder.java) =================================================================== --- trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTree.java (rev 0) +++ trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTree.java 2006-05-24 15:18:04 UTC (rev 575) @@ -0,0 +1,95 @@ +/* + * Copyright 2005 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; + +import org.axsl.foR.fo.Root; +import org.axsl.fontR.FontConsumer; +import org.axsl.graphicR.GraphicServer; +import org.axsl.text.TextServer; + +import org.xml.sax.ContentHandler; + +import java.net.URL; + +/** + * An FOTreeBuilder is created for each document that is processed. + * It is conceptually directly under the FOTreeServer (which can be used for + * multiple documents and which generally creates FOTreeBuilder instances). + * Whereas FOTreeControl represents the client application to the FOTree + * implementation, FOTreeBuilder represents the FOTree implementation to the + * client application. + */ +public interface FOTree extends ContentHandler { + + public boolean hasData() ; + + public Root getRootFObj() ; + + /** + * Add an object to the collection of objects that should be notified about + * FOTreeEvent firings. + * @param listener the Object which should be notified + */ + public void addFOTreeListener (FOTreeListener listener) ; + + /** + * The client application can use this method to add a list of FO objects + * that it does not support, and that it wishes to have flagged for the + * user at parse time. The object will be created within the FOTree, but the + * user will receive a logged message warning them that the object is not + * supported. + * Note that multiple arrays can be added, and the relationship is OR, so + * that if a given item appears in any one or more of the arrays, it will + * be flagged. + * @param unsupportedObjectsFO An array of bytes, each element of which + * represents an element which should be flagged to the user. + * Valid element values are members of + * {@link org.axsl.common.Constants#objectNameList}. + */ + public void setUnsupportedObjectsFO(byte[] unsupportedObjectsFO) ; + + /** + * The client application can use this method to add a list of FO properties + * that it does not support, and that it wishes to have flagged for the + * user at parse time. The property will be created within the FOTree, but + * the user will receive a logged message warning them that the object is + * not supported. + * Note that multiple arrays can be added, and the relationship is OR, so + * that if a given item appears in any one or more of the arrays, it will + * be flagged. + * @param unsupportedPropertiesFO An array of shorts, each element of which + * represents an attribute which should be flagged to the user. + * Valid element values are members of + * {@link org.axsl.common.Constants#propertyNameList}. + */ + public void setUnsupportedPropertiesFO(short[] unsupportedPropertiesFO) ; + + public void setGraphicServer(GraphicServer graphicServer) ; + + public void setTextServer(TextServer textServer) ; + + public void setFontConsumer(FontConsumer consumer) ; + + public void setGraphicSearchPath(URL[] graphicSearchPath); + + public void setCachingGraphics(boolean cachingGraphics); + +} Deleted: trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeBuilder.java =================================================================== --- trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeBuilder.java 2006-05-08 23:55:54 UTC (rev 574) +++ trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeBuilder.java 2006-05-24 15:18:04 UTC (rev 575) @@ -1,95 +0,0 @@ -/* - * Copyright 2005 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; - -import org.axsl.foR.fo.Root; -import org.axsl.fontR.FontConsumer; -import org.axsl.graphicR.GraphicServer; -import org.axsl.text.TextServer; - -import org.xml.sax.ContentHandler; - -import java.net.URL; - -/** - * An FOTreeBuilder is created for each document that is processed. - * It is conceptually directly under the FOTreeServer (which can be used for - * multiple documents and which generally creates FOTreeBuilder instances). - * Whereas FOTreeControl represents the client application to the FOTree - * implementation, FOTreeBuilder represents the FOTree implementation to the - * client application. - */ -public interface FOTreeBuilder extends ContentHandler { - - public boolean hasData() ; - - public Root getRootFObj() ; - - /** - * Add an object to the collection of objects that should be notified about - * FOTreeEvent firings. - * @param listener the Object which should be notified - */ - public void addFOTreeListener (FOTreeListener listener) ; - - /** - * The client application can use this method to add a list of FO objects - * that it does not support, and that it wishes to have flagged for the - * user at parse time. The object will be created within the FOTree, but the - * user will receive a logged message warning them that the object is not - * supported. - * Note that multiple arrays can be added, and the relationship is OR, so - * that if a given item appears in any one or more of the arrays, it will - * be flagged. - * @param unsupportedObjectsFO An array of bytes, each element of which - * represents an element which should be flagged to the user. - * Valid element values are members of - * {@link org.axsl.common.Constants#objectNameList}. - */ - public void setUnsupportedObjectsFO(byte[] unsupportedObjectsFO) ; - - /** - * The client application can use this method to add a list of FO properties - * that it does not support, and that it wishes to have flagged for the - * user at parse time. The property will be created within the FOTree, but - * the user will receive a logged message warning them that the object is - * not supported. - * Note that multiple arrays can be added, and the relationship is OR, so - * that if a given item appears in any one or more of the arrays, it will - * be flagged. - * @param unsupportedPropertiesFO An array of shorts, each element of which - * represents an attribute which should be flagged to the user. - * Valid element values are members of - * {@link org.axsl.common.Constants#propertyNameList}. - */ - public void setUnsupportedPropertiesFO(short[] unsupportedPropertiesFO) ; - - public void setGraphicServer(GraphicServer graphicServer) ; - - public void setTextServer(TextServer textServer) ; - - public void setFontConsumer(FontConsumer consumer) ; - - public void setGraphicSearchPath(URL[] graphicSearchPath); - - public void setCachingGraphics(boolean cachingGraphics); - -} Copied: trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeFactory.java (from rev 509, trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeServer.java) =================================================================== --- trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeFactory.java (rev 0) +++ trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeFactory.java 2006-05-24 15:18:04 UTC (rev 575) @@ -0,0 +1,34 @@ +/* + * Copyright 2005 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; + +/** + * Creates implementation-specific {@link FOTree} instances. + */ +public interface FOTreeFactory { + + /** + * Create an {@link FOTree} instance to process a document. + * @return An implementation-specific instance of an {@link FOTree}. + */ + public FOTree makeFOTree(); + +} Deleted: trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeServer.java =================================================================== --- trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeServer.java 2006-05-08 23:55:54 UTC (rev 574) +++ trunk/axsl/axsl-fo-r/src/java/org/axsl/foR/FOTreeServer.java 2006-05-24 15:18:04 UTC (rev 575) @@ -1,37 +0,0 @@ -/* - * Copyright 2005 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; - -/** - * The top-level object in the FOTree implementation. - * FOTreeServer encapsulates the FOTree at a high level of abstraction for a - * client application. - */ -public interface FOTreeServer { - - /** - * Create a an FOTreeBuilder instance to process a document. - * @return An implementation of FOTreeBuilder that is in conformity with - * this server's processing. - */ - public FOTreeBuilder makeTreeBuilder(); - -} This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
