You are viewing a plain text version of this content. The canonical link for it is here.
Posted to fop-commits@xmlgraphics.apache.org by ac...@apache.org on 2008/04/30 13:02:06 UTC
svn commit: r652318 [1/4] - in
/xmlgraphics/fop/branches/Temp_AFPGOCAResources: ./
src/documentation/content/ src/java/org/apache/fop/fo/
src/java/org/apache/fop/fo/flow/ src/java/org/apache/fop/fo/flow/table/
src/java/org/apache/fop/fo/pagination/ src...
Author: acumiskey
Date: Wed Apr 30 04:02:03 2008
New Revision: 652318
URL: http://svn.apache.org/viewvc?rev=652318&view=rev
Log:
Merged revisions 651853,651855-651856,651866-651867,651880,651898 via svnmerge from
https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk
........
r651853 | adelmelle | 2008-04-26 21:06:04 +0100 (Sat, 26 Apr 2008) | 3 lines
Bugzilla 44203:
Fixed a logic error in Hyphenator.java where an UnsupportedOperationException was erroneously thrown if the supplied source had an associated InputStream.
........
r651855 | adelmelle | 2008-04-26 21:19:59 +0100 (Sat, 26 Apr 2008) | 3 lines
Basic activation of keep-* properties on Character and AbstractGraphics
+ javadoc updates
........
r651856 | adelmelle | 2008-04-26 21:21:44 +0100 (Sat, 26 Apr 2008) | 3 lines
Basic activation on some widely used properties (prepare for implementation)
+ javadoc updates
........
r651866 | adelmelle | 2008-04-26 23:08:10 +0100 (Sat, 26 Apr 2008) | 2 lines
Javadoc updates: attempt at improving interactivity and consistency
........
r651867 | adelmelle | 2008-04-27 00:07:51 +0100 (Sun, 27 Apr 2008) | 2 lines
Minor refactoring: consolidate getPSLM().notifyEndOfLayout(fobj.getId()) in AbstractLayoutManager.notifyEndOfLayout()
........
r651880 | clay | 2008-04-27 04:27:39 +0100 (Sun, 27 Apr 2008) | 1 line
Updated to include dev (0.95beta) release.
........
r651898 | adelmelle | 2008-04-27 09:18:31 +0100 (Sun, 27 Apr 2008) | 1 line
Correction of r651866
........
Modified:
xmlgraphics/fop/branches/Temp_AFPGOCAResources/ (props changed)
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/documentation/content/doap.rdf
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FONode.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FOText.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FObj.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FObjMixed.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/XMLObj.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/XMLWhiteSpaceHandler.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractGraphics.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractListItemPart.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractPageNumberCitation.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/BidiOverride.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Block.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Character.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/ExternalGraphic.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Float.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Footnote.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/FootnoteBody.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/InitialPropertySet.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Inline.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/InlineContainer.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/InlineLevel.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/InstreamForeignObject.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Leader.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/ListBlock.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/ListItem.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/ListItemBody.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/ListItemLabel.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Marker.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/MultiCase.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/MultiProperties.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/MultiPropertySet.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/MultiSwitch.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/MultiToggle.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/PageNumber.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/PageNumberCitation.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/PageNumberCitationLast.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/RetrieveMarker.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Wrapper.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/table/Table.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/table/TableAndCaption.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/table/TableBody.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/table/TableCaption.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/table/TableCell.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/table/TableColumn.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/table/TableFooter.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/table/TableHeader.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/table/TableRow.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/AbstractPageSequence.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/ColorProfile.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/Declarations.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/Flow.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/PageSequenceMaster.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/PageSequenceWrapper.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/Region.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/RegionAfter.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/RegionBA.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/RegionBefore.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/RegionBody.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/RegionEnd.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/RegionSE.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/RegionStart.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterAlternatives.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterReference.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/Root.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/SinglePageMasterReference.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/StaticContent.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/SubSequenceSpecifier.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/Title.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/bookmarks/Bookmark.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTree.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/hyphenation/Hyphenator.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/layoutmgr/AbstractLayoutManager.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/layoutmgr/BlockContainerLayoutManager.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/layoutmgr/BlockLayoutManager.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/layoutmgr/list/ListBlockLayoutManager.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/layoutmgr/list/ListItemContentLayoutManager.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/layoutmgr/list/ListItemLayoutManager.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/layoutmgr/table/TableCellLayoutManager.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/layoutmgr/table/TableLayoutManager.java
xmlgraphics/fop/branches/Temp_AFPGOCAResources/status.xml
Propchange: xmlgraphics/fop/branches/Temp_AFPGOCAResources/
------------------------------------------------------------------------------
--- svnmerge-integrated (original)
+++ svnmerge-integrated Wed Apr 30 04:02:03 2008
@@ -1 +1 @@
-/xmlgraphics/fop/trunk:1-651623
+/xmlgraphics/fop/trunk:1-652071
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/documentation/content/doap.rdf
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/documentation/content/doap.rdf?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/documentation/content/doap.rdf (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/documentation/content/doap.rdf Wed Apr 30 04:02:03 2008
@@ -76,13 +76,20 @@
</asfext:implements>
<release>
<Version>
- <name>Previous release</name>
+ <name>Previous stable release</name>
<created>2007-01-02</created>
<revision>0.93</revision>
</Version>
</release>
<release>
<Version>
+ <name>Previous development release</name>
+ <created>2008-25-08</created>
+ <revision>0.95beta</revision>
+ </Version>
+ </release>
+ <release>
+ <Version>
<name>Latest stable release</name>
<created>2007-08-23</created>
<revision>0.94</revision>
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FONode.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FONode.java?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FONode.java (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FONode.java Wed Apr 30 04:02:03 2008
@@ -59,19 +59,21 @@
/** pointer to the sibling nodes */
protected FONode[] siblings;
- /**
- * Marks location of this object from the input FO
- * Call locator.getSystemId(), getLineNumber(),
- * getColumnNumber() for file, line, column
+ /**
+ * Marks the location of this object from the input FO
+ * <br>Call <code>locator.getSystemId()</code>,
+ * <code>getLineNumber()</code>,
+ * <code>getColumnNumber()</code> for file, line, column
* information
*/
protected Locator locator;
/** Logger for fo-tree related messages **/
protected static Log log = LogFactory.getLog(FONode.class);
-
+
/**
- * Main constructor.
+ * Base constructor
+ *
* @param parent parent of this node
*/
protected FONode(FONode parent) {
@@ -79,8 +81,9 @@
}
/**
- * Perform a shallow cloning operation,
- * set its parent, and optionally clean the list of child nodes
+ * Performs a shallow cloning operation, sets the clone's parent,
+ * and optionally cleans the list of child nodes
+ *
* @param cloneparent the intended parent of the clone
* @param removeChildren if true, clean the list of child nodes
* @return the cloned FO node
@@ -88,32 +91,31 @@
*/
public FONode clone(FONode cloneparent, boolean removeChildren)
throws FOPException {
- FONode foNode = (FONode) clone();
- foNode.parent = cloneparent;
- foNode.siblings = null;
- return foNode;
+ try {
+ FONode foNode = (FONode) clone();
+ foNode.parent = cloneparent;
+ foNode.siblings = null;
+ return foNode;
+ } catch (CloneNotSupportedException cnse) {
+ return null;
+ }
}
/**
* Perform a shallow cloning operation
- *
+ *
* {@inheritDoc}
- * @return the cloned object
*/
- protected Object clone() {
- try {
- return super.clone();
- } catch (CloneNotSupportedException e) {
- return null;
- }
+ protected Object clone() throws CloneNotSupportedException {
+ return super.clone();
}
/**
* Bind the given <code>PropertyList</code> to this node
- * Does nothing by default. Subclasses should override this method
- * in case they want to use the properties available on the
+ * Does nothing by default. Subclasses should override this method
+ * in case they want to use the properties available on the
* <code>PropertyList</code>.
- *
+ *
* @param propertyList the <code>PropertyList</code>
* @throws FOPException if there was an error when
* processing the <code>PropertyList</code>
@@ -121,7 +123,7 @@
public void bind(PropertyList propertyList) throws FOPException {
//nop
}
-
+
/**
* Set the location information for this element
* @param locator the org.xml.sax.Locator object
@@ -134,20 +136,27 @@
}
}
- /** @return the location information for this element or null, if not available */
+ /**
+ * Returns the <code>Locator</code> containing the location information for this
+ * element, or <code>null</code> if not available
+ *
+ * @return the location information for this element or <code>null</code>, if not available
+ */
public Locator getLocator() {
return this.locator;
}
-
+
/**
- * Recursively goes up the FOTree hierarchy until the fo:root is found,
- * which returns the parent FOEventHandler.
+ * Recursively goes up the FOTree hierarchy until the <code>fo:root</code>
+ * is found, which returns the parent <code>FOEventHandler</code>.
+ * <br>(see also: {@link org.apache.fop.fo.pagination.Root#getFOEventHandler()})
+ *
* @return the FOEventHandler object that is the parent of the FO Tree
*/
public FOEventHandler getFOEventHandler() {
return parent.getFOEventHandler();
}
-
+
/**
* Indicates whether this node is a child of an fo:marker.
* @return true if this node is a child of an fo:marker
@@ -157,8 +166,10 @@
}
/**
- * Returns the user agent for the node.
- * @return FOUserAgent
+ * Returns the user agent that is associated with the
+ * tree's <code>FOEventHandler</code>.
+ *
+ * @return the user agent
*/
public FOUserAgent getUserAgent() {
return getFOEventHandler().getUserAgent();
@@ -166,6 +177,7 @@
/**
* Returns the logger for the node.
+ *
* @return the logger
*/
public Log getLogger() {
@@ -176,16 +188,17 @@
* Initialize the node with its name, location information, and attributes
* The attributes must be used immediately as the sax attributes
* will be altered for the next element.
+ *
* @param elementName element name (e.g., "fo:block")
* @param locator Locator object (ignored by default)
* @param attlist Collection of attributes passed to us from the parser.
* @param pList the property list of the parent node
* @throws FOPException for errors or inconsistencies in the attributes
*/
- public void processNode(String elementName, Locator locator,
+ public void processNode(String elementName, Locator locator,
Attributes attlist, PropertyList pList) throws FOPException {
if (log.isDebugEnabled()) {
- log.debug("Unhandled element: " + elementName
+ log.debug("Unhandled element: " + elementName
+ (locator != null ? " at " + getLocatorString(locator) : ""));
}
}
@@ -193,30 +206,36 @@
/**
* Create a property list for this node. Return null if the node does not
* need a property list.
- * @param pList the closest parent propertylist.
- * @param foEventHandler The FOEventHandler where the PropertyListMaker
+ *
+ * @param pList the closest parent propertylist.
+ * @param foEventHandler The FOEventHandler where the PropertyListMaker
* instance can be found.
* @return A new property list.
* @throws FOPException if there's a problem during processing
*/
- protected PropertyList createPropertyList(PropertyList pList, FOEventHandler foEventHandler)
+ protected PropertyList createPropertyList(
+ PropertyList pList,
+ FOEventHandler foEventHandler)
throws FOPException {
return null;
}
/**
* Checks to make sure, during SAX processing of input document, that the
- * incoming node is valid for the this (parent) node (e.g., checking to
+ * incoming node is valid for this (parent) node (e.g., checking to
* see that <code>fo:table</code> is not an immediate child of <code>fo:root</code>)
* called from {@link FOTreeBuilder#startElement(String, String, String, Attributes)}
* before constructing the child {@link FObj}.
- *
+ *
* @param loc location in the FO source file
* @param namespaceURI namespace of incoming node
* @param localName name of the incoming node (without namespace prefix)
* @throws ValidationException if incoming node not valid for parent
*/
- protected void validateChildNode(Locator loc, String namespaceURI, String localName)
+ protected void validateChildNode(
+ Locator loc,
+ String namespaceURI,
+ String localName)
throws ValidationException {
//nop
}
@@ -224,30 +243,32 @@
/**
* Static version of {@link FONode#validateChildNode(Locator, String, String)} that
* can be used by subclasses that need to validate children against a different node
- * (for example: <code>fo:wrapper</code> needs to check if the incoming node is a
+ * (for example: <code>fo:wrapper</code> needs to check if the incoming node is a
* valid child to its parent)
- *
- * @param fo the FONode to validate against
+ *
+ * @param fo the {@link FONode} to validate against
* @param loc location in the source file
* @param namespaceURI namespace of the incoming node
- * @param localName name of the incoming node (without namespace prefix)
+ * @param localName name of the incoming node (without namespace prefix)
* @throws ValidationException if the incoming node is not a valid child for the given FO
*/
protected static void validateChildNode(
- FONode fo,
- Locator loc,
- String namespaceURI,
- String localName)
+ FONode fo,
+ Locator loc,
+ String namespaceURI,
+ String localName)
throws ValidationException {
fo.validateChildNode(loc, namespaceURI, localName);
}
-
+
/**
- * Adds characters (does nothing here)
+ * Adds characters. Does nothing by default. To be overridden in subclasses
+ * that allow <code>#PCDATA</code> content.
+ *
* @param data array of characters containing text to be added
* @param start starting array element to add
* @param end ending array element to add
- * @param pList currently applicable PropertyList
+ * @param pList currently applicable PropertyList
* @param locator location in the XSL-FO source file.
* @throws FOPException if there's a problem during processing
*/
@@ -259,6 +280,7 @@
/**
* Called after processNode() is called. Subclasses can do additional processing.
+ *
* @throws FOPException if there's a problem during processing
*/
protected void startOfNode() throws FOPException {
@@ -267,8 +289,9 @@
/**
* Primarily used for making final content model validation checks
- * and/or informing the FOEventHandler that the end of this FO
+ * and/or informing the {@link FOEventHandler} that the end of this FO
* has been reached.
+ *
* @throws FOPException if there's a problem during processing
*/
protected void endOfNode() throws FOPException {
@@ -278,6 +301,7 @@
/**
* Adds a node as a child of this node. The default implementation of this method
* just ignores any child node being added.
+ *
* @param child child node to be added to the childNodes of this node
* @throws FOPException if there's a problem during processing
*/
@@ -288,6 +312,7 @@
/**
* Removes a child node. Used by the child nodes to remove themselves, for
* example table-body if it has no children.
+ *
* @param child child node to be removed
*/
public void removeChild(FONode child) {
@@ -295,6 +320,8 @@
}
/**
+ * Return the parent node of this node
+ *
* @return the parent node of this node
*/
public FONode getParent() {
@@ -302,8 +329,9 @@
}
/**
- * Return an iterator over all the child nodes of this FObj.
- * @return A ListIterator.
+ * Return an iterator over all the child nodes of this node.
+ *
+ * @return the iterator over the FO's childnodes
*/
public FONodeIterator getChildNodes() {
return null;
@@ -312,15 +340,18 @@
/**
* Return an iterator over the object's child nodes starting
* at the passed node.
+ *
* @param childNode First node in the iterator
- * @return A ListIterator or null if child node isn't a child of
- * this FObj.
+ * @return the iterator, or <code>null</code> if
+ * the given node is not a child of this node.
*/
public FONodeIterator getChildNodes(FONode childNode) {
return null;
}
/**
+ * Return a {@link CharIterator} over all characters in this node
+ *
* @return an iterator for the characters in this node
*/
public CharIterator charIterator() {
@@ -332,7 +363,7 @@
* name pairs in text messages.
* For readability, using fo:, fox:, svg:, for those namespaces even
* though that prefix may not have been chosen in the document.
- * @param namespaceURI URI of node found
+ * @param namespaceURI URI of node found
* (e.g., "http://www.w3.org/1999/XSL/Format")
* @param localName local name of node, (e.g., "root" for "fo:root")
* @return the prefix:localname, if fo/fox/svg, or a longer representation
@@ -359,28 +390,29 @@
return FOValidationEventProducer.Provider.get(
getUserAgent().getEventBroadcaster());
}
-
+
/**
* Helper function to standardize "too many" error exceptions
* (e.g., two fo:declarations within fo:root)
* @param loc org.xml.sax.Locator object of the error (*not* parent node)
* @param nsURI namespace URI of incoming invalid node
- * @param lName local name (i.e., no prefix) of incoming node
+ * @param lName local name (i.e., no prefix) of incoming node
* @throws ValidationException the validation error provoked by the method call
*/
- protected void tooManyNodesError(Locator loc, String nsURI, String lName)
+ protected void tooManyNodesError(Locator loc, String nsURI, String lName)
throws ValidationException {
tooManyNodesError(loc, new QName(nsURI, lName));
}
/**
* Helper function to standardize "too many" error exceptions
- * (e.g., two fo:declarations within fo:root)
+ * (e.g., two <code>fo:declarations</code> within <code>fo:root</code>)
+ *
* @param loc org.xml.sax.Locator object of the error (*not* parent node)
* @param offendingNode the qualified name of the offending node
* @throws ValidationException the validation error provoked by the method call
*/
- protected void tooManyNodesError(Locator loc, QName offendingNode)
+ protected void tooManyNodesError(Locator loc, QName offendingNode)
throws ValidationException {
getFOValidationEventProducer().tooManyNodes(this, getName(), offendingNode, loc);
}
@@ -393,24 +425,25 @@
* @param offendingNode incoming node that would cause a duplication.
* @throws ValidationException the validation error provoked by the method call
*/
- protected void tooManyNodesError(Locator loc, String offendingNode)
+ protected void tooManyNodesError(Locator loc, String offendingNode)
throws ValidationException {
tooManyNodesError(loc, new QName(FO_URI, offendingNode));
}
/**
* Helper function to standardize "out of order" exceptions
- * (e.g., fo:layout-master-set appearing after fo:page-sequence)
+ * (e.g., <code>fo:layout-master-set</code> appearing after <code>fo:page-sequence</code>)
+ *
* @param loc org.xml.sax.Locator object of the error (*not* parent node)
* @param tooLateNode string name of node that should be earlier in document
* @param tooEarlyNode string name of node that should be later in document
* @throws ValidationException the validation error provoked by the method call
*/
- protected void nodesOutOfOrderError(Locator loc, String tooLateNode,
+ protected void nodesOutOfOrderError(Locator loc, String tooLateNode,
String tooEarlyNode) throws ValidationException {
nodesOutOfOrderError(loc, tooLateNode, tooEarlyNode, false);
}
-
+
/**
* Helper function to standardize "out of order" exceptions
* (e.g., fo:layout-master-set appearing after fo:page-sequence)
@@ -420,28 +453,30 @@
* @param canRecover indicates whether FOP can recover from this problem and continue working
* @throws ValidationException the validation error provoked by the method call
*/
- protected void nodesOutOfOrderError(Locator loc, String tooLateNode,
+ protected void nodesOutOfOrderError(Locator loc, String tooLateNode,
String tooEarlyNode, boolean canRecover) throws ValidationException {
getFOValidationEventProducer().nodeOutOfOrder(this, getName(),
tooLateNode, tooEarlyNode, canRecover, loc);
}
-
+
/**
* Helper function to return "invalid child" exceptions
- * (e.g., fo:block appearing immediately under fo:root)
+ * (e.g., <code>fo:block</code> appearing immediately under <code>fo:root</code>)
+ *
* @param loc org.xml.sax.Locator object of the error (*not* parent node)
* @param nsURI namespace URI of incoming invalid node
- * @param lName local name (i.e., no prefix) of incoming node
+ * @param lName local name (i.e., no prefix) of incoming node
* @throws ValidationException the validation error provoked by the method call
*/
- protected void invalidChildError(Locator loc, String nsURI, String lName)
+ protected void invalidChildError(Locator loc, String nsURI, String lName)
throws ValidationException {
invalidChildError(loc, getName(), nsURI, lName, null);
}
-
+
/**
* Helper function to return "invalid child" exceptions with more
* complex validation rules (i.e., needing more explanation of the problem)
+ *
* @param loc org.xml.sax.Locator object of the error (*not* parent node)
* @param parentName the name of the parent element
* @param nsURI namespace URI of incoming invalid node
@@ -458,8 +493,10 @@
/**
* Helper function to throw an error caused by missing mandatory child elements.
- * E.g., fo:layout-master-set not having any page-master child element.
- * @param contentModel The XSL Content Model for the fo: object or a similar description
+ * (e.g., <code>fo:layout-master-set</code> not having any <code>fo:page-master</code>
+ * child element.
+ *
+ * @param contentModel The XSL Content Model for the fo: object or a similar description
* indicating the necessary child elements.
* @throws ValidationException the validation error provoked by the method call
*/
@@ -472,7 +509,7 @@
/**
* Helper function to throw an error caused by missing mandatory child elements.
* E.g., fo:layout-master-set not having any page-master child element.
- * @param contentModel The XSL Content Model for the fo: object or a similar description
+ * @param contentModel The XSL Content Model for the fo: object or a similar description
* indicating the necessary child elements.
* @param canRecover indicates whether FOP can recover from this problem and continue working
* @throws ValidationException the validation error provoked by the method call
@@ -485,6 +522,7 @@
/**
* Helper function to throw an error caused by missing mandatory properties
+ *
* @param propertyName the name of the missing property.
* @throws ValidationException the validation error provoked by the method call
*/
@@ -496,6 +534,7 @@
/**
* Helper function to return "Error(line#/column#)" string for
* above exception messages
+ *
* @param loc org.xml.sax.Locator object
* @return String opening error text
*/
@@ -506,15 +545,17 @@
/**
* Helper function to return "Warning(line#/column#)" string for
* warning messages
+ *
* @param loc org.xml.sax.Locator object
* @return String opening warning text
*/
protected static String warningText(Locator loc) {
return "Warning(" + getLocatorString(loc) + "): ";
}
-
+
/**
* Helper function to format a Locator instance.
+ *
* @param loc org.xml.sax.Locator object
* @return String the formatted text
*/
@@ -528,6 +569,7 @@
/**
* Decorates a log or warning message with context information on the given node.
+ *
* @param text the original message
* @param node the context node
* @return the decorated text
@@ -541,7 +583,7 @@
return text;
}
}
-
+
/**
* Returns a String containing as much context information as possible about a node. Call
* this method only in exceptional conditions because this method may perform quite extensive
@@ -573,7 +615,7 @@
}
return sb.toString();
}
-
+
/**
* Returns a String containing as some context information about a node. It does not take the
* locator into consideration and returns null if no useful context information can be found.
@@ -598,7 +640,7 @@
return null;
}
}
-
+
/** Function for AdvancedMessageFormat to retrieve context info from an FONode. */
public static class GatherContextInfoFunction implements Function {
@@ -621,7 +663,7 @@
return "gatherContextInfo";
}
}
-
+
/**
* Gathers context information for the getContextInfo() method.
* @return the collected context information or null, if none is available
@@ -629,9 +671,10 @@
protected String gatherContextInfo() {
return null;
}
-
+
/**
* Returns the root node of this tree
+ *
* @return the root node
*/
public Root getRoot() {
@@ -640,6 +683,7 @@
/**
* Returns the fully qualified name of the node
+ *
* @return the fully qualified name of this node
*/
public String getName() {
@@ -648,6 +692,7 @@
/**
* Returns the fully qualified name of the node
+ *
* @param prefix the namespace prefix to build the name with (may be null)
* @return the fully qualified name of this node
*/
@@ -663,22 +708,32 @@
/**
* Returns the local name (i.e. without namespace prefix) of the node
+ *
* @return the local name of this node
*/
public abstract String getLocalName();
- /** @return the normally ussed namespace prefix for this kind of node (ex. "fo" for XSL-FO) */
+ /**
+ * Returns the normally used namespace prefix for this node
+ *
+ * @return the normally used namespace prefix for this kind of node (ex. "fo" for XSL-FO)
+ */
public abstract String getNormalNamespacePrefix();
-
- /** @return the namespace URI for this node */
+
+ /**
+ * Returns the namespace URI for this node
+ *
+ * @return the namespace URI for this node
+ */
public String getNamespaceURI() {
return null;
}
-
+
/**
* Returns the {@link Constants} class integer value of this node
- * @return the integer enumeration of this FO (e.g. FO_ROOT)
- * if a formatting object, FO_UNKNOWN_NODE otherwise
+ *
+ * @return the integer enumeration of this FO (e.g. {@link Constants#FO_ROOT})
+ * if a formatting object, {@link Constants#FO_UNKNOWN_NODE} otherwise
*/
public int getNameId() {
return Constants.FO_UNKNOWN_NODE;
@@ -687,25 +742,31 @@
/**
* This method is overridden by extension elements and allows the extension element
* to return a pass-through attachment which the parent formatting objects should simply
- * carry with them but otherwise ignore. This mechanism is used to pass non-standard
- * information from the FO tree through to the layout engine and the renderers.
+ * carry with them but otherwise ignore. This mechanism is used to pass non-standard
+ * information from the FO tree through to the layout engine and the renderers.
+ *
* @return the extension attachment if one is created by the extension element, null otherwise.
*/
public ExtensionAttachment getExtensionAttachment() {
return null;
}
-
+
/**
* This method is overridden by extension elements and allows the extension element to return
- * a ContentHandlerFactory. This factory can create ContentHandler implementations that handle
+ * a {@link ContentHandlerFactory}. This factory can create ContentHandler implementations that handle
* foreign XML content by either building up a specific DOM, a Java object or something else.
- * @return the ContentHandlerFactory or null if not applicable
+ *
+ * @return the <code>ContentHandlerFactory</code> or <code>null</code> if not applicable
*/
public ContentHandlerFactory getContentHandlerFactory() {
return null;
}
-
+
/**
+ * Returns <code>true</code> if <code>fo:marker</code> is allowed as
+ * a child node.
+ * <br>To be overridden <i>only</i> in extension nodes that need it.
+ *
* @return true if markers are valid children
*/
protected boolean canHaveMarkers() {
@@ -735,16 +796,16 @@
return false;
}
}
-
+
/**
* This method is used when adding child nodes to a FO that already
* contains at least one child. In this case, the new child becomes a
* sibling to the previous one
- *
+ *
* @param precedingSibling the previous child
* @param followingSibling the new child
*/
- protected static void attachSiblings(FONode precedingSibling,
+ protected static void attachSiblings(FONode precedingSibling,
FONode followingSibling) {
if (precedingSibling.siblings == null) {
precedingSibling.siblings = new FONode[2];
@@ -755,52 +816,54 @@
precedingSibling.siblings[1] = followingSibling;
followingSibling.siblings[0] = precedingSibling;
}
-
+
/**
* Base iterator interface over a FO's children
- *
*/
public interface FONodeIterator extends ListIterator {
-
+
/**
- * Returns the parent node for this iterator's list
+ * Returns the parent node for this iterator's list
* of child nodes
+ *
* @return the parent node
*/
FObj parentNode();
-
+
/**
* Convenience method with return type of FONode
- * (should be semantically equivalent to
- * <code>(FONode) next();</code>)
+ * (semantically equivalent to: <code>(FONode) next();</code>)
+ *
* @return the next node (if any), as a type FONode
*/
FONode nextNode();
-
+
/**
* Convenience method with return type of FONode
- * (should be semantically equivalent to
- * <code>(FONode) previous();</code>)
+ * (semantically equivalent to: <code>(FONode) previous();</code>)
+ *
* @return the previous node (if any), as a type FONode
*/
FONode previousNode();
-
+
/**
* Returns the first node in the list, and decreases the index,
- * so that a subsequent call to hasPrevious() will return false
+ * so that a subsequent call to <code>hasPrevious()</code> will
+ * return <code>false</code>
+ *
* @return the first node in the list
- * @throws NoSuchElementException if the list is empty
*/
FONode firstNode();
-
+
/**
* Returns the last node in the list, and advances the
- * current position, so that a subsequent call to hasNext()
- * will return false
+ * current position, so that a subsequent call to <code>hasNext()</code>
+ * will return <code>false</code>
+ *
* @return the last node in the list
- * @throws NoSuchElementException if the list is empty
*/
FONode lastNode();
}
+
}
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FOText.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FOText.java?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FOText.java (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FOText.java Wed Apr 30 04:02:03 2008
@@ -114,7 +114,8 @@
private static final int IS_WORD_CHAR_MAYBE = 2;
/**
- * Creates a now FO text node.
+ * Creates a new FO text node.
+ *
* @param parent FONode that is the parent of this object
*/
public FOText(FONode parent) {
@@ -127,7 +128,7 @@
int length = end - start;
int calength = 0;
- char[] nca = null;
+ char[] nca;
if (ca != null) {
calength = ca.length;
nca = new char[calength + length];
@@ -223,6 +224,7 @@
/**
* This method is run as part of the ancestor Block's flushText(), to
* create xref pointers to the previous FOText objects within the same Block
+ * @param ancestorBlock the ancestor fo:block
*/
protected void createBlockPointers(Block ancestorBlock) {
this.ancestorBlock = ancestorBlock;
@@ -236,7 +238,6 @@
prevFOTextThisBlock = null;
}
}
- return;
}
/**
@@ -410,7 +411,7 @@
* depending on whether the character should be considered part of a word
* or not.
*/
- public static int isWordChar(char inputChar) {
+ private static int isWordChar(char inputChar) {
switch (Character.getType(inputChar)) {
case Character.COMBINING_SPACING_MARK:
return IS_WORD_CHAR_TRUE;
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FObj.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FObj.java?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FObj.java (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FObj.java Wed Apr 30 04:02:03 2008
@@ -39,11 +39,12 @@
/**
* Base class for representation of formatting objects and their processing.
+ * All standard formatting object classes extend this class.
*/
public abstract class FObj extends FONode implements Constants {
/** the list of property makers */
- private static PropertyMaker[] propertyListTable
+ private static final PropertyMaker[] propertyListTable
= FOPropertyMapping.getGenericMappings();
/**
@@ -71,7 +72,6 @@
/**
* Create a new formatting object.
- * All formatting object classes extend this class.
*
* @param parent the parent node
*/
@@ -92,9 +92,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public FONode clone(FONode parent, boolean removeChildren)
throws FOPException {
FObj fobj = (FObj) super.clone(parent, removeChildren);
@@ -113,9 +111,7 @@
return propertyListTable[propId];
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void processNode(String elementName, Locator locator,
Attributes attlist, PropertyList pList)
throws FOPException {
@@ -182,15 +178,13 @@
* Returns Out Of Line FO Descendant indicator.
* @return true if Out of Line FO or Out Of Line descendant, false otherwise
*/
- public boolean getIsOutOfLineFODescendant() {
+ boolean getIsOutOfLineFODescendant() {
return isOutOfLineFODescendant;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc}*/
protected void addChildNode(FONode child) throws FOPException {
- if (canHaveMarkers() && child.getNameId() == FO_MARKER) {
+ if (child.getNameId() == FO_MARKER) {
addMarker((Marker) child);
} else {
ExtensionAttachment attachment = child.getExtensionAttachment();
@@ -318,7 +312,7 @@
* any areas (see addMarker()).
* @param node the node that was removed
*/
- protected void notifyChildRemoval(FONode node) {
+ void notifyChildRemoval(FONode node) {
//nop
}
@@ -464,7 +458,7 @@
|| lName.equals("page-number-citation-last")
|| lName.equals("basic-link")
|| (lName.equals("multi-toggle")
- && (getNameId() == FO_MULTI_CASE
+ && (getNameId() == FO_MULTI_CASE
|| findAncestor(FO_MULTI_CASE) > 0))
|| (lName.equals("footnote")
&& !isOutOfLineFODescendant)
@@ -491,7 +485,7 @@
* @param lName local name (i.e., no prefix) of incoming node
* @return true if a member, false if not
*/
- protected boolean isNeutralItem(String nsURI, String lName) {
+ boolean isNeutralItem(String nsURI, String lName) {
return (FO_URI.equals(nsURI)
&& (lName.equals("multi-switch")
|| lName.equals("multi-properties")
@@ -546,7 +540,7 @@
*
* @param attachment the attachment to add.
*/
- public void addExtensionAttachment(ExtensionAttachment attachment) {
+ void addExtensionAttachment(ExtensionAttachment attachment) {
if (attachment == null) {
throw new NullPointerException(
"Parameter attachment must not be null");
@@ -611,27 +605,23 @@
private static final int F_REMOVE_ALLOWED = 2;
private FONode currentNode;
- private FObj parentNode;
+ private final FObj parentNode;
private int currentIndex;
private int flags = F_NONE_ALLOWED;
- protected FObjIterator(FObj parent) {
+ FObjIterator(FObj parent) {
this.parentNode = parent;
this.currentNode = parent.firstChild;
this.currentIndex = 0;
this.flags = F_NONE_ALLOWED;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public FObj parentNode() {
return parentNode;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Object next() {
if (currentNode != null) {
if (currentIndex != 0) {
@@ -650,9 +640,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public Object previous() {
if (currentNode.siblings != null
&& currentNode.siblings[0] != null) {
@@ -665,9 +653,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void set(Object o) {
if ((flags & F_SET_ALLOWED) == F_SET_ALLOWED) {
FONode newNode = (FONode) o;
@@ -685,9 +671,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void add(Object o) {
FONode newNode = (FONode) o;
if (currentIndex == -1) {
@@ -707,9 +691,7 @@
flags &= F_NONE_ALLOWED;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasNext() {
return (currentNode != null)
&& ((currentIndex == 0)
@@ -717,32 +699,24 @@
&& currentNode.siblings[1] != null));
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean hasPrevious() {
return (currentIndex != 0)
|| (currentNode.siblings != null
&& currentNode.siblings[0] != null);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int nextIndex() {
return currentIndex + 1;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int previousIndex() {
return currentIndex - 1;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void remove() {
if ((flags & F_REMOVE_ALLOWED) == F_REMOVE_ALLOWED) {
parentNode.removeChild(currentNode);
@@ -762,9 +736,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public FONode lastNode() {
while (currentNode != null
&& currentNode.siblings != null
@@ -775,28 +747,21 @@
return currentNode;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public FONode firstNode() {
currentNode = parentNode.firstChild;
currentIndex = 0;
return currentNode;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public FONode nextNode() {
return (FONode) next();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public FONode previousNode() {
return (FONode) previous();
}
}
-
}
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FObjMixed.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FObjMixed.java?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FObjMixed.java (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/FObjMixed.java Wed Apr 30 04:02:03 2008
@@ -24,23 +24,25 @@
import org.apache.fop.apps.FOPException;
/**
- * Base class for representation of mixed content formatting objects
- * (i.e., those that can contain both child FO's and text nodes/PCDATA).
- * It should not be instantiated directly.
+ * Abstract base class for representation of mixed content formatting objects
+ * (= those that can contain both child {@link FONode}s and <code>#PCDATA</code>).
*/
public abstract class FObjMixed extends FObj {
- /** Represents accumulated, pending FO text. See flushText(). */
+ /** Represents accumulated, pending FO text. See {@link #flushText()}. */
protected FOText ft = null;
/** Used for white-space handling; start CharIterator at node ... */
protected FONode currentTextNode;
- /** Used in creating pointers between subsequent FOText nodes
- * in the same Block (for handling text-transform) */
+ /** Used in creating pointers between subsequent {@link FOText} nodes
+ * in the same {@link org.apache.fop.fo.flow.Block}
+ * (for handling text-transform) */
protected FOText lastFOTextProcessed = null;
/**
+ * Base constructor
+ *
* @param parent FONode that is the parent of this object
*/
protected FObjMixed(FONode parent) {
@@ -75,8 +77,9 @@
/**
* Handles white-space for the node that is passed in,
* starting at its current text-node
- * (used by RetrieveMarker to trigger 'end-of-node' white-space
- * handling)
+ * (used by {@link org.apache.fop.fo.flow.RetrieveMarker}
+ * to trigger 'end-of-node' white-space handling)
+ *
* @param fobj the node for which to handle white-space
*/
protected static void handleWhiteSpaceFor(FObjMixed fobj) {
@@ -86,8 +89,8 @@
/**
* Adds accumulated text as one FOText instance, unless
- * the one instance's char array contains more than
- * Short.MAX_VALUE characters. In the latter case the
+ * the one instance's <code>char</code> array contains more than
+ * <code>Short.MAX_VALUE</code> characters. In the latter case the
* instance is split up into more manageable chunks.
*
* @throws FOPException if there is a problem during processing
@@ -145,9 +148,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void addChildNode(FONode child) throws FOPException {
flushText();
if (!inMarker()) {
@@ -166,6 +167,8 @@
}
/**
+ * Returns a {@link CharIterator} over this FO's character content
+ *
* @return iterator for this object
*/
public CharIterator charIterator() {
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/XMLObj.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/XMLObj.java?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/XMLObj.java (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/XMLObj.java Wed Apr 30 04:02:03 2008
@@ -54,7 +54,9 @@
protected String name;
/**
- * @param parent the parent formatting object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public XMLObj(FONode parent) {
super(parent);
@@ -62,7 +64,7 @@
/**
* {@inheritDoc}
- * here, blocks XSL FO's from having non-FO parents.
+ * <br>Here, blocks XSL-FO's from having non-FO parents.
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -71,9 +73,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void processNode(String elementName, Locator locator,
Attributes attlist, PropertyList propertyList) throws FOPException {
setLocator(locator);
@@ -90,6 +90,7 @@
/**
* Returns the dimensions of the generated area in pts.
+ *
* @param view Point2D instance to receive the dimensions
* @return the requested dimensions in pts.
*/
@@ -99,6 +100,7 @@
/**
* Retrieve the intrinsic alignment-adjust of the child element.
+ *
* @return the intrinsic alignment-adjust.
*/
public Length getIntrinsicAlignmentAdjust() {
@@ -150,6 +152,7 @@
/**
* Add the top-level element to the DOM document
+ *
* @param doc DOM document
* @param svgRoot non-XSL-FO element to be added as the root of this document
*/
@@ -160,6 +163,7 @@
/**
* Create an empty DOM document
+ *
* @return DOM document
*/
public Document createBasicDocument() {
@@ -187,9 +191,7 @@
return doc;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void addChildNode(FONode child) {
if (child instanceof XMLObj) {
((XMLObj)child).addElement(doc, element);
@@ -203,6 +205,7 @@
/**
* Add parsed characters to this object
+ *
* @param data array of characters contaning the text to add
* @param start starting array element to add
* @param length number of characters from the array to add
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/XMLWhiteSpaceHandler.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/XMLWhiteSpaceHandler.java?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/XMLWhiteSpaceHandler.java (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/XMLWhiteSpaceHandler.java Wed Apr 30 04:02:03 2008
@@ -220,8 +220,6 @@
* firstTextNode (when a nested FO is encountered)
* @param fo the FO for which to handle white-space
* @param firstTextNode the node at which to start
- * @param nextChild the child-node that will be added to the list after
- * the last text-node
*/
public void handleWhiteSpace(FObjMixed fo, FONode firstTextNode) {
handleWhiteSpace(fo, firstTextNode, null);
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractGraphics.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractGraphics.java?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractGraphics.java (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractGraphics.java Wed Apr 30 04:02:03 2008
@@ -26,15 +26,18 @@
import org.apache.fop.fo.GraphicsProperties;
import org.apache.fop.fo.PropertyList;
import org.apache.fop.fo.properties.CommonBorderPaddingBackground;
+import org.apache.fop.fo.properties.KeepProperty;
import org.apache.fop.fo.properties.LengthRangeProperty;
import org.apache.fop.fo.properties.SpaceProperty;
/**
- * Common base class for instream-foreign-object and external-graphics
- * flow formatting objects.
+ * Common base class for the <a href="http://www.w3.org/TR/xsl/#fo_instream-foreign-object">
+ * <code>fo:instream-foreign-object</code></a>
+ * and <a href="http://www.w3.org/TR/xsl/#fo_external-graphic">
+ * <code>fo:external-graphic</code></a> flow formatting objects.
*/
public abstract class AbstractGraphics extends FObj implements GraphicsProperties {
-
+
// The value of properties relevant for fo:instream-foreign-object
// and external-graphics.
private CommonBorderPaddingBackground commonBorderPaddingBackground;
@@ -50,6 +53,8 @@
private Length height;
private String id;
private LengthRangeProperty inlineProgressionDimension;
+ private KeepProperty keepWithNext;
+ private KeepProperty keepWithPrevious;
private SpaceProperty lineHeight;
private int overflow;
private int scaling;
@@ -61,8 +66,6 @@
// private CommonMarginInline commonMarginInline;
// private CommonRelativePosition commonRelativePosition;
// private String contentType;
- // private KeepProperty keepWithNext;
- // private KeepProperty keepWithPrevious;
// private int scalingMethod;
// End of property values
@@ -77,9 +80,7 @@
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps();
alignmentAdjust = pList.get(PR_ALIGNMENT_ADJUST).getLength();
@@ -94,6 +95,8 @@
height = pList.get(PR_HEIGHT).getLength();
id = pList.get(PR_ID).getString();
inlineProgressionDimension = pList.get(PR_INLINE_PROGRESSION_DIMENSION).getLengthRange();
+ keepWithNext = pList.get(PR_KEEP_WITH_NEXT).getKeep();
+ keepWithPrevious = pList.get(PR_KEEP_WITH_PREVIOUS).getKeep();
lineHeight = pList.get(PR_LINE_HEIGHT).getSpace();
overflow = pList.get(PR_OVERFLOW).getEnum();
scaling = pList.get(PR_SCALING).getEnum();
@@ -108,60 +111,52 @@
return id;
}
- /**
- * @return the Common Border, Padding, and Background Properties.
- */
+ /** @return the {@link CommonBorderPaddingBackground} */
public CommonBorderPaddingBackground getCommonBorderPaddingBackground() {
return commonBorderPaddingBackground;
}
- /**
- * @return the "line-height" property.
- */
+ /** @return the "line-height" property */
public SpaceProperty getLineHeight() {
return lineHeight;
}
- /** {@inheritDoc} */
+ /** @return the "inline-progression-dimension" property */
public LengthRangeProperty getInlineProgressionDimension() {
return inlineProgressionDimension;
}
- /** {@inheritDoc} */
+ /** @return the "block-progression-dimension" property */
public LengthRangeProperty getBlockProgressionDimension() {
return blockProgressionDimension;
}
- /**
- * @return the "height" property.
- */
+ /** @return the "height" property */
public Length getHeight() {
return height;
}
- /**
- * @return the "width" property.
- */
+ /** @return the "width" property */
public Length getWidth() {
return width;
}
- /** {@inheritDoc} */
+ /** @return the "content-height" property */
public Length getContentHeight() {
return contentHeight;
}
- /** {@inheritDoc} */
+ /** @return the "content-width" property */
public Length getContentWidth() {
return contentWidth;
}
- /** {@inheritDoc} */
+ /** @return the "scaling" property */
public int getScaling() {
return scaling;
}
- /** {@inheritDoc} */
+ /** @return the "overflow" property */
public int getOverflow() {
return overflow;
}
@@ -176,9 +171,7 @@
return textAlign;
}
- /**
- * @return the "alignment-adjust" property
- */
+ /** @return the "alignment-adjust" property */
public Length getAlignmentAdjust() {
if (alignmentAdjust.getEnum() == EN_AUTO) {
final Length intrinsicAlignmentAdjust = this.getIntrinsicAlignmentAdjust();
@@ -188,40 +181,38 @@
}
return alignmentAdjust;
}
-
- /**
- * @return the "alignment-baseline" property
- */
+
+ /** @return the "alignment-baseline" property */
public int getAlignmentBaseline() {
return alignmentBaseline;
}
-
- /**
- * @return the "baseline-shift" property
- */
+
+ /** @return the "baseline-shift" property */
public Length getBaselineShift() {
return baselineShift;
}
-
- /**
- * @return the "dominant-baseline" property
- */
+
+ /** @return the "dominant-baseline" property */
public int getDominantBaseline() {
return dominantBaseline;
}
-
- /**
- * @return the graphics intrinsic width in millipoints
- */
+
+ /** @return the "keep-with-next" property */
+ public KeepProperty getKeepWithNext() {
+ return keepWithNext;
+ }
+
+ /** @return the "keep-with-previous" property */
+ public KeepProperty getKeepWithPrevious() {
+ return keepWithPrevious;
+ }
+
+ /** @return the graphic's intrinsic width in millipoints */
public abstract int getIntrinsicWidth();
- /**
- * @return the graphics intrinsic height in millipoints
- */
+ /** @return the graphic's intrinsic height in millipoints */
public abstract int getIntrinsicHeight();
- /**
- * @return the graphics intrinsic alignment-adjust
- */
+ /** @return the graphic's intrinsic alignment-adjust */
public abstract Length getIntrinsicAlignmentAdjust();
}
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractListItemPart.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractListItemPart.java?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractListItemPart.java (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractListItemPart.java Wed Apr 30 04:02:03 2008
@@ -29,7 +29,9 @@
import org.apache.fop.fo.properties.KeepProperty;
/**
- * Common superclass for list-item-label and list-item-body.
+ * Common superclass for <a href="http://www.w3.org/TR/xsl/#fo_list-item-label">
+ * <code>fo:list-item-label</code></a> and <a href="http://www.w3.org/TR/xsl/#fo_list-item-body">
+ * <code>fo:list-item-body</code></a>.
*/
public abstract class AbstractListItemPart extends FObj {
// The value of properties relevant for fo:list-item-label and fo:list-item-body.
@@ -42,15 +44,15 @@
private boolean blockItemFound = false;
/**
- * @param parent FONode that is the parent of this object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public AbstractListItemPart(FONode parent) {
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
keepTogether = pList.get(PR_KEEP_TOGETHER).getKeep();
@@ -58,7 +60,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: marker* (%block;)+
+ * <br>XSL Content Model: marker* (%block;)+
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -75,9 +77,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void endOfNode() throws FOPException {
if (!this.blockItemFound) {
String contentModel = "marker* (%block;)+";
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractPageNumberCitation.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractPageNumberCitation.java?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractPageNumberCitation.java (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/AbstractPageNumberCitation.java Wed Apr 30 04:02:03 2008
@@ -36,7 +36,10 @@
import org.apache.fop.fo.properties.SpaceProperty;
/**
- * Base class modelling the fo:page-number-citation object.
+ * Common base class for the <a href="http://www.w3.org/TR/xsl/#fo_page-number-citation">
+ * <code>fo:page-number-citation</code></a> and
+ * <a href="http://www.w3.org/TR/xsl/#fo_page-number-citation-last">
+ * <code>fo:page-number-citation-last</code></a> objects.
*/
public abstract class AbstractPageNumberCitation extends FObj {
@@ -73,15 +76,15 @@
private Color color;
/**
- * @param parent FONode that is the parent of this object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public AbstractPageNumberCitation(FONode parent) {
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps();
@@ -110,7 +113,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: empty
+ * <br>XSL Content Model: empty
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -119,7 +122,7 @@
}
}
- /** @return the Common Font Properties. */
+ /** @return the {@link CommonFont} */
public CommonFont getCommonFont() {
return commonFont;
}
@@ -134,42 +137,32 @@
return textDecoration;
}
- /**
- * @return the "alignment-adjust" property
- */
+ /** @return the "alignment-adjust" property */
public Length getAlignmentAdjust() {
return alignmentAdjust;
}
- /**
- * @return the "alignment-baseline" property
- */
+ /** @return the "alignment-baseline" property */
public int getAlignmentBaseline() {
return alignmentBaseline;
}
- /**
- * @return the "baseline-shift" property
- */
+ /** @return the "baseline-shift" property */
public Length getBaselineShift() {
return baselineShift;
}
- /**
- * @return the "dominant-baseline" property
- */
+ /** @return the "dominant-baseline" property */
public int getDominantBaseline() {
return dominantBaseline;
}
- /** @return the Common Border, Padding, and Background Properties. */
+ /** @return the {@link CommonBorderPaddingBackground} */
public CommonBorderPaddingBackground getCommonBorderPaddingBackground() {
return commonBorderPaddingBackground;
}
- /**
- * @return the "line-height" property
- */
+ /** @return the "line-height" property */
public SpaceProperty getLineHeight() {
return lineHeight;
}
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/BidiOverride.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/BidiOverride.java?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/BidiOverride.java (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/BidiOverride.java Wed Apr 30 04:02:03 2008
@@ -29,7 +29,8 @@
import org.apache.fop.fo.properties.SpaceProperty;
/**
- * Class modelling the fo:bidi-override object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_bidi-override">
+ * <code>fo:bidi-override</code></a> object.
*/
public class BidiOverride extends FObjMixed {
@@ -52,6 +53,8 @@
// End of property values
/**
+ * Base constructor
+ *
* @param parent FONode that is the parent of this object
*/
public BidiOverride(FONode parent) {
@@ -77,9 +80,7 @@
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
// prDirection = pList.get(PR_DIRECTION);
// prLetterSpacing = pList.get(PR_LETTER_SPACING);
@@ -90,11 +91,11 @@
/**
* {@inheritDoc}
- * XSL Content Model: marker* (#PCDATA|%inline;|%block;)*
- * Additionally: "An fo:bidi-override that is a descendant of an fo:leader
+ * <br>XSL Content Model: marker* (#PCDATA|%inline;|%block;)*
+ * <br><i>Additionally: "An fo:bidi-override that is a descendant of an fo:leader
* or of the fo:inline child of an fo:footnote may not have block-level
* children, unless it has a nearer ancestor that is an
- * fo:inline-container."
+ * fo:inline-container."</i>
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -115,9 +116,7 @@
}
}
- /**
- * @return the "line-height" property.
- */
+ /** @return the "line-height" property */
public SpaceProperty getLineHeight() {
return lineHeight;
}
@@ -129,6 +128,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_BIDI_OVERRIDE}
*/
public int getNameId() {
return FO_BIDI_OVERRIDE;
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Block.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Block.java?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Block.java (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Block.java Wed Apr 30 04:02:03 2008
@@ -41,7 +41,8 @@
import org.apache.fop.fo.properties.SpaceProperty;
/**
- * Class modelling the fo:block object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_block">
+ * <code>fo:block object</code></a>.
*/
public class Block extends FObjMixed {
@@ -87,6 +88,8 @@
// End of property values
/**
+ * Base constructor
+ *
* @param parent FONode that is the parent of this object
*
*/
@@ -94,9 +97,7 @@
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps();
@@ -130,46 +131,35 @@
wrapOption = pList.get(PR_WRAP_OPTION).getEnum();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void startOfNode() throws FOPException {
super.startOfNode();
getFOEventHandler().startBlock(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void endOfNode() throws FOPException {
super.endOfNode();
getFOEventHandler().endBlock(this);
}
- /**
- * @return the Common Margin Properties-Block.
- */
+ /** @return the {@link CommonMarginBlock} */
public CommonMarginBlock getCommonMarginBlock() {
return commonMarginBlock;
}
- /**
- * @return the Common Border, Padding, and Background Properties.
- */
+ /** @return the {@link CommonBorderPaddingBackground} */
public CommonBorderPaddingBackground getCommonBorderPaddingBackground() {
return commonBorderPaddingBackground;
}
/**
- * @return the Common Font Properties.
- */
+ * @return the {@link CommonFont} */
public CommonFont getCommonFont() {
return commonFont;
}
- /**
- * @return the Common Hyphenation Properties.
- */
+ /** @return the {@link CommonHyphenation} */
public CommonHyphenation getCommonHyphenation() {
return commonHyphenation;
}
@@ -219,79 +209,63 @@
return lineStackingStrategy;
}
- /**
- * @return the "color" property.
- */
+ /** @return the "color" property */
public Color getColor() {
return color;
}
- /**
- * @return the "line-height" property.
- */
+ /** @return the "line-height" property */
public SpaceProperty getLineHeight() {
return lineHeight;
}
- /**
- * @return the "span" property.
- */
+ /** @return the "span" property */
public int getSpan() {
return this.span;
}
- /**
- * @return the "text-align" property.
- */
+ /** @return the "text-align" property */
public int getTextAlign() {
return textAlign;
}
- /**
- * @return the "text-align-last" property.
- */
+ /** @return the "text-align-last" property */
public int getTextAlignLast() {
return textAlignLast;
}
- /**
- * @return the "text-indent" property.
- */
+ /** @return the "text-indent" property */
public Length getTextIndent() {
return textIndent;
}
- /**
- * @return the "last-line-end-indent" property.
- */
+ /** @return the "last-line-end-indent" property */
public Length getLastLineEndIndent() {
return lastLineEndIndent;
}
- /**
- * @return the "wrap-option" property.
- */
+ /** @return the "wrap-option" property */
public int getWrapOption() {
return wrapOption;
}
/**
* {@inheritDoc}
- * XSL Content Model: marker* initial-property-set? (#PCDATA|%inline;|%block;)*
- * Additionally: "An fo:bidi-override that is a descendant of an fo:leader
+ * <br>XSL Content Model: marker* initial-property-set? (#PCDATA|%inline;|%block;)*
+ * <br><i>Additionally: "An fo:bidi-override that is a descendant of an fo:leader
* or of the fo:inline child of an fo:footnote may not have block-level
* children, unless it has a nearer ancestor that is an
- * fo:inline-container."
+ * fo:inline-container."</i>
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
if (FO_URI.equals(nsURI)) {
- if (localName.equals("marker")) {
+ if ("marker".equals(localName)) {
if (blockOrInlineItemFound || initialPropertySetFound) {
nodesOutOfOrderError(loc, "fo:marker",
"initial-property-set? (#PCDATA|%inline;|%block;)");
}
- } else if (localName.equals("initial-property-set")) {
+ } else if ("initial-property-set".equals(localName)) {
if (initialPropertySetFound) {
tooManyNodesError(loc, "fo:initial-property-set");
} else if (blockOrInlineItemFound) {
@@ -308,57 +282,37 @@
}
}
- /**
- * Accessor for the linefeed-treatment property
- *
- * @return the enum value of linefeed-treatment
- */
+ /** @return the "linefeed-treatment" property */
public int getLinefeedTreatment() {
return linefeedTreatment;
}
- /**
- * Accessor for the white-space-treatment property
- *
- * @return the enum value of white-space-treatment
- */
+ /** @return the "white-space-treatment" property */
public int getWhitespaceTreatment() {
return whiteSpaceTreatment;
}
- /**
- * Accessor for the white-space-collapse property
- *
- * @return the enum value of white-space-collapse
- */
+ /** @return the "white-space-collapse" property */
public int getWhitespaceCollapse() {
return whiteSpaceCollapse;
}
- /**
- * @return Returns the commonRelativePosition.
- */
+ /** @return the {@link CommonRelativePosition} */
public CommonRelativePosition getCommonRelativePosition() {
return this.commonRelativePosition;
}
- /**
- * @return Returns the hyphenationKeep.
- */
+ /** @return the "hyphenation-keep" property */
public int getHyphenationKeep() {
return this.hyphenationKeep;
}
- /**
- * @return Returns the intrusionDisplace.
- */
+ /** @return the "intrusion-displace" property */
public int getIntrusionDisplace() {
return this.intrusionDisplace;
}
- /**
- * @return Returns the lineHeightShiftAdjustment.
- */
+ /** @return the "line-height-shift-adjustment" property */
public int getLineHeightShiftAdjustment() {
return this.lineHeightShiftAdjustment;
}
@@ -373,9 +327,10 @@
return "block";
}
- /**
- * {@inheritDoc}
- */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_BLOCK}
+ */
public int getNameId() {
return FO_BLOCK;
}
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Character.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Character.java?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Character.java (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/Character.java Wed Apr 30 04:02:03 2008
@@ -35,22 +35,13 @@
import org.apache.fop.fo.properties.CommonFont;
import org.apache.fop.fo.properties.CommonHyphenation;
import org.apache.fop.fo.properties.CommonTextDecoration;
+import org.apache.fop.fo.properties.KeepProperty;
import org.apache.fop.fo.properties.Property;
import org.apache.fop.fo.properties.SpaceProperty;
/**
- * Class modelling the fo:character object.
- * Its use is defined by the spec:
- * "The fo:character flow object represents a character that is mapped to
- * a glyph for presentation. It is an atomic unit to the formatter.
- * When the result tree is interpreted as a tree of formatting objects,
- * a character in the result tree is treated as if it were an empty
- * element of type fo:character with a character attribute
- * equal to the Unicode representation of the character.
- * The semantics of an "auto" value for character properties, which is
- * typically their initial value, are based on the Unicode codepoint.
- * Overrides may be specified in an implementation-specific manner." (6.6.3)
- *
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_character">
+ * <code>fo:character</code></a> object.
*/
public class Character extends FObj {
// The value of properties relevant for fo:character.
@@ -63,8 +54,8 @@
private char character;
private Color color;
private int dominantBaseline;
- // private ToBeImplementedProperty glyphOrientationHorizontal;
- // private ToBeImplementedProperty glyphOrientationVertical;
+ private KeepProperty keepWithNext;
+ private KeepProperty keepWithPrevious;
private Property letterSpacing;
private SpaceProperty lineHeight;
/** Holds the text decoration values. May be null */
@@ -75,11 +66,11 @@
// private CommonAural commonAural;
// private CommonMarginInline commonMarginInline;
// private CommonRelativePosition commonRelativePosition;
+ // private ToBeImplementedProperty glyphOrientationHorizontal;
+ // private ToBeImplementedProperty glyphOrientationVertical;
// private int treatAsWordSpace;
// private Length textDepth;
// private Length textAltitude;
- // private KeepProperty keepWithNext;
- // private KeepProperty keepWithPrevious;
// private int scoreSpaces;
// private int suppressAtLineBreak;
// private int textTransform;
@@ -92,15 +83,13 @@
public static final int DOESNOT_FIT = 1;
/**
- * @param parent FONode that is the parent of this object
+ * @param parent {@link FONode} that is the parent of this object
*/
public Character(FONode parent) {
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps();
@@ -113,18 +102,15 @@
character = pList.get(PR_CHARACTER).getCharacter();
color = pList.get(PR_COLOR).getColor(getUserAgent());
dominantBaseline = pList.get(PR_DOMINANT_BASELINE).getEnum();
- // glyphOrientationHorizontal = pList.get(PR_GLYPH_ORIENTATION_HORIZONTAL);
- // glyphOrientationVertical = pList.get(PR_GLYPH_ORIENTATION_VERTICAL);
+ keepWithNext = pList.get(PR_KEEP_WITH_NEXT).getKeep();
+ keepWithPrevious = pList.get(PR_KEEP_WITH_PREVIOUS).getKeep();
letterSpacing = pList.get(PR_LETTER_SPACING);
lineHeight = pList.get(PR_LINE_HEIGHT).getSpace();
textDecoration = pList.getTextDecorationProps();
- // textShadow = pList.get(PR_TEXT_SHADOW);
wordSpacing = pList.get(PR_WORD_SPACING);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void startOfNode() throws FOPException {
super.startOfNode();
getFOEventHandler().character(this);
@@ -132,7 +118,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: empty
+ * <br>XSL Content Model: empty
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -141,86 +127,62 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public CharIterator charIterator() {
return new FOCharIterator(this);
}
- /**
- * @return the Common Border, Padding, and Background Properties.
- */
+ /** @return the Common Border, Padding, and Background Properties */
public CommonBorderPaddingBackground getCommonBorderPaddingBackground() {
return commonBorderPaddingBackground;
}
- /**
- * @return the Common Font Properties.
- */
+ /** @return the Common Font Properties */
public CommonFont getCommonFont() {
return commonFont;
}
- /**
- * @return the Common Hyphenation Properties.
- */
+ /** @return the Common Hyphenation Properties */
public CommonHyphenation getCommonHyphenation() {
return commonHyphenation;
}
- /**
- * @return the "character" property.
- */
+ /** @return the "character" property */
public char getCharacter() {
return character;
}
- /**
- * @return the "color" property.
- */
+ /** @return the "color" property */
public Color getColor() {
return color;
}
- /**
- * @return the "alignment-adjust" property
- */
+ /** @return the "alignment-adjust" property */
public Length getAlignmentAdjust() {
return alignmentAdjust;
}
- /**
- * @return the "alignment-baseline" property
- */
+ /** @return the "alignment-baseline" property */
public int getAlignmentBaseline() {
return alignmentBaseline;
}
- /**
- * @return the "baseline-shift" property
- */
+ /** @return the "baseline-shift" property */
public Length getBaselineShift() {
return baselineShift;
}
- /**
- * @return the "dominant-baseline" property
- */
+ /** @return the "dominant-baseline" property */
public int getDominantBaseline() {
return dominantBaseline;
}
- /**
- * @return the "letter-spacing" property.
- */
+ /** @return the "letter-spacing" property */
public Property getLetterSpacing() {
return letterSpacing;
}
- /**
- * @return the "line-height" property.
- */
+ /** @return the "line-height" property */
public SpaceProperty getLineHeight() {
return lineHeight;
}
@@ -230,13 +192,21 @@
return textDecoration;
}
- /**
- * @return the "word-spacing" property.
- */
+ /** @return the "word-spacing" property */
public Property getWordSpacing() {
return wordSpacing;
}
+ /** @return the "keep-with-next" property */
+ public KeepProperty getKeepWithNext() {
+ return keepWithNext;
+ }
+
+ /** @return the "keep-with-previous" property */
+ public KeepProperty getKeepWithPrevious() {
+ return keepWithPrevious;
+ }
+
/** {@inheritDoc} */
public String getLocalName() {
return "character";
@@ -244,6 +214,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_CHARACTER}
*/
public int getNameId() {
return FO_CHARACTER;
Modified: xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/ExternalGraphic.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/ExternalGraphic.java?rev=652318&r1=652317&r2=652318&view=diff
==============================================================================
--- xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/ExternalGraphic.java (original)
+++ xmlgraphics/fop/branches/Temp_AFPGOCAResources/src/java/org/apache/fop/fo/flow/ExternalGraphic.java Wed Apr 30 04:02:03 2008
@@ -58,7 +58,8 @@
private Length intrinsicAlignmentAdjust;
/**
- * Create a new External graphic node.
+ * Create a new ExternalGraphic node that is a child
+ * of the given {@link FONode}.
*
* @param parent the parent of this node
*/
@@ -134,7 +135,10 @@
return "external-graphic";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_EXTERNAL_GRAPHIC}
+ */
public int getNameId() {
return FO_EXTERNAL_GRAPHIC;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: fop-commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: fop-commits-help@xmlgraphics.apache.org