diff options
Diffstat (limited to 'src/java/org/apache/fop/fo')
146 files changed, 640 insertions, 805 deletions
diff --git a/src/java/org/apache/fop/fo/CharIterator.java b/src/java/org/apache/fop/fo/CharIterator.java index fae2743f3..1d6b312a7 100644 --- a/src/java/org/apache/fop/fo/CharIterator.java +++ b/src/java/org/apache/fop/fo/CharIterator.java @@ -30,7 +30,7 @@ import java.util.NoSuchElementException; public abstract class CharIterator implements Iterator, Cloneable { /** - * @see java.util.Iterator#hasNext() + * {@inheritDoc} */ public abstract boolean hasNext(); @@ -42,14 +42,14 @@ public abstract class CharIterator implements Iterator, Cloneable { public abstract char nextChar() throws NoSuchElementException; /** - * @see java.util.Iterator#next() + * {@inheritDoc} */ public Object next() throws NoSuchElementException { return new Character(nextChar()); } /** - * @see java.util.Iterator#remove() + * {@inheritDoc} */ public void remove() { throw new UnsupportedOperationException(); @@ -65,7 +65,7 @@ public abstract class CharIterator implements Iterator, Cloneable { } /** - * @see java.lang.Object#clone() + * {@inheritDoc} */ public Object clone() { try { diff --git a/src/java/org/apache/fop/fo/FOElementMapping.java b/src/java/org/apache/fop/fo/FOElementMapping.java index c3b99f6e4..f316e5a8d 100644 --- a/src/java/org/apache/fop/fo/FOElementMapping.java +++ b/src/java/org/apache/fop/fo/FOElementMapping.java @@ -138,12 +138,12 @@ public class FOElementMapping extends ElementMapping { } } - /** @see org.apache.fop.fo.ElementMapping#getStandardPrefix() */ + /** {@inheritDoc} */ public String getStandardPrefix() { return "fo"; } - /** @see org.apache.fop.fo.ElementMapping#isAttributeProperty(org.apache.fop.util.QName) */ + /** {@inheritDoc} */ public boolean isAttributeProperty(QName attributeName) { return true; //All XSL-FO attributes are to be converted to properties. } @@ -513,4 +513,5 @@ public class FOElementMapping extends ElementMapping { return new org.apache.fop.fo.flow.RetrieveMarker(parent); } } + } diff --git a/src/java/org/apache/fop/fo/FONode.java b/src/java/org/apache/fop/fo/FONode.java index a90d564ec..848e06a65 100644 --- a/src/java/org/apache/fop/fo/FONode.java +++ b/src/java/org/apache/fop/fo/FONode.java @@ -91,7 +91,7 @@ public abstract class FONode implements Cloneable { /** * Perform a shallow cloning operation * - * @see java.lang.Object#clone() + * {@inheritDoc} * @return the cloned object */ protected Object clone() { @@ -103,6 +103,20 @@ public abstract class FONode implements Cloneable { } /** + * 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 + * <code>PropertyList</code>. + * + * @param propertyList the <code>PropertyList</code> + * @throws <code>FOPException</code> if there was an error when + * processing the <code>PropertyList</code> + */ + public void bind(PropertyList propertyList) throws FOPException { + //nop + } + + /** * Set the location information for this element * @param locator the org.xml.sax.Locator object */ diff --git a/src/java/org/apache/fop/fo/FOText.java b/src/java/org/apache/fop/fo/FOText.java index 2205c0170..b2baf58a7 100644 --- a/src/java/org/apache/fop/fo/FOText.java +++ b/src/java/org/apache/fop/fo/FOText.java @@ -122,7 +122,7 @@ public class FOText extends FONode { super(parent); } - /** @see org.apache.fop.fo.FONode */ + /** {@inheritDoc} */ protected void addCharacters(char[] data, int start, int end, PropertyList list, Locator locator) throws FOPException { @@ -142,14 +142,15 @@ public class FOText extends FONode { } /** - * @see org.apache.fop.fo.FONode#clone(FONode, boolean) + * {@inheritDoc} */ public FONode clone(FONode parent, boolean removeChildren) throws FOPException { FOText ft = (FOText) super.clone(parent, removeChildren); if (removeChildren) { //not really removing, but just make sure the char array - //pointed to is really a different one + //pointed to is really a different one, and reset any + //possible whitespace-handling effects if (ca != null) { ft.ca = new char[ca.length]; System.arraycopy(ca, 0, ft.ca, 0, ca.length); @@ -159,7 +160,7 @@ public class FOText extends FONode { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { commonFont = pList.getFontProps(); @@ -176,7 +177,7 @@ public class FOText extends FONode { baselineShift = pList.get(Constants.PR_BASELINE_SHIFT).getLength(); } - /** @see org.apache.fop.fo.FONode#endOfNode() */ + /** {@inheritDoc} */ protected void endOfNode() throws FOPException { textTransform(); getFOEventHandler().characters(ca, startIndex, endIndex); @@ -600,24 +601,24 @@ public class FOText extends FONode { return baselineShift; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(super.toString()); sb.append(" (").append(ca).append(")"); return sb.toString(); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return null; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return null; } - /** @see org.apache.fop.fo.FONode#gatherContextInfo() */ + /** {@inheritDoc} */ protected String gatherContextInfo() { if (getLocator() != null) { return super.gatherContextInfo(); diff --git a/src/java/org/apache/fop/fo/FOTreeBuilder.java b/src/java/org/apache/fop/fo/FOTreeBuilder.java index 1aa9ce3e2..c4ab4fdc8 100644 --- a/src/java/org/apache/fop/fo/FOTreeBuilder.java +++ b/src/java/org/apache/fop/fo/FOTreeBuilder.java @@ -117,8 +117,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for locator - * @see org.xml.sax.ContentHandler#setDocumentLocator(Locator) + * {@inheritDoc} */ public void setDocumentLocator(Locator locator) { this.locator = locator; @@ -130,8 +129,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for characters - * @see org.xml.sax.ContentHandler#characters(char[], int, int) + * {@inheritDoc} */ public void characters(char[] data, int start, int length) throws SAXException { @@ -139,8 +137,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for the start of the document - * @see org.xml.sax.ContentHandler#startDocument() + * {@inheritDoc} */ public void startDocument() throws SAXException { if (used) { @@ -159,8 +156,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for the end of the document - * @see org.xml.sax.ContentHandler#endDocument() + * {@inheritDoc} */ public void endDocument() throws SAXException { this.delegate.endDocument(); @@ -176,8 +172,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for the start of an element - * @see org.xml.sax.ContentHandler#startElement(String, String, String, Attributes) + * {@inheritDoc} */ public void startElement(String namespaceURI, String localName, String rawName, Attributes attlist) throws SAXException { @@ -186,8 +181,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for the end of an element - * @see org.xml.sax.ContentHandler#endElement(String, String, String) + * {@inheritDoc} */ public void endElement(String uri, String localName, String rawName) throws SAXException { @@ -214,17 +208,17 @@ public class FOTreeBuilder extends DefaultHandler { return elementMappingRegistry.findFOMaker(namespaceURI, localName, locator); } - /** @see org.xml.sax.ErrorHandler#warning(org.xml.sax.SAXParseException) */ + /** {@inheritDoc} */ public void warning(SAXParseException e) { log.warn(e.toString()); } - /** @see org.xml.sax.ErrorHandler#error(org.xml.sax.SAXParseException) */ + /** {@inheritDoc} */ public void error(SAXParseException e) { log.error(e.toString()); } - /** @see org.xml.sax.ErrorHandler#fatalError(org.xml.sax.SAXParseException) */ + /** {@inheritDoc} */ public void fatalError(SAXParseException e) throws SAXException { log.error(e.toString()); throw e; @@ -275,8 +269,7 @@ public class FOTreeBuilder extends DefaultHandler { private int nestedMarkerDepth = 0; /** - * SAX Handler for the start of an element - * @see org.xml.sax.ContentHandler#startElement(String, String, String, Attributes) + * {@inheritDoc} */ public void startElement(String namespaceURI, String localName, String rawName, Attributes attlist) throws SAXException { @@ -358,8 +351,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for the end of an element - * @see org.xml.sax.ContentHandler#endElement(String, String, String) + * {@inheritDoc} */ public void endElement(String uri, String localName, String rawName) throws SAXException { @@ -399,8 +391,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for characters - * @see org.xml.sax.ContentHandler#characters(char[], int, int) + * {@inheritDoc} */ public void characters(char[] data, int start, int length) throws FOPException { diff --git a/src/java/org/apache/fop/fo/FObj.java b/src/java/org/apache/fop/fo/FObj.java index 00fdc3c8b..71849bd72 100644 --- a/src/java/org/apache/fop/fo/FObj.java +++ b/src/java/org/apache/fop/fo/FObj.java @@ -91,7 +91,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see org.apache.fop.fo.FONode#clone(FONode, boolean) + * {@inheritDoc} */ public FONode clone(FONode parent, boolean removeChildren) throws FOPException { @@ -112,7 +112,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see org.apache.fop.fo.FONode#processNode + * {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) @@ -128,7 +128,7 @@ public abstract class FObj extends FONode implements Constants { /** * Create a default property list for this element. - * @see org.apache.fop.fo.FONode + * {@inheritDoc} */ protected PropertyList createPropertyList(PropertyList parent, FOEventHandler foEventHandler) throws FOPException { @@ -147,7 +147,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} * @throws FOPException FOP Exception */ protected void startOfNode() throws FOPException { @@ -203,7 +203,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { if (canHaveMarkers() && child.getNameId() == FO_MARKER) { @@ -242,7 +242,7 @@ public abstract class FObj extends FONode implements Constants { parent.addChildNode(child); } - /** @see org.apache.fop.fo.FONode#removeChild(org.apache.fop.fo.FONode) */ + /** {@inheritDoc} */ public void removeChild(FONode child) { FONode nextChild = null; if (child.siblings != null) { @@ -284,7 +284,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see org.apache.fop.fo.FONode#getChildNodes() + * {@inheritDoc} */ public FONodeIterator getChildNodes() { if (firstChild != null) { @@ -382,7 +382,7 @@ public abstract class FObj extends FONode implements Constants { return markers; } - /** @see org.apache.fop.fo.FONode#gatherContextInfo() */ + /** {@inheritDoc} */ protected String gatherContextInfo() { if (getLocator() != null) { return super.gatherContextInfo(); @@ -513,12 +513,12 @@ public abstract class FObj extends FONode implements Constants { return id != null && id.length() > 0; } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return FOElementMapping.URI; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return "fo"; } @@ -600,14 +600,14 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see FONodeIterator#parentNode() + * {@inheritDoc} */ public FObj parentNode() { return parentNode; } /** - * @see java.util.ListIterator#next() + * {@inheritDoc} */ public Object next() { if (currentNode != null) { @@ -628,7 +628,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see java.util.ListIterator#previous() + * {@inheritDoc} */ public Object previous() { if (currentNode.siblings != null @@ -643,7 +643,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see java.util.ListIterator#set(Object) + * {@inheritDoc} */ public void set(Object o) { if ((flags & F_SET_ALLOWED) == F_SET_ALLOWED) { @@ -663,7 +663,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see java.util.ListIterator#add(Object) + * {@inheritDoc} */ public void add(Object o) { FONode newNode = (FONode) o; @@ -685,7 +685,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see java.util.ListIterator#hasNext() + * {@inheritDoc} */ public boolean hasNext() { return (currentNode != null) @@ -695,7 +695,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see java.util.ListIterator#hasPrevious() + * {@inheritDoc} */ public boolean hasPrevious() { return (currentIndex != 0) @@ -704,21 +704,21 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see java.util.ListIterator#nextIndex() + * {@inheritDoc} */ public int nextIndex() { return currentIndex + 1; } /** - * @see java.util.ListIterator#previousIndex() + * {@inheritDoc} */ public int previousIndex() { return currentIndex - 1; } /** - * @see java.util.ListIterator#remove() + * {@inheritDoc} */ public void remove() { if ((flags & F_REMOVE_ALLOWED) == F_REMOVE_ALLOWED) { @@ -739,6 +739,9 @@ public abstract class FObj extends FONode implements Constants { } } + /** + * {@inheritDoc} + */ public FONode lastNode() { while (currentNode != null && currentNode.siblings != null @@ -749,16 +752,25 @@ public abstract class FObj extends FONode implements Constants { return currentNode; } + /** + * {@inheritDoc} + */ public FONode firstNode() { currentNode = parentNode.firstChild; currentIndex = 0; return currentNode; } + /** + * {@inheritDoc} + */ public FONode nextNode() { return (FONode) next(); } + /** + * {@inheritDoc} + */ public FONode previousNode() { return (FONode) previous(); } diff --git a/src/java/org/apache/fop/fo/FObjMixed.java b/src/java/org/apache/fop/fo/FObjMixed.java index 87f31216b..4360c7758 100644 --- a/src/java/org/apache/fop/fo/FObjMixed.java +++ b/src/java/org/apache/fop/fo/FObjMixed.java @@ -47,7 +47,7 @@ public abstract class FObjMixed extends FObj { super(parent); } - /** @see org.apache.fop.fo.FONode */ + /** {@inheritDoc} */ protected void addCharacters(char[] data, int start, int end, PropertyList pList, Locator locator) throws FOPException { @@ -61,7 +61,7 @@ public abstract class FObjMixed extends FObj { ft.addCharacters(data, start, end, null, null); } - /** @see org.apache.fop.fo.FONode#endOfNode() */ + /** {@inheritDoc} */ protected void endOfNode() throws FOPException { flushText(); if (!inMarker() @@ -146,7 +146,7 @@ public abstract class FObjMixed extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { flushText(); diff --git a/src/java/org/apache/fop/fo/NullCharIterator.java b/src/java/org/apache/fop/fo/NullCharIterator.java index 494d167fd..bb98b4a52 100644 --- a/src/java/org/apache/fop/fo/NullCharIterator.java +++ b/src/java/org/apache/fop/fo/NullCharIterator.java @@ -42,12 +42,12 @@ public class NullCharIterator extends CharIterator { //nop } - /** @see java.util.Iterator#hasNext() */ + /** {@inheritDoc} */ public boolean hasNext() { return false; } - /** @see org.apache.fop.fo.CharIterator#nextChar() */ + /** {@inheritDoc} */ public char nextChar() throws NoSuchElementException { throw new NoSuchElementException(); } diff --git a/src/java/org/apache/fop/fo/RecursiveCharIterator.java b/src/java/org/apache/fop/fo/RecursiveCharIterator.java index 4af014f12..22ece76f3 100644 --- a/src/java/org/apache/fop/fo/RecursiveCharIterator.java +++ b/src/java/org/apache/fop/fo/RecursiveCharIterator.java @@ -123,7 +123,7 @@ public class RecursiveCharIterator extends CharIterator { } /** - * @see org.apache.fop.fo.CharIterator#nextChar() + * {@inheritDoc} */ public char nextChar() throws NoSuchElementException { if (curCharIter != null) { @@ -134,7 +134,7 @@ public class RecursiveCharIterator extends CharIterator { } /** - * @see java.util.Iterator#remove + * {@inheritDoc} */ public void remove() { if (curCharIter != null) { diff --git a/src/java/org/apache/fop/fo/UnknownXMLObj.java b/src/java/org/apache/fop/fo/UnknownXMLObj.java index 406e869fc..487aed2fa 100644 --- a/src/java/org/apache/fop/fo/UnknownXMLObj.java +++ b/src/java/org/apache/fop/fo/UnknownXMLObj.java @@ -62,18 +62,18 @@ public class UnknownXMLObj extends XMLObj { this.namespace = space; } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return this.namespace; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return null; //We don't know that in this case. } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) { if (doc == null) { @@ -83,7 +83,7 @@ public class UnknownXMLObj extends XMLObj { } /** - * @see XMLObj#addCharacters + * {@inheritDoc} */ protected void addCharacters(char data[], int start, int length, PropertyList pList, Locator locator) { diff --git a/src/java/org/apache/fop/fo/XMLObj.java b/src/java/org/apache/fop/fo/XMLObj.java index f7d140732..0297bd483 100644 --- a/src/java/org/apache/fop/fo/XMLObj.java +++ b/src/java/org/apache/fop/fo/XMLObj.java @@ -60,7 +60,7 @@ public abstract class XMLObj extends FONode implements ObjectBuiltListener { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * here, blocks XSL FO's from having non-FO parents. */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -71,7 +71,7 @@ public abstract class XMLObj extends FONode implements ObjectBuiltListener { } /** - * @see org.apache.fop.fo.FONode#processNode + * {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList propertyList) throws FOPException { @@ -104,7 +104,7 @@ public abstract class XMLObj extends FONode implements ObjectBuiltListener { return null; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return name; } @@ -187,7 +187,7 @@ public abstract class XMLObj extends FONode implements ObjectBuiltListener { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) { if (child instanceof XMLObj) { @@ -215,7 +215,7 @@ public abstract class XMLObj extends FONode implements ObjectBuiltListener { element.appendChild(text); } - /** @see org.apache.fop.util.ContentHandlerFactory.ObjectBuiltListener */ + /** {@inheritDoc} */ public void notifyObjectBuilt(Object obj) { this.doc = (Document)obj; } diff --git a/src/java/org/apache/fop/fo/XMLWhiteSpaceHandler.java b/src/java/org/apache/fop/fo/XMLWhiteSpaceHandler.java index e0e5898e3..dc0cf3b48 100644 --- a/src/java/org/apache/fop/fo/XMLWhiteSpaceHandler.java +++ b/src/java/org/apache/fop/fo/XMLWhiteSpaceHandler.java @@ -22,7 +22,6 @@ package org.apache.fop.fo; import java.util.List; import java.util.Stack; import org.apache.fop.fo.flow.Block; -import org.apache.fop.fo.flow.Character; import org.apache.fop.util.CharUtilities; /** @@ -50,12 +49,9 @@ import org.apache.fop.util.CharUtilities; * <br> * The iteration always starts at <code>firstTextNode</code>, * goes on until the last text-node is reached, and deals only - * with FOText nodes (characters are immediately removed) or - * Character nodes (characters are kept track of and removed - * from the list of child nodes later, when the iterator goes - * out of scope) - * - * Note: if the method is called from an inline's endOfNode(), + * with <code>FOText</code> or <code>Character</code> nodes. + * <br> + * <em>Note</em>: if the method is called from an inline's endOfNode(), * there is too little context to decide whether trailing * white-space may be removed, so the pending inline is stored * in a List, together with an iterator for which the next() diff --git a/src/java/org/apache/fop/fo/expr/CMYKcolorFunction.java b/src/java/org/apache/fop/fo/expr/CMYKcolorFunction.java index a66e8492a..ff3ca25eb 100644 --- a/src/java/org/apache/fop/fo/expr/CMYKcolorFunction.java +++ b/src/java/org/apache/fop/fo/expr/CMYKcolorFunction.java @@ -29,13 +29,13 @@ class CMYKcolorFunction extends FunctionBase { /** * cmyk takes four arguments. - * @see org.apache.fop.fo.expr.Function#nbArgs() + * {@inheritDoc} */ public int nbArgs() { return 4; } - /** @see org.apache.fop.fo.expr.Function */ + /** {@inheritDoc} */ public Property eval(Property[] args, PropertyInfo pInfo) throws PropertyException { StringBuffer sb = new StringBuffer(); diff --git a/src/java/org/apache/fop/fo/expr/ICCColorFunction.java b/src/java/org/apache/fop/fo/expr/ICCColorFunction.java index fce073467..389bf42e9 100644 --- a/src/java/org/apache/fop/fo/expr/ICCColorFunction.java +++ b/src/java/org/apache/fop/fo/expr/ICCColorFunction.java @@ -32,13 +32,13 @@ class ICCColorFunction extends FunctionBase { /** * rgb-icc takes a variable number of arguments. * At least 4 should be passed - returns -4 - * @see org.apache.fop.fo.expr.Function#nbArgs() + * {@inheritDoc} */ public int nbArgs() { return -4; } - /** @see org.apache.fop.fo.expr.Function */ + /** {@inheritDoc} */ public Property eval(Property[] args, PropertyInfo pInfo) throws PropertyException { StringBuffer sb = new StringBuffer(); diff --git a/src/java/org/apache/fop/fo/expr/NumericProperty.java b/src/java/org/apache/fop/fo/expr/NumericProperty.java index 4c112964d..9c0b9e2ba 100644 --- a/src/java/org/apache/fop/fo/expr/NumericProperty.java +++ b/src/java/org/apache/fop/fo/expr/NumericProperty.java @@ -49,7 +49,7 @@ public class NumericProperty extends Property implements Numeric, Length { /** * Return the dimension. - * @see Numeric#getDimension() + * {@inheritDoc} */ public int getDimension() { return dim; @@ -57,14 +57,14 @@ public class NumericProperty extends Property implements Numeric, Length { /** * Return the value. - * @see Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue() { return value; } /** - * @see Numeric#getNumericValue(PercentBaseContext) + * {@inheritDoc} */ public double getNumericValue(PercentBaseContext context) { return value; @@ -72,33 +72,33 @@ public class NumericProperty extends Property implements Numeric, Length { /** * Return true of the numeric is absolute. - * @see Numeric#isAbsolute() + * {@inheritDoc} */ public boolean isAbsolute() { return true; } - /** @see org.apache.fop.fo.properties.Property#getNumeric() */ + /** {@inheritDoc} */ public Numeric getNumeric() { return this; } - /** @see org.apache.fop.fo.properties.Property#getNumber() */ + /** {@inheritDoc} */ public Number getNumber() { return new Double(value); } - /** @see org.apache.fop.datatypes.Numeric#getValue() */ + /** {@inheritDoc} */ public int getValue() { return (int) value; } - /** @see org.apache.fop.datatypes.Numeric#getValue(PercentBaseContext) */ + /** {@inheritDoc} */ public int getValue(PercentBaseContext context) { return (int) value; } - /** @see org.apache.fop.fo.properties.Property#getLength() */ + /** {@inheritDoc} */ public Length getLength() { if (dim == 1) { return this; @@ -107,18 +107,18 @@ public class NumericProperty extends Property implements Numeric, Length { return null; } - /** @see org.apache.fop.fo.properties.Property#getColor(FOUserAgent) */ + /** {@inheritDoc} */ public Color getColor(FOUserAgent foUserAgent) { // TODO: try converting to numeric number and then to color return null; } - /** @see org.apache.fop.fo.properties.Property#getObject() */ + /** {@inheritDoc} */ public Object getObject() { return this; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { if (dim == 1) { return (int) value + "mpt"; diff --git a/src/java/org/apache/fop/fo/expr/PropertyException.java b/src/java/org/apache/fop/fo/expr/PropertyException.java index 3e4b5f9d1..d9a0b2edd 100644 --- a/src/java/org/apache/fop/fo/expr/PropertyException.java +++ b/src/java/org/apache/fop/fo/expr/PropertyException.java @@ -52,7 +52,7 @@ public class PropertyException extends FOPException { this.propertyName = propertyName; } - /** @see java.lang.Throwable#getMessage()*/ + /** {@inheritDoc} */ public String getMessage() { if (propertyName != null) { return super.getMessage() + "; property:'" + propertyName + "'"; diff --git a/src/java/org/apache/fop/fo/expr/PropertyInfo.java b/src/java/org/apache/fop/fo/expr/PropertyInfo.java index dc104b465..491be64fc 100644 --- a/src/java/org/apache/fop/fo/expr/PropertyInfo.java +++ b/src/java/org/apache/fop/fo/expr/PropertyInfo.java @@ -45,7 +45,6 @@ public class PropertyInfo { * Constructor * @param maker Property.Maker object * @param plist PropertyList object - * @param fo FObj */ public PropertyInfo(PropertyMaker maker, PropertyList plist) { this.maker = maker; diff --git a/src/java/org/apache/fop/fo/expr/RGBColorFunction.java b/src/java/org/apache/fop/fo/expr/RGBColorFunction.java index 805d8014f..6c6162731 100644 --- a/src/java/org/apache/fop/fo/expr/RGBColorFunction.java +++ b/src/java/org/apache/fop/fo/expr/RGBColorFunction.java @@ -30,7 +30,7 @@ import org.apache.fop.fo.properties.Property; */ class RGBColorFunction extends FunctionBase { - /** @see org.apache.fop.fo.expr.Function#nbArgs() */ + /** {@inheritDoc} */ public int nbArgs() { return 3; } @@ -44,7 +44,7 @@ class RGBColorFunction extends FunctionBase { return new RGBPercentBase(); } - /** @see org.apache.fop.fo.expr.Function */ + /** {@inheritDoc} */ public Property eval(Property[] args, PropertyInfo pInfo) throws PropertyException { FOUserAgent ua = (pInfo == null) diff --git a/src/java/org/apache/fop/fo/expr/RelativeNumericProperty.java b/src/java/org/apache/fop/fo/expr/RelativeNumericProperty.java index b42cb11a7..ae140b6b7 100755 --- a/src/java/org/apache/fop/fo/expr/RelativeNumericProperty.java +++ b/src/java/org/apache/fop/fo/expr/RelativeNumericProperty.java @@ -128,14 +128,14 @@ public class RelativeNumericProperty extends Property implements Numeric, Length /** * Return the resolved (calculated) value of the expression. - * @see org.apache.fop.datatypes.Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue() throws PropertyException { return getResolved(null).getNumericValue(null); } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue(PercentBaseContext) + * {@inheritDoc} */ public double getNumericValue(PercentBaseContext context) throws PropertyException { return getResolved(context).getNumericValue(context); @@ -172,7 +172,7 @@ public class RelativeNumericProperty extends Property implements Numeric, Length } /** - * @see org.apache.fop.datatypes.Numeric#getValue() + * {@inheritDoc} */ public int getValue() { try { @@ -184,7 +184,7 @@ public class RelativeNumericProperty extends Property implements Numeric, Length } /** - * @see org.apache.fop.datatypes.Numeric#getValue(PercentBaseContext) + * {@inheritDoc} */ public int getValue(PercentBaseContext context) { try { diff --git a/src/java/org/apache/fop/fo/expr/SystemColorFunction.java b/src/java/org/apache/fop/fo/expr/SystemColorFunction.java index ea9e4562e..5398b7051 100644 --- a/src/java/org/apache/fop/fo/expr/SystemColorFunction.java +++ b/src/java/org/apache/fop/fo/expr/SystemColorFunction.java @@ -28,12 +28,12 @@ import org.apache.fop.fo.properties.Property; */ class SystemColorFunction extends FunctionBase { - /** @see org.apache.fop.fo.expr.Function#nbArgs() */ + /** {@inheritDoc} */ public int nbArgs() { return 1; } - /** @see org.apache.fop.fo.expr.Function */ + /** {@inheritDoc} */ public Property eval(Property[] args, PropertyInfo pInfo) throws PropertyException { FOUserAgent ua = (pInfo == null) diff --git a/src/java/org/apache/fop/fo/extensions/ExtensionElementMapping.java b/src/java/org/apache/fop/fo/extensions/ExtensionElementMapping.java index b5ed3e61c..989726d22 100644 --- a/src/java/org/apache/fop/fo/extensions/ExtensionElementMapping.java +++ b/src/java/org/apache/fop/fo/extensions/ExtensionElementMapping.java @@ -71,12 +71,12 @@ public class ExtensionElementMapping extends ElementMapping { } } - /** @see org.apache.fop.fo.ElementMapping#getStandardPrefix() */ + /** {@inheritDoc} */ public String getStandardPrefix() { return "fox"; } - /** @see org.apache.fop.fo.ElementMapping#isAttributeProperty(org.apache.fop.util.QName) */ + /** {@inheritDoc} */ public boolean isAttributeProperty(QName attributeName) { if (!URI.equals(attributeName.getNamespaceURI())) { throw new IllegalArgumentException("The namespace URIs don't match"); diff --git a/src/java/org/apache/fop/fo/extensions/ExtensionObj.java b/src/java/org/apache/fop/fo/extensions/ExtensionObj.java index 9123a8bb7..f22c6fbbc 100644 --- a/src/java/org/apache/fop/fo/extensions/ExtensionObj.java +++ b/src/java/org/apache/fop/fo/extensions/ExtensionObj.java @@ -43,7 +43,7 @@ public abstract class ExtensionObj extends FObj { } /** - * @see org.apache.fop.fo.FONode#processNode + * {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) diff --git a/src/java/org/apache/fop/fo/extensions/destination/Destination.java b/src/java/org/apache/fop/fo/extensions/destination/Destination.java index b4611661e..d1e631e42 100644 --- a/src/java/org/apache/fop/fo/extensions/destination/Destination.java +++ b/src/java/org/apache/fop/fo/extensions/destination/Destination.java @@ -48,8 +48,7 @@ public class Destination extends FONode { } /** - * @see org.apache.fop.fo.FONode#processNode(java.lang.String, org.xml.sax.Locator, - * org.xml.sax.Attributes, org.apache.fop.fo.PropertyList) + * {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) throws FOPException { @@ -60,14 +59,14 @@ public class Destination extends FONode { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { root.addDestination(this); } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -83,17 +82,17 @@ public class Destination extends FONode { return internalDestination; } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return ExtensionElementMapping.URI; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return "fox"; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "destination"; } diff --git a/src/java/org/apache/fop/fo/extensions/svg/BatikExtensionElementMapping.java b/src/java/org/apache/fop/fo/extensions/svg/BatikExtensionElementMapping.java index cb6e69a13..a39562877 100644 --- a/src/java/org/apache/fop/fo/extensions/svg/BatikExtensionElementMapping.java +++ b/src/java/org/apache/fop/fo/extensions/svg/BatikExtensionElementMapping.java @@ -43,7 +43,7 @@ public class BatikExtensionElementMapping extends ElementMapping { namespaceURI = URI; } - /** @see org.apache.fop.fo.ElementMapping#getDOMImplementation() */ + /** {@inheritDoc} */ public DOMImplementation getDOMImplementation() { return null; //no DOMImplementation necessary here } diff --git a/src/java/org/apache/fop/fo/extensions/svg/SVGElement.java b/src/java/org/apache/fop/fo/extensions/svg/SVGElement.java index 351327a26..521f3b81b 100644 --- a/src/java/org/apache/fop/fo/extensions/svg/SVGElement.java +++ b/src/java/org/apache/fop/fo/extensions/svg/SVGElement.java @@ -62,7 +62,7 @@ public class SVGElement extends SVGObj { } /** - * @see org.apache.fop.fo.FONode#getContentHandlerFactory() + * {@inheritDoc} */ public ContentHandlerFactory getContentHandlerFactory() { return new DOMBuilderContentHandlerFactory(getNamespaceURI(), @@ -70,7 +70,7 @@ public class SVGElement extends SVGObj { } /** - * @see org.apache.fop.fo.FONode#processNode + * {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList propertyList) throws FOPException { diff --git a/src/java/org/apache/fop/fo/extensions/svg/SVGElementMapping.java b/src/java/org/apache/fop/fo/extensions/svg/SVGElementMapping.java index 2d8939dc2..586fd2d92 100644 --- a/src/java/org/apache/fop/fo/extensions/svg/SVGElementMapping.java +++ b/src/java/org/apache/fop/fo/extensions/svg/SVGElementMapping.java @@ -51,7 +51,7 @@ public class SVGElementMapping extends ElementMapping { namespaceURI = URI; } - /** @see org.apache.fop.fo.ElementMapping#getDOMImplementation() */ + /** {@inheritDoc} */ public DOMImplementation getDOMImplementation() { return SVGDOMImplementation.getDOMImplementation(); } @@ -70,7 +70,7 @@ public class SVGElementMapping extends ElementMapping { } } - /** @see org.apache.fop.fo.ElementMapping#initialize() */ + /** {@inheritDoc} */ protected void initialize() { if (foObjs == null && batikAvailable) { // this sets the parser that will be used @@ -92,7 +92,7 @@ public class SVGElementMapping extends ElementMapping { } } - /** @see org.apache.fop.fo.ElementMapping#getStandardPrefix() */ + /** {@inheritDoc} */ public String getStandardPrefix() { return "svg"; } diff --git a/src/java/org/apache/fop/fo/extensions/svg/SVGObj.java b/src/java/org/apache/fop/fo/extensions/svg/SVGObj.java index 60ba9d276..93193aac4 100644 --- a/src/java/org/apache/fop/fo/extensions/svg/SVGObj.java +++ b/src/java/org/apache/fop/fo/extensions/svg/SVGObj.java @@ -37,12 +37,12 @@ public class SVGObj extends XMLObj { super(parent); } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return SVGElementMapping.URI; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return "svg"; } diff --git a/src/java/org/apache/fop/fo/extensions/xmp/AbstractMetadataElement.java b/src/java/org/apache/fop/fo/extensions/xmp/AbstractMetadataElement.java index ca6019aae..0fff78623 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/AbstractMetadataElement.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/AbstractMetadataElement.java @@ -42,13 +42,13 @@ public abstract class AbstractMetadataElement extends FONode implements ObjectBu } /** - * @see org.apache.fop.fo.FONode#getContentHandlerFactory() + * {@inheritDoc} */ public ContentHandlerFactory getContentHandlerFactory() { return new XMPContentHandlerFactory(); } - /** @see org.apache.fop.fo.FONode#getExtensionAttachment() */ + /** {@inheritDoc} */ public ExtensionAttachment getExtensionAttachment() { if (parent instanceof FObj) { if (attachment == null) { @@ -60,7 +60,7 @@ public abstract class AbstractMetadataElement extends FONode implements ObjectBu } } - /** @see org.apache.fop.fo.XMLObj#notifyObjectBuilt(java.lang.Object) */ + /** {@inheritDoc} */ public void notifyObjectBuilt(Object obj) { attachment.setMetadata((Metadata)obj); } diff --git a/src/java/org/apache/fop/fo/extensions/xmp/RDFElement.java b/src/java/org/apache/fop/fo/extensions/xmp/RDFElement.java index 51ec81dc8..6a67575c5 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/RDFElement.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/RDFElement.java @@ -35,17 +35,17 @@ public class RDFElement extends AbstractMetadataElement { super(parent); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "RDF"; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return "rdf"; } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return XMPConstants.RDF_NAMESPACE; } diff --git a/src/java/org/apache/fop/fo/extensions/xmp/RDFElementMapping.java b/src/java/org/apache/fop/fo/extensions/xmp/RDFElementMapping.java index 7f4df95a3..e2aa1ba95 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/RDFElementMapping.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/RDFElementMapping.java @@ -37,12 +37,12 @@ public class RDFElementMapping extends ElementMapping { namespaceURI = XMPConstants.RDF_NAMESPACE; } - /** @see org.apache.fop.fo.ElementMapping#getDOMImplementation() */ + /** {@inheritDoc} */ public DOMImplementation getDOMImplementation() { return getDefaultDOMImplementation(); } - /** @see org.apache.fop.fo.ElementMapping#initialize() */ + /** {@inheritDoc} */ protected void initialize() { if (foObjs == null) { foObjs = new HashMap(); diff --git a/src/java/org/apache/fop/fo/extensions/xmp/XMPContentHandlerFactory.java b/src/java/org/apache/fop/fo/extensions/xmp/XMPContentHandlerFactory.java index 970cc62a2..5c30801f2 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/XMPContentHandlerFactory.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/XMPContentHandlerFactory.java @@ -33,12 +33,12 @@ public class XMPContentHandlerFactory implements ContentHandlerFactory { private static final String[] NAMESPACES = new String[] {XMPConstants.XMP_NAMESPACE, XMPConstants.RDF_NAMESPACE}; - /** @see org.apache.fop.util.ContentHandlerFactory#getSupportedNamespaces() */ + /** {@inheritDoc} */ public String[] getSupportedNamespaces() { return NAMESPACES; } - /** @see org.apache.fop.util.ContentHandlerFactory#createContentHandler() */ + /** {@inheritDoc} */ public ContentHandler createContentHandler() throws SAXException { return new FOPXMPHandler(); } @@ -54,12 +54,12 @@ public class XMPContentHandlerFactory implements ContentHandlerFactory { return getMetadata(); } - /** @see org.apache.fop.util.ContentHandlerFactory.ObjectSource */ + /** {@inheritDoc} */ public void setObjectBuiltListener(ObjectBuiltListener listener) { this.obListener = listener; } - /** @see org.xml.sax.helpers.DefaultHandler#endDocument() */ + /** {@inheritDoc} */ public void endDocument() throws SAXException { if (obListener != null) { obListener.notifyObjectBuilt(getObject()); diff --git a/src/java/org/apache/fop/fo/extensions/xmp/XMPElementMapping.java b/src/java/org/apache/fop/fo/extensions/xmp/XMPElementMapping.java index 62e940c18..dd250f8b4 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/XMPElementMapping.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/XMPElementMapping.java @@ -37,12 +37,12 @@ public class XMPElementMapping extends ElementMapping { namespaceURI = XMPConstants.XMP_NAMESPACE; } - /** @see org.apache.fop.fo.ElementMapping#getDOMImplementation() */ + /** {@inheritDoc} */ public DOMImplementation getDOMImplementation() { return getDefaultDOMImplementation(); } - /** @see org.apache.fop.fo.ElementMapping#initialize() */ + /** {@inheritDoc} */ protected void initialize() { if (foObjs == null) { foObjs = new HashMap(); diff --git a/src/java/org/apache/fop/fo/extensions/xmp/XMPMetaElement.java b/src/java/org/apache/fop/fo/extensions/xmp/XMPMetaElement.java index 3398fbda5..2d3058d3f 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/XMPMetaElement.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/XMPMetaElement.java @@ -35,17 +35,17 @@ public class XMPMetaElement extends AbstractMetadataElement { super(parent); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "xmpmeta"; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return "x"; } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return XMPConstants.XMP_NAMESPACE; } diff --git a/src/java/org/apache/fop/fo/extensions/xmp/XMPMetadata.java b/src/java/org/apache/fop/fo/extensions/xmp/XMPMetadata.java index c761a08ed..f08b1f433 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/XMPMetadata.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/XMPMetadata.java @@ -80,12 +80,12 @@ public class XMPMetadata implements ExtensionAttachment, Serializable, XMLizable this.readOnly = readOnly; } - /** @see org.apache.fop.fo.extensions.ExtensionAttachment#getCategory() */ + /** {@inheritDoc} */ public String getCategory() { return CATEGORY; } - /** @see org.apache.fop.util.XMLizable#toSAX(org.xml.sax.ContentHandler) */ + /** {@inheritDoc} */ public void toSAX(ContentHandler handler) throws SAXException { getMetadata().toSAX(handler); } diff --git a/src/java/org/apache/fop/fo/flow/AbstractGraphics.java b/src/java/org/apache/fop/fo/flow/AbstractGraphics.java index f48052009..74b91eb53 100644 --- a/src/java/org/apache/fop/fo/flow/AbstractGraphics.java +++ b/src/java/org/apache/fop/fo/flow/AbstractGraphics.java @@ -24,12 +24,7 @@ import org.apache.fop.datatypes.Length; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonMarginInline; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.LengthRangeProperty; import org.apache.fop.fo.properties.SpaceProperty; @@ -82,7 +77,7 @@ public abstract class AbstractGraphics extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps(); diff --git a/src/java/org/apache/fop/fo/flow/AbstractListItemPart.java b/src/java/org/apache/fop/fo/flow/AbstractListItemPart.java index 2996f5edd..0fe6ed718 100644 --- a/src/java/org/apache/fop/fo/flow/AbstractListItemPart.java +++ b/src/java/org/apache/fop/fo/flow/AbstractListItemPart.java @@ -26,11 +26,10 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; import org.apache.fop.fo.properties.KeepProperty; /** - * Class modelling the fo:list-item-body object. + * Common superclass for list-item-label and list-item-body. */ public abstract class AbstractListItemPart extends FObj { // The value of properties relevant for fo:list-item-label and fo:list-item-body. @@ -50,7 +49,7 @@ public abstract class AbstractListItemPart extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -58,7 +57,7 @@ public abstract class AbstractListItemPart extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -75,7 +74,7 @@ public abstract class AbstractListItemPart extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!this.blockItemFound) { diff --git a/src/java/org/apache/fop/fo/flow/BasicLink.java b/src/java/org/apache/fop/fo/flow/BasicLink.java index c07c31289..61a4f8d19 100644 --- a/src/java/org/apache/fop/fo/flow/BasicLink.java +++ b/src/java/org/apache/fop/fo/flow/BasicLink.java @@ -27,7 +27,7 @@ import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; /** - * The fo:basic-link formatting object. + * Class modelling the fo:basic-link object. * * This class contains the logic to determine the link represented by this FO, * and whether that link is external (uses a URI) or internal (an id @@ -58,7 +58,7 @@ public class BasicLink extends Inline { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -82,7 +82,7 @@ public class BasicLink extends Inline { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -90,7 +90,7 @@ public class BasicLink extends Inline { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); @@ -98,7 +98,7 @@ public class BasicLink extends Inline { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} String, String) * XSL Content Model: marker* (#PCDATA|%inline;|%block;)* */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -142,12 +142,12 @@ public class BasicLink extends Inline { return externalDestination != null && externalDestination.length() > 0; } - /** @see org.apache.fop.fo.FObj#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "basic-link"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_BASIC_LINK; } diff --git a/src/java/org/apache/fop/fo/flow/BidiOverride.java b/src/java/org/apache/fop/fo/flow/BidiOverride.java index 3a63b96cf..2157085ad 100644 --- a/src/java/org/apache/fop/fo/flow/BidiOverride.java +++ b/src/java/org/apache/fop/fo/flow/BidiOverride.java @@ -19,21 +19,16 @@ package org.apache.fop.fo.flow; -import java.awt.Color; - import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObjMixed; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAural; -import org.apache.fop.fo.properties.CommonFont; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.SpaceProperty; import org.xml.sax.Locator; /** - * fo:bidi-override element. + * Class modelling the fo:bidi-override object. */ public class BidiOverride extends FObjMixed { @@ -82,7 +77,7 @@ public class BidiOverride extends FObjMixed { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { // prDirection = pList.get(PR_DIRECTION); @@ -93,7 +88,7 @@ public class BidiOverride extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (#PCDATA|%inline;|%block;)* * 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 @@ -127,13 +122,13 @@ public class BidiOverride extends FObjMixed { return lineHeight; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "bidi-override"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_BIDI_OVERRIDE; diff --git a/src/java/org/apache/fop/fo/flow/Block.java b/src/java/org/apache/fop/fo/flow/Block.java index 894339b8d..30b4c5495 100644 --- a/src/java/org/apache/fop/fo/flow/Block.java +++ b/src/java/org/apache/fop/fo/flow/Block.java @@ -95,7 +95,7 @@ public class Block extends FObjMixed { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -131,7 +131,7 @@ public class Block extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -139,7 +139,7 @@ public class Block extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); @@ -276,7 +276,7 @@ public class Block extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* initial-property-set? (#PCDATA|%inline;|%block;)* * 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 @@ -363,18 +363,18 @@ public class Block extends FObjMixed { return this.lineHeightShiftAdjustment; } - /** @see org.apache.fop.fo.FONode#charIterator() */ + /** {@inheritDoc} */ public CharIterator charIterator() { return NullCharIterator.getInstance(); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "block"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_BLOCK; diff --git a/src/java/org/apache/fop/fo/flow/BlockContainer.java b/src/java/org/apache/fop/fo/flow/BlockContainer.java index acffa083f..a71999938 100644 --- a/src/java/org/apache/fop/fo/flow/BlockContainer.java +++ b/src/java/org/apache/fop/fo/flow/BlockContainer.java @@ -73,7 +73,7 @@ public class BlockContainer extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -98,7 +98,7 @@ public class BlockContainer extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -106,7 +106,7 @@ public class BlockContainer extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (%block;)+ * But: "In addition an fo:block-container that does not generate an * absolutely positioned area may have a sequence of zero or more @@ -127,7 +127,7 @@ public class BlockContainer extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!blockItemFound) { @@ -251,13 +251,13 @@ public class BlockContainer extends FObj { return height; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "block-container"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_BLOCK_CONTAINER; diff --git a/src/java/org/apache/fop/fo/flow/Character.java b/src/java/org/apache/fop/fo/flow/Character.java index 78a1ea0ef..022d54af7 100644 --- a/src/java/org/apache/fop/fo/flow/Character.java +++ b/src/java/org/apache/fop/fo/flow/Character.java @@ -29,30 +29,26 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonFont; import org.apache.fop.fo.properties.CommonHyphenation; -import org.apache.fop.fo.properties.CommonMarginInline; -import org.apache.fop.fo.properties.CommonRelativePosition; 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; -import org.apache.fop.util.CharUtilities; import org.xml.sax.Locator; /** - * This class represents the flow object 'fo:character'. 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 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) * */ public class Character extends FObj { @@ -102,7 +98,7 @@ public class Character extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -126,7 +122,7 @@ public class Character extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -134,7 +130,7 @@ public class Character extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -143,7 +139,7 @@ public class Character extends FObj { } /** - * @see org.apache.fop.fo.FObj#charIterator + * {@inheritDoc} */ public CharIterator charIterator() { return new FOCharIterator(this); @@ -238,13 +234,13 @@ public class Character extends FObj { return wordSpacing; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "character"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_CHARACTER; diff --git a/src/java/org/apache/fop/fo/flow/ExternalGraphic.java b/src/java/org/apache/fop/fo/flow/ExternalGraphic.java index 3ca8cf777..f0285e6f4 100644 --- a/src/java/org/apache/fop/fo/flow/ExternalGraphic.java +++ b/src/java/org/apache/fop/fo/flow/ExternalGraphic.java @@ -30,7 +30,7 @@ import org.apache.fop.image.ImageFactory; import org.xml.sax.Locator; /** - * External graphic formatting object. + * Class modelling the fo:external-graphic object. * This FO node handles the external graphic. It creates an image * inline area that can be added to the area tree. */ @@ -57,7 +57,7 @@ public class ExternalGraphic extends AbstractGraphics { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -83,7 +83,7 @@ public class ExternalGraphic extends AbstractGraphics { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -91,7 +91,7 @@ public class ExternalGraphic extends AbstractGraphics { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -113,34 +113,34 @@ public class ExternalGraphic extends AbstractGraphics { return url; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "external-graphic"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_EXTERNAL_GRAPHIC; } /** - * @see org.apache.fop.fo.flow.AbstractGraphics#getIntrinsicWidth() + * {@inheritDoc} */ public int getIntrinsicWidth() { return this.intrinsicWidth; } /** - * @see org.apache.fop.fo.flow.AbstractGraphics#getIntrinsicHeight() + * {@inheritDoc} */ public int getIntrinsicHeight() { return this.intrinsicHeight; } /** - * @see org.apache.fop.fo.flow.AbstractGraphics#getIntrinsicAlignmentAdjust() + * {@inheritDoc} */ public Length getIntrinsicAlignmentAdjust() { return this.intrinsicAlignmentAdjust; diff --git a/src/java/org/apache/fop/fo/flow/Float.java b/src/java/org/apache/fop/fo/flow/Float.java index 475ffee09..997f96c89 100644 --- a/src/java/org/apache/fop/fo/flow/Float.java +++ b/src/java/org/apache/fop/fo/flow/Float.java @@ -29,7 +29,7 @@ import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; /** - * fo:float element. + * Class modelling the fo:float object. */ public class Float extends FObj { // The value of properties relevant for fo:float (commented out for performance. @@ -52,14 +52,14 @@ public class Float extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { // No active properties -> Nothing to do. } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -70,9 +70,7 @@ public class Float extends FObj { } /** - * Make sure content model satisfied, if so then tell the - * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -80,13 +78,13 @@ public class Float extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "float"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_FLOAT; diff --git a/src/java/org/apache/fop/fo/flow/Footnote.java b/src/java/org/apache/fop/fo/flow/Footnote.java index 0f22b441e..95c9f25bc 100644 --- a/src/java/org/apache/fop/fo/flow/Footnote.java +++ b/src/java/org/apache/fop/fo/flow/Footnote.java @@ -26,7 +26,6 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; /** * Class modelling the fo:footnote object. @@ -47,14 +46,14 @@ public class Footnote extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { // No active properties -> do nothing. } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { getFOEventHandler().startFootnote(this); @@ -63,7 +62,7 @@ public class Footnote extends FObj { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); @@ -74,7 +73,7 @@ public class Footnote extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (inline,footnote-body) * @todo implement additional constraint: A fo:footnote is not permitted * to have a fo:float, fo:footnote, or fo:marker as a descendant. @@ -100,7 +99,7 @@ public class Footnote extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ public void addChildNode(FONode child) { if (((FObj)child).getNameId() == FO_INLINE) { @@ -126,13 +125,13 @@ public class Footnote extends FObj { return footnoteBody; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "footnote"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_FOOTNOTE; diff --git a/src/java/org/apache/fop/fo/flow/FootnoteBody.java b/src/java/org/apache/fop/fo/flow/FootnoteBody.java index ef42012a8..bb4c9b482 100644 --- a/src/java/org/apache/fop/fo/flow/FootnoteBody.java +++ b/src/java/org/apache/fop/fo/flow/FootnoteBody.java @@ -27,7 +27,6 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; /** * Class modelling the fo:footnote-body object. @@ -45,13 +44,13 @@ public class FootnoteBody extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { getFOEventHandler().startFootnoteBody(this); @@ -60,7 +59,7 @@ public class FootnoteBody extends FObj { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -70,7 +69,7 @@ public class FootnoteBody extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -80,13 +79,13 @@ public class FootnoteBody extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "footnote-body"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_FOOTNOTE_BODY; diff --git a/src/java/org/apache/fop/fo/flow/InitialPropertySet.java b/src/java/org/apache/fop/fo/flow/InitialPropertySet.java index 637c54065..63299978d 100644 --- a/src/java/org/apache/fop/fo/flow/InitialPropertySet.java +++ b/src/java/org/apache/fop/fo/flow/InitialPropertySet.java @@ -20,8 +20,6 @@ package org.apache.fop.fo.flow; // XML -import java.awt.Color; - import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; @@ -29,11 +27,6 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; -import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonFont; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.SpaceProperty; /** @@ -41,7 +34,6 @@ import org.apache.fop.fo.properties.SpaceProperty; */ public class InitialPropertySet extends FObj { // The value of properties relevant for fo:initial-property-set. - private String id; // private ToBeImplementedProperty letterSpacing; private SpaceProperty lineHeight; // private ToBeImplementedProperty textShadow; @@ -66,7 +58,7 @@ public class InitialPropertySet extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -76,7 +68,7 @@ public class InitialPropertySet extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -91,13 +83,13 @@ public class InitialPropertySet extends FObj { return lineHeight; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "initial-property-set"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_INITIAL_PROPERTY_SET; diff --git a/src/java/org/apache/fop/fo/flow/Inline.java b/src/java/org/apache/fop/fo/flow/Inline.java index d9ac5136b..6bbd90ad1 100644 --- a/src/java/org/apache/fop/fo/flow/Inline.java +++ b/src/java/org/apache/fop/fo/flow/Inline.java @@ -23,14 +23,9 @@ import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; import org.apache.fop.datatypes.Length; -import org.apache.fop.fo.CharIterator; import org.apache.fop.fo.FONode; -import org.apache.fop.fo.OneCharIterator; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; -import org.apache.fop.fo.properties.LengthRangeProperty; /** * Class modelling the fo:inline formatting object. @@ -47,9 +42,6 @@ public class Inline extends InlineLevel { // private LengthRangeProperty blockProgressionDimension; // private Length height; // private LengthRangeProperty inlineProgressionDimension; - // private KeepProperty keepTogether; - // private KeepProperty keepWithNext; - // private KeepProperty keepWithPrevious; // private Length width; // private int wrapOption; // End of property values @@ -65,7 +57,7 @@ public class Inline extends InlineLevel { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -76,7 +68,7 @@ public class Inline extends InlineLevel { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -103,7 +95,7 @@ public class Inline extends InlineLevel { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); @@ -111,7 +103,7 @@ public class Inline extends InlineLevel { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (#PCDATA|%inline;|%block;)* * Additionally: " An fo:inline that is a descendant of an fo:leader * or fo:footnote may not have block-level children, unless it has a @@ -166,14 +158,12 @@ public class Inline extends InlineLevel { return dominantBaseline; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "inline"; } - /** - * @see org.apache.fop.fo.FObj#getNameId() - */ + /** {@inheritDoc} */ public int getNameId() { return FO_INLINE; } diff --git a/src/java/org/apache/fop/fo/flow/InlineContainer.java b/src/java/org/apache/fop/fo/flow/InlineContainer.java index 1d4f621b8..a8fb7858d 100644 --- a/src/java/org/apache/fop/fo/flow/InlineContainer.java +++ b/src/java/org/apache/fop/fo/flow/InlineContainer.java @@ -23,16 +23,10 @@ import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; import org.apache.fop.datatypes.Length; -import org.apache.fop.datatypes.Numeric; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonMarginInline; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; -import org.apache.fop.fo.properties.LengthRangeProperty; import org.apache.fop.fo.properties.SpaceProperty; /** @@ -75,7 +69,7 @@ public class InlineContainer extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -88,7 +82,7 @@ public class InlineContainer extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -105,7 +99,7 @@ public class InlineContainer extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!blockItemFound) { @@ -148,13 +142,13 @@ public class InlineContainer extends FObj { return lineHeight; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "inline-container"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_INLINE_CONTAINER; diff --git a/src/java/org/apache/fop/fo/flow/InlineLevel.java b/src/java/org/apache/fop/fo/flow/InlineLevel.java index ed9d0abe9..096a2ed66 100644 --- a/src/java/org/apache/fop/fo/flow/InlineLevel.java +++ b/src/java/org/apache/fop/fo/flow/InlineLevel.java @@ -30,6 +30,7 @@ import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonFont; import org.apache.fop.fo.properties.CommonMarginInline; +import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.SpaceProperty; /** @@ -57,7 +58,7 @@ public abstract class InlineLevel extends FObjMixed { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -107,4 +108,3 @@ public abstract class InlineLevel extends FObjMixed { } } - diff --git a/src/java/org/apache/fop/fo/flow/InstreamForeignObject.java b/src/java/org/apache/fop/fo/flow/InstreamForeignObject.java index b201b95b1..531bd657a 100644 --- a/src/java/org/apache/fop/fo/flow/InstreamForeignObject.java +++ b/src/java/org/apache/fop/fo/flow/InstreamForeignObject.java @@ -28,9 +28,8 @@ import org.apache.fop.fo.XMLObj; import org.xml.sax.Locator; /** - * The instream-foreign-object flow formatting object. - * This is an atomic inline object that contains - * xml data. + * Class modelling the fo:instream-foreign-object object. + * This is an atomic inline object that contains XML data. */ public class InstreamForeignObject extends AbstractGraphics { @@ -55,7 +54,7 @@ public class InstreamForeignObject extends AbstractGraphics { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -65,7 +64,7 @@ public class InstreamForeignObject extends AbstractGraphics { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: one (1) non-XSL namespace child */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -77,13 +76,13 @@ public class InstreamForeignObject extends AbstractGraphics { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "instream-foreign-object"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_INSTREAM_FOREIGN_OBJECT; @@ -106,7 +105,7 @@ public class InstreamForeignObject extends AbstractGraphics { } /** - * @see org.apache.fop.fo.flow.AbstractGraphics#getIntrinsicWidth() + * {@inheritDoc} */ public int getIntrinsicWidth() { prepareIntrinsicSize(); @@ -118,7 +117,7 @@ public class InstreamForeignObject extends AbstractGraphics { } /** - * @see org.apache.fop.fo.flow.AbstractGraphics#getIntrinsicHeight() + * {@inheritDoc} */ public int getIntrinsicHeight() { prepareIntrinsicSize(); @@ -130,7 +129,7 @@ public class InstreamForeignObject extends AbstractGraphics { } /** - * @see org.apache.fop.fo.flow.AbstractGraphics#getIntrinsicAlignmentAdjust() + * {@inheritDoc} */ public Length getIntrinsicAlignmentAdjust() { @@ -138,7 +137,7 @@ public class InstreamForeignObject extends AbstractGraphics { return intrinsicAlignmentAdjust; } - /** @see org.apache.fop.fo.FONode#addChildNode(org.apache.fop.fo.FONode) */ + /** {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { super.addChildNode(child); } diff --git a/src/java/org/apache/fop/fo/flow/Leader.java b/src/java/org/apache/fop/fo/flow/Leader.java index 403c6f8a2..82584b614 100644 --- a/src/java/org/apache/fop/fo/flow/Leader.java +++ b/src/java/org/apache/fop/fo/flow/Leader.java @@ -23,10 +23,7 @@ import org.apache.fop.apps.FOPException; import org.apache.fop.datatypes.Length; import org.apache.fop.fo.FONode; import org.apache.fop.fo.PropertyList; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.LengthRangeProperty; -import org.apache.fop.fo.properties.SpaceProperty; /** * Class modelling fo:leader object. @@ -53,9 +50,6 @@ public class Leader extends InlineLevel { // private CommonRelativePosition commonRelativePosition; // private Length textDepth; // private Length textAltitude; - // private KeepProperty keepWithNext; - // private KeepProperty keepWithPrevious; - // private SpaceProperty wordSpacing; // End of property values /** @@ -66,7 +60,7 @@ public class Leader extends InlineLevel { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -171,13 +165,13 @@ public class Leader extends InlineLevel { return dominantBaseline; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "leader"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_LEADER; diff --git a/src/java/org/apache/fop/fo/flow/ListBlock.java b/src/java/org/apache/fop/fo/flow/ListBlock.java index 6c1321024..86c581cc3 100644 --- a/src/java/org/apache/fop/fo/flow/ListBlock.java +++ b/src/java/org/apache/fop/fo/flow/ListBlock.java @@ -27,11 +27,8 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonMarginBlock; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.KeepProperty; /** @@ -70,7 +67,7 @@ public class ListBlock extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -87,7 +84,7 @@ public class ListBlock extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -97,7 +94,7 @@ public class ListBlock extends FObj { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!hasListItem) { @@ -107,7 +104,7 @@ public class ListBlock extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (list-item)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -176,12 +173,12 @@ public class ListBlock extends FObj { return orphanContentLimit; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "list-block"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_LIST_BLOCK; } diff --git a/src/java/org/apache/fop/fo/flow/ListItem.java b/src/java/org/apache/fop/fo/flow/ListItem.java index 35a134571..c09313ef6 100644 --- a/src/java/org/apache/fop/fo/flow/ListItem.java +++ b/src/java/org/apache/fop/fo/flow/ListItem.java @@ -26,11 +26,8 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonMarginBlock; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.KeepProperty; /** @@ -64,7 +61,7 @@ public class ListItem extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -78,7 +75,7 @@ public class ListItem extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -86,9 +83,7 @@ public class ListItem extends FObj { } /** - * Make sure content model satisfied, if so then tell the - * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (label == null || body == null) { @@ -98,7 +93,7 @@ public class ListItem extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (list-item-label,list-item-body) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -123,7 +118,7 @@ public class ListItem extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} * @todo see if can/should rely on base class for this * (i.e., add to childNodes instead) */ @@ -196,13 +191,13 @@ public class ListItem extends FObj { return body; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "list-item"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_LIST_ITEM; diff --git a/src/java/org/apache/fop/fo/flow/ListItemBody.java b/src/java/org/apache/fop/fo/flow/ListItemBody.java index 2c7b9afc1..3d5d4562e 100644 --- a/src/java/org/apache/fop/fo/flow/ListItemBody.java +++ b/src/java/org/apache/fop/fo/flow/ListItemBody.java @@ -35,7 +35,7 @@ public class ListItemBody extends AbstractListItemPart { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -43,20 +43,20 @@ public class ListItemBody extends AbstractListItemPart { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); getFOEventHandler().endListBody(); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "list-item-body"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_LIST_ITEM_BODY; diff --git a/src/java/org/apache/fop/fo/flow/ListItemLabel.java b/src/java/org/apache/fop/fo/flow/ListItemLabel.java index 8b9214abf..dcdf1b3a1 100644 --- a/src/java/org/apache/fop/fo/flow/ListItemLabel.java +++ b/src/java/org/apache/fop/fo/flow/ListItemLabel.java @@ -35,7 +35,7 @@ public class ListItemLabel extends AbstractListItemPart { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -43,20 +43,20 @@ public class ListItemLabel extends AbstractListItemPart { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); getFOEventHandler().endListLabel(); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "list-item-label"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_LIST_ITEM_LABEL; diff --git a/src/java/org/apache/fop/fo/flow/Marker.java b/src/java/org/apache/fop/fo/flow/Marker.java index 8bc37dc3b..05c9862b2 100644 --- a/src/java/org/apache/fop/fo/flow/Marker.java +++ b/src/java/org/apache/fop/fo/flow/Marker.java @@ -20,7 +20,6 @@ package org.apache.fop.fo.flow; import java.util.Collections; -import java.util.List; import java.util.Map; import org.xml.sax.Attributes; @@ -37,7 +36,7 @@ import org.apache.fop.fo.ValidationException; import org.apache.fop.fo.properties.Property; /** - * Marker formatting object. + * Class modelling the fo:marker object. */ public class Marker extends FObjMixed { // The value of properties relevant for fo:marker. @@ -56,7 +55,7 @@ public class Marker extends FObjMixed { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { if (findAncestor(FO_FLOW) < 0) { @@ -82,7 +81,7 @@ public class Marker extends FObjMixed { descendantPropertyLists.get(foNode); } - /** @see org.apache.fop.fo.FONode#startOfNode() */ + /** {@inheritDoc} */ protected void startOfNode() { FOEventHandler foEventHandler = getFOEventHandler(); // Push a new property list maker which will make MarkerPropertyLists. @@ -96,7 +95,7 @@ public class Marker extends FObjMixed { }); } - /** @see org.apache.fop.fo.FONode#endOfNode() */ + /** {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); // Pop the MarkerPropertyList maker. @@ -105,7 +104,7 @@ public class Marker extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (#PCDATA|%inline;|%block;)* * Additionally: "An fo:marker may contain any formatting objects that * are permitted as a replacement of any fo:retrieve-marker that retrieves @@ -130,19 +129,19 @@ public class Marker extends FObjMixed { return markerClassName; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "marker"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_MARKER; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(super.toString()); sb.append(" {").append(getMarkerClassName()).append("}"); @@ -203,7 +202,6 @@ public class Marker extends FObjMixed { /** * Null implementation; not used by this type of PropertyList - * @see org.apache.fop.fo.PropertyList#putExplicit(int, Property) */ public void putExplicit(int propId, Property value) { //nop @@ -211,14 +209,13 @@ public class Marker extends FObjMixed { /** * Null implementation; not used by this type of PropertyList - * @see org.apache.fop.fo.PropertyList#getExplicit(int) */ public Property getExplicit(int propId) { return null; } /** - * @see org.xml.sax.Attributes#getLength() + * {@inheritDoc} */ public int getLength() { if (attribs == null) { @@ -229,7 +226,7 @@ public class Marker extends FObjMixed { } /** - * @see org.xml.sax.Attributes#getURI(int) + * {@inheritDoc} */ public String getURI(int index) { if (attribs != null @@ -243,7 +240,7 @@ public class Marker extends FObjMixed { } /** - * @see org.xml.sax.Attributes#getLocalName(int) + * {@inheritDoc} */ public String getLocalName(int index) { if (attribs != null @@ -257,7 +254,7 @@ public class Marker extends FObjMixed { } /** - * @see org.xml.sax.Attributes#getQName(int) + * {@inheritDoc} */ public String getQName(int index) { if (attribs != null @@ -272,14 +269,13 @@ public class Marker extends FObjMixed { /** * Default implementation; not used - * @see org.xml.sax.Attributes#getType(int) */ public String getType(int index) { return "CDATA"; } /** - * @see org.xml.sax.Attributes#getValue(int) + * {@inheritDoc} */ public String getValue(int index) { if (attribs != null @@ -293,7 +289,7 @@ public class Marker extends FObjMixed { } /** - * @see org.xml.sax.Attributes#getIndex(String, String) + * {@inheritDoc} */ public int getIndex(String name, String namespace) { int index = -1; @@ -310,7 +306,7 @@ public class Marker extends FObjMixed { } /** - * @see org.xml.sax.Attributes#getIndex(String) + * {@inheritDoc} */ public int getIndex(String qname) { int index = -1; @@ -327,7 +323,6 @@ public class Marker extends FObjMixed { /** * Default implementation; not used - * @see org.xml.sax.Attributes#getType(String, String) */ public String getType(String name, String namespace) { return "CDATA"; @@ -335,14 +330,13 @@ public class Marker extends FObjMixed { /** * Default implementation; not used - * @see org.xml.sax.Attributes#getType(String) */ public String getType(String qname) { return "CDATA"; } /** - * @see org.xml.sax.Attributes#getValue(String, String) + * {@inheritDoc} */ public String getValue(String name, String namespace) { int index = getIndex(name, namespace); @@ -353,7 +347,7 @@ public class Marker extends FObjMixed { } /** - * @see org.xml.sax.Attributes#getValue(String) + * {@inheritDoc} */ public String getValue(String qname) { int index = getIndex(qname); @@ -415,7 +409,7 @@ public class Marker extends FObjMixed { } /** - * @see java.lang.Object#equals(Object) + * {@inheritDoc} */ public boolean equals(Object o) { if (o instanceof MarkerAttribute) { diff --git a/src/java/org/apache/fop/fo/flow/MultiCase.java b/src/java/org/apache/fop/fo/flow/MultiCase.java index a5528a975..42ec9d9d0 100644 --- a/src/java/org/apache/fop/fo/flow/MultiCase.java +++ b/src/java/org/apache/fop/fo/flow/MultiCase.java @@ -23,7 +23,6 @@ import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; -import org.apache.fop.fo.properties.CommonAccessibility; /** * Class modelling the fo:multi-case object. @@ -31,7 +30,6 @@ import org.apache.fop.fo.properties.CommonAccessibility; */ public class MultiCase extends FObj { // The value of properties relevant for fo:multi-case. - private String id; private int startingState; // private ToBeImplementedProperty caseName; // private ToBeImplementedProperty caseTitle; @@ -54,7 +52,7 @@ public class MultiCase extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -70,13 +68,13 @@ public class MultiCase extends FObj { return startingState; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "multi-case"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_MULTI_CASE; diff --git a/src/java/org/apache/fop/fo/flow/MultiProperties.java b/src/java/org/apache/fop/fo/flow/MultiProperties.java index 09b0747c0..00cb85dc7 100644 --- a/src/java/org/apache/fop/fo/flow/MultiProperties.java +++ b/src/java/org/apache/fop/fo/flow/MultiProperties.java @@ -26,7 +26,6 @@ import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; /** * Class modelling the fo:multi-properties object. @@ -56,9 +55,7 @@ public class MultiProperties extends FObj { } /** - * Make sure content model satisfied, if so then tell the - * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!hasMultiPropertySet || !hasWrapper) { @@ -67,7 +64,7 @@ public class MultiProperties extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (multi-property-set+, wrapper) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -89,13 +86,13 @@ public class MultiProperties extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "multi-properties"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_MULTI_PROPERTIES; diff --git a/src/java/org/apache/fop/fo/flow/MultiPropertySet.java b/src/java/org/apache/fop/fo/flow/MultiPropertySet.java index 29ab86810..3c9c55b4f 100644 --- a/src/java/org/apache/fop/fo/flow/MultiPropertySet.java +++ b/src/java/org/apache/fop/fo/flow/MultiPropertySet.java @@ -51,7 +51,7 @@ public class MultiPropertySet extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -59,7 +59,7 @@ public class MultiPropertySet extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -67,13 +67,13 @@ public class MultiPropertySet extends FObj { invalidChildError(loc, nsURI, localName); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "multi-property-set"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_MULTI_PROPERTY_SET; diff --git a/src/java/org/apache/fop/fo/flow/MultiSwitch.java b/src/java/org/apache/fop/fo/flow/MultiSwitch.java index 097b09862..7c70a7346 100644 --- a/src/java/org/apache/fop/fo/flow/MultiSwitch.java +++ b/src/java/org/apache/fop/fo/flow/MultiSwitch.java @@ -27,11 +27,9 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; /** * Class modelling the fo:multi-switch object. - * @todo needs implementation */ public class MultiSwitch extends FObj { // The value of properties relevant for fo:multi-switch. @@ -55,7 +53,7 @@ public class MultiSwitch extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -64,8 +62,7 @@ public class MultiSwitch extends FObj { /** - * Make sure content model satisfied. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -74,7 +71,7 @@ public class MultiSwitch extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (multi-case+) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -84,13 +81,13 @@ public class MultiSwitch extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "multi-switch"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_MULTI_SWITCH; diff --git a/src/java/org/apache/fop/fo/flow/MultiToggle.java b/src/java/org/apache/fop/fo/flow/MultiToggle.java index b8466e073..80b36f9f4 100644 --- a/src/java/org/apache/fop/fo/flow/MultiToggle.java +++ b/src/java/org/apache/fop/fo/flow/MultiToggle.java @@ -27,7 +27,6 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; /** @@ -54,7 +53,7 @@ public class MultiToggle extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { // prSwitchTo = pList.get(PR_SWITCH_TO); @@ -62,7 +61,7 @@ public class MultiToggle extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (#PCDATA|%inline;|%block;)* */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -72,13 +71,13 @@ public class MultiToggle extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "multi-toggle"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_MULTI_TOGGLE; diff --git a/src/java/org/apache/fop/fo/flow/PageNumber.java b/src/java/org/apache/fop/fo/flow/PageNumber.java index 989df2f88..3eca1e16e 100644 --- a/src/java/org/apache/fop/fo/flow/PageNumber.java +++ b/src/java/org/apache/fop/fo/flow/PageNumber.java @@ -30,14 +30,9 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonFont; -import org.apache.fop.fo.properties.CommonMarginInline; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.CommonTextDecoration; -import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.SpaceProperty; /** @@ -83,7 +78,7 @@ public class PageNumber extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -103,7 +98,7 @@ public class PageNumber extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -111,14 +106,14 @@ public class PageNumber extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { getFOEventHandler().endPageNumber(this); } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -181,12 +176,12 @@ public class PageNumber extends FObj { return lineHeight; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "page-number"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_PAGE_NUMBER; } diff --git a/src/java/org/apache/fop/fo/flow/PageNumberCitation.java b/src/java/org/apache/fop/fo/flow/PageNumberCitation.java index d72dd604e..dc824e142 100644 --- a/src/java/org/apache/fop/fo/flow/PageNumberCitation.java +++ b/src/java/org/apache/fop/fo/flow/PageNumberCitation.java @@ -30,14 +30,9 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonFont; -import org.apache.fop.fo.properties.CommonMarginInline; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.CommonTextDecoration; -import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.SpaceProperty; /** @@ -87,7 +82,7 @@ public class PageNumberCitation extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -108,7 +103,7 @@ public class PageNumberCitation extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -118,7 +113,7 @@ public class PageNumberCitation extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -186,12 +181,12 @@ public class PageNumberCitation extends FObj { return refId; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "page-number-citation"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_PAGE_NUMBER_CITATION; } diff --git a/src/java/org/apache/fop/fo/flow/PageNumberCitationLast.java b/src/java/org/apache/fop/fo/flow/PageNumberCitationLast.java index 7bce6cd14..44ef52aec 100644 --- a/src/java/org/apache/fop/fo/flow/PageNumberCitationLast.java +++ b/src/java/org/apache/fop/fo/flow/PageNumberCitationLast.java @@ -38,12 +38,12 @@ public class PageNumberCitationLast extends PageNumberCitation { super(parent); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "page-number-citation-last"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_PAGE_NUMBER_CITATION_LAST; } diff --git a/src/java/org/apache/fop/fo/flow/RetrieveMarker.java b/src/java/org/apache/fop/fo/flow/RetrieveMarker.java index 016f84e47..316d5411a 100644 --- a/src/java/org/apache/fop/fo/flow/RetrieveMarker.java +++ b/src/java/org/apache/fop/fo/flow/RetrieveMarker.java @@ -31,7 +31,7 @@ import org.apache.fop.fo.ValidationException; import org.xml.sax.Locator; /** - * The retrieve-marker formatting object. + * Class modelling the fo:retrieve-marker object. * This will create a layout manager that will retrieve * a marker based on the information. */ @@ -54,7 +54,7 @@ public class RetrieveMarker extends FObjMixed { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { if (findAncestor(FO_STATIC_CONTENT) < 0) { @@ -75,7 +75,7 @@ public class RetrieveMarker extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -203,13 +203,13 @@ public class RetrieveMarker extends FObjMixed { return; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "retrieve-marker"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_RETRIEVE_MARKER; diff --git a/src/java/org/apache/fop/fo/flow/Table.java b/src/java/org/apache/fop/fo/flow/Table.java index dbbfdf94b..b70e5ea21 100644 --- a/src/java/org/apache/fop/fo/flow/Table.java +++ b/src/java/org/apache/fop/fo/flow/Table.java @@ -32,11 +32,8 @@ import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.StaticPropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonMarginBlock; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.LengthPairProperty; import org.apache.fop.fo.properties.LengthRangeProperty; @@ -72,8 +69,6 @@ public class Table extends TableFObj { private Length widowContentLimit; private Length orphanContentLimit; - private static final int MINCOLWIDTH = 10000; // 10pt - /** collection of columns in this table */ protected List columns = null; @@ -106,7 +101,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -155,7 +150,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -163,7 +158,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (marker*,table-column*,table-header?,table-footer?,table-body+) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -212,7 +207,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { @@ -236,7 +231,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { @@ -455,12 +450,12 @@ public class Table extends TableFObj { return orphanContentLimit; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_TABLE; } @@ -496,7 +491,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.flow.TableFObj#flagColumnIndices(int, int) + * {@inheritDoc} */ protected void flagColumnIndices(int start, int end) { for (int i = start; i < end; i++) { @@ -509,7 +504,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#clone(FONode, boolean) + * {@inheritDoc} */ public FONode clone(FONode parent, boolean removeChildren) throws FOPException { diff --git a/src/java/org/apache/fop/fo/flow/TableAndCaption.java b/src/java/org/apache/fop/fo/flow/TableAndCaption.java index d71f6530a..f9eb5b97f 100644 --- a/src/java/org/apache/fop/fo/flow/TableAndCaption.java +++ b/src/java/org/apache/fop/fo/flow/TableAndCaption.java @@ -25,14 +25,7 @@ import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; -import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; -import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonMarginBlock; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; /** * Class modelling the fo:table-and-caption property. @@ -77,7 +70,7 @@ public class TableAndCaption extends FObj { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!tableFound) { @@ -86,7 +79,7 @@ public class TableAndCaption extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* table-caption? table */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -117,13 +110,13 @@ public class TableAndCaption extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-and-caption"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_TABLE_AND_CAPTION; diff --git a/src/java/org/apache/fop/fo/flow/TableBody.java b/src/java/org/apache/fop/fo/flow/TableBody.java index d38d96033..9811a7c15 100644 --- a/src/java/org/apache/fop/fo/flow/TableBody.java +++ b/src/java/org/apache/fop/fo/flow/TableBody.java @@ -21,9 +21,7 @@ package org.apache.fop.fo.flow; // Java import java.util.BitSet; -import java.util.Iterator; import java.util.List; -import java.util.ListIterator; import org.xml.sax.Attributes; import org.xml.sax.Locator; @@ -31,15 +29,9 @@ import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; import org.apache.fop.datatypes.Length; import org.apache.fop.fo.FONode; -import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; -import org.apache.fop.fo.StaticPropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.flow.TableFObj.PendingSpan; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonRelativePosition; /** * Class modelling the fo:table-body object. @@ -54,8 +46,6 @@ public class TableBody extends TableFObj { // private int visibility; // End of property values - private PropertyList savedPropertyList; - /** * used for validation */ @@ -78,17 +68,15 @@ public class TableBody extends TableFObj { } /** - * @see FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps(); super.bind(pList); - //Used by convertCellsToRows() - savedPropertyList = pList; } /** - * @see org.apache.fop.fo.FONode#processNode(String, Locator, Attributes, PropertyList) + * {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) @@ -108,20 +96,18 @@ public class TableBody extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { getFOEventHandler().startBody(this); } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!inMarker()) { - // clean up - savedPropertyList = null; pendingSpans = null; usedColumnIndices = null; } @@ -136,17 +122,11 @@ public class TableBody extends TableFObj { + "Expected: marker* (table-row+|table-cell+)"); getParent().removeChild(this); } - } - - /* - if (tableCellsFound) { - convertCellsToRows(); - } - */ + } } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} String, String) * XSL Content Model: marker* (table-row+|table-cell+) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -180,7 +160,7 @@ public class TableBody extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { if (!inMarker()) { @@ -238,13 +218,13 @@ public class TableBody extends TableFObj { return commonBorderPaddingBackground; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-body"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_TABLE_BODY; @@ -384,7 +364,7 @@ public class TableBody extends TableFObj { } /** - * @see org.apache.fop.fo.flow.TableFObj#flagColumnIndices(int, int) + * {@inheritDoc} */ protected void flagColumnIndices(int start, int end) { for (int i = start; i < end; i++) { diff --git a/src/java/org/apache/fop/fo/flow/TableCaption.java b/src/java/org/apache/fop/fo/flow/TableCaption.java index c1105a41f..dc3188466 100644 --- a/src/java/org/apache/fop/fo/flow/TableCaption.java +++ b/src/java/org/apache/fop/fo/flow/TableCaption.java @@ -23,27 +23,17 @@ package org.apache.fop.fo.flow; import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; -import org.apache.fop.datatypes.Length; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; -import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; -import org.apache.fop.fo.properties.LengthRangeProperty; /** * Class modelling the fo:table-caption object. - * @todo needs implementation */ public class TableCaption extends FObj { // The value of properties relevant for fo:table-caption. - private CommonAccessibility commonAccessibility; - private CommonBorderPaddingBackground commonBorderPaddingBackground; // Unused but valid items, commented out for performance: // private CommonAural commonAural; // private CommonRelativePosition commonRelativePosition; @@ -73,25 +63,14 @@ public class TableCaption extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); - commonAccessibility = pList.getAccessibilityProps(); - commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps(); } /** - * @return the Common Border, Padding, and Background Properties. - */ - public CommonBorderPaddingBackground getCommonBorderPaddingBackground() { - return commonBorderPaddingBackground; - } - - /** - * Make sure content model satisfied, if so then tell the - * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -100,7 +79,7 @@ public class TableCaption extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (%block;) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -116,13 +95,13 @@ public class TableCaption extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-caption"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_TABLE_CAPTION; diff --git a/src/java/org/apache/fop/fo/flow/TableCell.java b/src/java/org/apache/fop/fo/flow/TableCell.java index 3d6f5fb3c..585d670d3 100644 --- a/src/java/org/apache/fop/fo/flow/TableCell.java +++ b/src/java/org/apache/fop/fo/flow/TableCell.java @@ -23,20 +23,14 @@ import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; import org.apache.fop.datatypes.Length; -import org.apache.fop.datatypes.Numeric; import org.apache.fop.fo.FONode; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.LengthRangeProperty; /** * Class modelling the fo:table-cell object. - * @todo check need for all instance variables stored here */ public class TableCell extends TableFObj { // The value of properties relevant for fo:table-cell. @@ -73,7 +67,7 @@ public class TableCell extends TableFObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -90,7 +84,7 @@ public class TableCell extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -100,7 +94,7 @@ public class TableCell extends TableFObj { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!blockItemFound) { @@ -120,7 +114,7 @@ public class TableCell extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -136,7 +130,7 @@ public class TableCell extends TableFObj { } } - /** @see org.apache.fop.fo.FObj#generatesReferenceAreas() */ + /** {@inheritDoc} */ public boolean generatesReferenceAreas() { return true; } @@ -203,13 +197,13 @@ public class TableCell extends TableFObj { return (endsRow == EN_TRUE); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-cell"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public final int getNameId() { return FO_TABLE_CELL; diff --git a/src/java/org/apache/fop/fo/flow/TableColumn.java b/src/java/org/apache/fop/fo/flow/TableColumn.java index d6868e0d6..30fb494f0 100644 --- a/src/java/org/apache/fop/fo/flow/TableColumn.java +++ b/src/java/org/apache/fop/fo/flow/TableColumn.java @@ -67,7 +67,7 @@ public class TableColumn extends TableFObj { /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps(); @@ -111,21 +111,21 @@ public class TableColumn extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode() + * {@inheritDoc} */ protected void startOfNode() throws FOPException { getFOEventHandler().startColumn(this); } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { getFOEventHandler().endColumn(this); } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, @@ -181,12 +181,12 @@ public class TableColumn extends TableFObj { return numberColumnsSpanned; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-column"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_TABLE_COLUMN; } @@ -203,7 +203,7 @@ public class TableColumn extends TableFObj { return defaultColumn; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer("fo:table-column"); sb.append(" column-number=").append(getColumnNumber()); diff --git a/src/java/org/apache/fop/fo/flow/TableFObj.java b/src/java/org/apache/fop/fo/flow/TableFObj.java index ee4029cd7..58fbcb447 100644 --- a/src/java/org/apache/fop/fo/flow/TableFObj.java +++ b/src/java/org/apache/fop/fo/flow/TableFObj.java @@ -32,10 +32,9 @@ import org.apache.fop.fo.expr.PropertyException; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.NumberProperty; import org.apache.fop.fo.properties.Property; -import org.apache.fop.fo.properties.PropertyMaker; /** - * Superclass for table-related FOs + * Common base class for table-related FOs */ public abstract class TableFObj extends FObj { @@ -77,7 +76,7 @@ public abstract class TableFObj extends FObj { } /** - * @see FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -105,7 +104,7 @@ public abstract class TableFObj extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { if (!inMarker() @@ -305,7 +304,7 @@ public abstract class TableFObj extends FObj { } /** - * @see PropertyMaker#make(PropertyList) + * {@inheritDoc} */ public Property make(PropertyList propertyList) throws PropertyException { @@ -333,10 +332,7 @@ public abstract class TableFObj extends FObj { * Return the parent's column index (initial value) in case * of a negative or zero value * - * @see org.apache.fop.fo.properties.PropertyMaker#make( - * org.apache.fop.fo.PropertyList, - * java.lang.String, - * org.apache.fop.fo.FObj) + * @see org.apache.fop.fo.properties.PropertyMaker#make(PropertyList, String, FObj) */ public Property make(PropertyList propertyList, String value, FObj fo) throws PropertyException { diff --git a/src/java/org/apache/fop/fo/flow/TableFooter.java b/src/java/org/apache/fop/fo/flow/TableFooter.java index 82c698c0f..a543ca11f 100644 --- a/src/java/org/apache/fop/fo/flow/TableFooter.java +++ b/src/java/org/apache/fop/fo/flow/TableFooter.java @@ -37,14 +37,14 @@ public class TableFooter extends TableBody { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { //getFOEventHandler().startBody(this); } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { // getFOEventHandler().endFooter(this); @@ -54,12 +54,12 @@ public class TableFooter extends TableBody { // convertCellsToRows(); } - /** @see org.apache.fop.fo.FObj#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-footer"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_TABLE_FOOTER; } diff --git a/src/java/org/apache/fop/fo/flow/TableHeader.java b/src/java/org/apache/fop/fo/flow/TableHeader.java index a487dd072..568303c0d 100644 --- a/src/java/org/apache/fop/fo/flow/TableHeader.java +++ b/src/java/org/apache/fop/fo/flow/TableHeader.java @@ -37,14 +37,14 @@ public class TableHeader extends TableBody { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { //getFOEventHandler().startHeader(this); } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { // getFOEventHandler().endHeader(this); @@ -54,12 +54,12 @@ public class TableHeader extends TableBody { // convertCellsToRows(); } - /** @see org.apache.fop.fo.FObj#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-header"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_TABLE_HEADER; } diff --git a/src/java/org/apache/fop/fo/flow/TableRow.java b/src/java/org/apache/fop/fo/flow/TableRow.java index 74661e304..47ce543db 100644 --- a/src/java/org/apache/fop/fo/flow/TableRow.java +++ b/src/java/org/apache/fop/fo/flow/TableRow.java @@ -30,10 +30,7 @@ import org.apache.fop.datatypes.Length; import org.apache.fop.fo.FONode; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.LengthRangeProperty; @@ -56,8 +53,6 @@ public class TableRow extends TableFObj { // private CommonRelativePosition commonRelativePosition; // private int visibility; // End of property values - - private boolean setup = false; protected List pendingSpans; protected BitSet usedColumnIndices; @@ -70,9 +65,7 @@ public class TableRow extends TableFObj { super(parent); } - /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) - */ + /** {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { blockProgressionDimension = pList.get(PR_BLOCK_PROGRESSION_DIMENSION).getLengthRange(); @@ -86,10 +79,7 @@ public class TableRow extends TableFObj { super.bind(pList); } - /** - * @see org.apache.fop.fo.FONode#processNode(String, Locator, - * Attributes, PropertyList) - */ + /** {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) throws FOPException { if (!inMarker()) { @@ -105,7 +95,7 @@ public class TableRow extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { if (!inMarker()) { @@ -143,7 +133,7 @@ public class TableRow extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -151,7 +141,7 @@ public class TableRow extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -165,7 +155,7 @@ public class TableRow extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} String, String) * XSL Content Model: (table-cell+) */ protected void validateChildNode(Locator loc, String nsURI, @@ -252,12 +242,12 @@ public class TableRow extends TableFObj { return commonBorderPaddingBackground; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-row"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_TABLE_ROW; } @@ -294,7 +284,7 @@ public class TableRow extends TableFObj { } /** - * @see org.apache.fop.fo.flow.TableFObj#flagColumnIndices(int, int) + * {@inheritDoc} */ protected void flagColumnIndices(int start, int end) { for (int i = start; i < end; i++) { diff --git a/src/java/org/apache/fop/fo/flow/Wrapper.java b/src/java/org/apache/fop/fo/flow/Wrapper.java index b75ff42cb..c7ca33a10 100644 --- a/src/java/org/apache/fop/fo/flow/Wrapper.java +++ b/src/java/org/apache/fop/fo/flow/Wrapper.java @@ -19,18 +19,15 @@ package org.apache.fop.fo.flow; -// Java -import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObjMixed; -import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; import org.xml.sax.Locator; /** - * Implementation for fo:wrapper formatting object. - * The wrapper object serves as - * a property holder for its child node objects. + * Class modelling the fo:wrapper object. + * The wrapper object serves as a property holder for + * its child node objects. */ public class Wrapper extends FObjMixed { // The value of properties relevant for fo:wrapper. @@ -47,7 +44,7 @@ public class Wrapper extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (#PCDATA|%inline;|%block;)* * Additionally (unimplemented): "An fo:wrapper that is a child of an * fo:multi-properties is only permitted to have children that would @@ -67,14 +64,12 @@ public class Wrapper extends FObjMixed { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "wrapper"; } - /** - * @see org.apache.fop.fo.FObj#getNameId() - */ + /** {@inheritDoc} */ public int getNameId() { return FO_WRAPPER; } diff --git a/src/java/org/apache/fop/fo/pagination/ColorProfile.java b/src/java/org/apache/fop/fo/pagination/ColorProfile.java index fe379c6af..9318a8896 100644 --- a/src/java/org/apache/fop/fo/pagination/ColorProfile.java +++ b/src/java/org/apache/fop/fo/pagination/ColorProfile.java @@ -46,7 +46,7 @@ public class ColorProfile extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { src = pList.get(PR_SRC).getString(); @@ -55,7 +55,7 @@ public class ColorProfile extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL 1.0/FOP: EMPTY (no child nodes permitted) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -70,13 +70,13 @@ public class ColorProfile extends FObj { return colorProfileName; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "color-profile"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_COLOR_PROFILE; diff --git a/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java b/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java index 4076140aa..c3d705de2 100644 --- a/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java +++ b/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java @@ -52,7 +52,7 @@ public class ConditionalPageMasterReference extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { masterReference = pList.get(PR_MASTER_REFERENCE).getString(); @@ -66,7 +66,7 @@ public class ConditionalPageMasterReference extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { getConcreteParent().addConditionalPageMasterReference(this); @@ -77,7 +77,7 @@ public class ConditionalPageMasterReference extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -154,12 +154,12 @@ public class ConditionalPageMasterReference extends FObj { return this.pagePosition; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "conditional-page-master-reference"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_CONDITIONAL_PAGE_MASTER_REFERENCE; } diff --git a/src/java/org/apache/fop/fo/pagination/Declarations.java b/src/java/org/apache/fop/fo/pagination/Declarations.java index 7232af1ae..9dc282d07 100644 --- a/src/java/org/apache/fop/fo/pagination/Declarations.java +++ b/src/java/org/apache/fop/fo/pagination/Declarations.java @@ -26,7 +26,6 @@ import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; -import org.apache.fop.fo.FONode.FONodeIterator; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; @@ -51,14 +50,14 @@ public class Declarations extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { // No properties defined for fo:declarations } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL 1.0: (color-profile)+ (and non-XSL NS nodes) * FOP/XSL 1.1: (color-profile)* (and non-XSL NS nodes) */ @@ -74,7 +73,6 @@ public class Declarations extends FObj { /** * At the end of this element sort out the children into * a hashmap of color profiles and a list of extension attachments. - * @see org.apache.fop.fo.FONode#endOfNode() */ protected void endOfNode() throws FOPException { if (firstChild != null) { @@ -109,14 +107,14 @@ public class Declarations extends FObj { } /** - * @see org.apache.fop.fo.FObj#getName() + * {@inheritDoc} */ public String getLocalName() { return "declarations"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_DECLARATIONS; diff --git a/src/java/org/apache/fop/fo/pagination/Flow.java b/src/java/org/apache/fop/fo/pagination/Flow.java index 0962df5d7..fc5d605cc 100644 --- a/src/java/org/apache/fop/fo/pagination/Flow.java +++ b/src/java/org/apache/fop/fo/pagination/Flow.java @@ -46,14 +46,14 @@ public class Flow extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { flowName = pList.get(PR_FLOW_NAME).getString(); } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { if (flowName == null || flowName.equals("")) { @@ -83,7 +83,6 @@ public class Flow extends FObj { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode */ protected void endOfNode() throws FOPException { if (!blockItemFound) { @@ -93,7 +92,7 @@ public class Flow extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -121,13 +120,13 @@ public class Flow extends FObj { return flowName; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "flow"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_FLOW; diff --git a/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java b/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java index e749044bb..54eb29744 100644 --- a/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java +++ b/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java @@ -53,14 +53,14 @@ public class LayoutMasterSet extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { // No properties in layout-master-set. } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { getRoot().setLayoutMasterSet(this); @@ -69,7 +69,7 @@ public class LayoutMasterSet extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -79,7 +79,7 @@ public class LayoutMasterSet extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: (simple-page-master|page-sequence-master)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -215,13 +215,13 @@ public class LayoutMasterSet extends FObj { return false; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "layout-master-set"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_LAYOUT_MASTER_SET; diff --git a/src/java/org/apache/fop/fo/pagination/PageSequence.java b/src/java/org/apache/fop/fo/pagination/PageSequence.java index 135382800..f8f9f9277 100644 --- a/src/java/org/apache/fop/fo/pagination/PageSequence.java +++ b/src/java/org/apache/fop/fo/pagination/PageSequence.java @@ -92,7 +92,7 @@ public class PageSequence extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -112,7 +112,7 @@ public class PageSequence extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode() + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -136,7 +136,7 @@ public class PageSequence extends FObj { getFOEventHandler().startPageSequence(this); } - /** @see org.apache.fop.fo.FONode#endOfNode() */ + /** {@inheritDoc} */ protected void endOfNode() throws FOPException { if (mainFlow == null) { missingChildElementError("(title?,static-content*,flow)"); @@ -146,7 +146,7 @@ public class PageSequence extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL Content Model: (title?,static-content*,flow) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -177,7 +177,7 @@ public class PageSequence extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} * @todo see if addChildNode() should also be called for fo's other than * fo:flow. */ @@ -501,12 +501,12 @@ public class PageSequence extends FObj { return masterReference; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "page-sequence"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_PAGE_SEQUENCE; } diff --git a/src/java/org/apache/fop/fo/pagination/PageSequenceMaster.java b/src/java/org/apache/fop/fo/pagination/PageSequenceMaster.java index efca3f740..fd3484ee6 100644 --- a/src/java/org/apache/fop/fo/pagination/PageSequenceMaster.java +++ b/src/java/org/apache/fop/fo/pagination/PageSequenceMaster.java @@ -60,7 +60,7 @@ public class PageSequenceMaster extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { masterName = pList.get(PR_MASTER_NAME).getString(); @@ -71,7 +71,7 @@ public class PageSequenceMaster extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode() + * {@inheritDoc} */ protected void startOfNode() throws FOPException { subSequenceSpecifiers = new java.util.ArrayList(); @@ -80,7 +80,7 @@ public class PageSequenceMaster extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode() + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -90,7 +90,7 @@ public class PageSequenceMaster extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL/FOP: (single-page-master-reference|repeatable-page-master-reference| * repeatable-page-master-alternatives)+ */ @@ -224,13 +224,13 @@ public class PageSequenceMaster extends FObj { return pageMaster; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "page-sequence-master"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_PAGE_SEQUENCE_MASTER; diff --git a/src/java/org/apache/fop/fo/pagination/PageSequenceWrapper.java b/src/java/org/apache/fop/fo/pagination/PageSequenceWrapper.java index b57befaba..94c0314a3 100644 --- a/src/java/org/apache/fop/fo/pagination/PageSequenceWrapper.java +++ b/src/java/org/apache/fop/fo/pagination/PageSequenceWrapper.java @@ -46,7 +46,7 @@ public class PageSequenceWrapper extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -55,7 +55,7 @@ public class PageSequenceWrapper extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: (bookmark+) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -76,13 +76,13 @@ public class PageSequenceWrapper extends FObj { return indexKey; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "page-sequence-wrapper"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_PAGE_SEQUENCE_WRAPPER; diff --git a/src/java/org/apache/fop/fo/pagination/Region.java b/src/java/org/apache/fop/fo/pagination/Region.java index 642a2e490..2516f90d8 100644 --- a/src/java/org/apache/fop/fo/pagination/Region.java +++ b/src/java/org/apache/fop/fo/pagination/Region.java @@ -58,7 +58,7 @@ public abstract class Region extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps(); @@ -92,7 +92,7 @@ public abstract class Region extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} String, String) * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -131,7 +131,7 @@ public abstract class Region extends FObj { } /** - * @see org.apache.fop.fo.FObj#generatesReferenceAreas() + * {@inheritDoc} */ public boolean generatesReferenceAreas() { return true; diff --git a/src/java/org/apache/fop/fo/pagination/RegionAfter.java b/src/java/org/apache/fop/fo/pagination/RegionAfter.java index 455f994ed..9459a6637 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionAfter.java +++ b/src/java/org/apache/fop/fo/pagination/RegionAfter.java @@ -41,7 +41,7 @@ public class RegionAfter extends RegionBA { } /** - * @see org.apache.fop.fo.pagination.Region#getViewportRectangle(FODimension, SimplePageMaster) + * {@inheritDoc} */ public Rectangle getViewportRectangle (FODimension reldims, SimplePageMaster spm) { /* Special rules apply to resolving extent as values are resolved relative @@ -83,19 +83,19 @@ public class RegionAfter extends RegionBA { } /** - * @see org.apache.fop.fo.pagination.Region#getDefaultRegionName() + * {@inheritDoc} */ protected String getDefaultRegionName() { return "xsl-region-after"; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "region-after"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_REGION_AFTER; diff --git a/src/java/org/apache/fop/fo/pagination/RegionBA.java b/src/java/org/apache/fop/fo/pagination/RegionBA.java index fff3fb26f..768af2489 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionBA.java +++ b/src/java/org/apache/fop/fo/pagination/RegionBA.java @@ -43,7 +43,7 @@ public abstract class RegionBA extends SideRegion { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); diff --git a/src/java/org/apache/fop/fo/pagination/RegionBefore.java b/src/java/org/apache/fop/fo/pagination/RegionBefore.java index adb85681b..6115d8dd8 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionBefore.java +++ b/src/java/org/apache/fop/fo/pagination/RegionBefore.java @@ -40,14 +40,14 @@ public class RegionBefore extends RegionBA { } /** - * @see org.apache.fop.fo.pagination.Region#getDefaultRegionName() + * {@inheritDoc} */ protected String getDefaultRegionName() { return "xsl-region-before"; } /** - * @see org.apache.fop.fo.pagination.Region#getViewportRectangle(FODimension, SimplePageMaster) + * {@inheritDoc} */ public Rectangle getViewportRectangle (FODimension reldims, SimplePageMaster spm) { /* Special rules apply to resolving extent as values are resolved relative @@ -86,13 +86,13 @@ public class RegionBefore extends RegionBA { return vpRect; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "region-before"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_REGION_BEFORE; diff --git a/src/java/org/apache/fop/fo/pagination/RegionBody.java b/src/java/org/apache/fop/fo/pagination/RegionBody.java index d6fbb8d96..4de2dd1b4 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionBody.java +++ b/src/java/org/apache/fop/fo/pagination/RegionBody.java @@ -50,7 +50,7 @@ public class RegionBody extends Region { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -94,7 +94,7 @@ public class RegionBody extends Region { } /** - * @see org.apache.fop.fo.pagination.Region#getViewportRectangle(FODimension, SimplePageMaster) + * {@inheritDoc} */ public Rectangle getViewportRectangle (FODimension reldims, SimplePageMaster spm) { /* Special rules apply to resolving margins in the page context. @@ -144,19 +144,19 @@ public class RegionBody extends Region { } /** - * @see org.apache.fop.fo.pagination.Region#getDefaultRegionName() + * {@inheritDoc} */ protected String getDefaultRegionName() { return "xsl-region-body"; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "region-body"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_REGION_BODY; diff --git a/src/java/org/apache/fop/fo/pagination/RegionEnd.java b/src/java/org/apache/fop/fo/pagination/RegionEnd.java index 5420b756b..912be9097 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionEnd.java +++ b/src/java/org/apache/fop/fo/pagination/RegionEnd.java @@ -40,7 +40,7 @@ public class RegionEnd extends RegionSE { } /** - * @see org.apache.fop.fo.pagination.Region#getViewportRectangle(FODimension, SimplePageMaster) + * {@inheritDoc} */ public Rectangle getViewportRectangle (FODimension reldims, SimplePageMaster spm) { /* Special rules apply to resolving extent as values are resolved relative @@ -81,19 +81,19 @@ public class RegionEnd extends RegionSE { } /** - * @see org.apache.fop.fo.pagination.Region#getDefaultRegionName() + * {@inheritDoc} */ protected String getDefaultRegionName() { return "xsl-region-end"; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "region-end"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_REGION_END; diff --git a/src/java/org/apache/fop/fo/pagination/RegionSE.java b/src/java/org/apache/fop/fo/pagination/RegionSE.java index ac56d6e10..735623352 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionSE.java +++ b/src/java/org/apache/fop/fo/pagination/RegionSE.java @@ -42,7 +42,7 @@ public abstract class RegionSE extends SideRegion { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); diff --git a/src/java/org/apache/fop/fo/pagination/RegionStart.java b/src/java/org/apache/fop/fo/pagination/RegionStart.java index f702c3b78..d78b19c3d 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionStart.java +++ b/src/java/org/apache/fop/fo/pagination/RegionStart.java @@ -40,7 +40,7 @@ public class RegionStart extends RegionSE { } /** - * @see org.apache.fop.fo.pagination.Region#getViewportRectangle(FODimension, SimplePageMaster) + * {@inheritDoc} */ public Rectangle getViewportRectangle (FODimension reldims, SimplePageMaster spm) { /* Special rules apply to resolving extent as values are resolved relative @@ -78,19 +78,19 @@ public class RegionStart extends RegionSE { } /** - * @see org.apache.fop.fo.pagination.Region#getDefaultRegionName() + * {@inheritDoc} */ protected String getDefaultRegionName() { return "xsl-region-start"; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "region-start"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_REGION_START; diff --git a/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterAlternatives.java b/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterAlternatives.java index 521a70787..012abd11a 100644 --- a/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterAlternatives.java +++ b/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterAlternatives.java @@ -58,14 +58,14 @@ public class RepeatablePageMasterAlternatives extends FObj } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { maximumRepeats = pList.get(PR_MAXIMUM_REPEATS); } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { conditionalPageMasterRefs = new java.util.ArrayList(); @@ -81,7 +81,7 @@ public class RepeatablePageMasterAlternatives extends FObj } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -90,7 +90,7 @@ public class RepeatablePageMasterAlternatives extends FObj } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: (conditional-page-master-reference+) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -157,12 +157,12 @@ public class RepeatablePageMasterAlternatives extends FObj } } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#reset() */ + /** {@inheritDoc} */ public void reset() { this.numberConsumed = 0; } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#goToPrevious() */ + /** {@inheritDoc} */ public boolean goToPrevious() { if (numberConsumed == 0) { return false; @@ -172,17 +172,17 @@ public class RepeatablePageMasterAlternatives extends FObj } } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#hasPagePositionLast() */ + /** {@inheritDoc} */ public boolean hasPagePositionLast() { return this.hasPagePositionLast; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "repeatable-page-master-alternatives"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_REPEATABLE_PAGE_MASTER_ALTERNATIVES; } diff --git a/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterReference.java b/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterReference.java index 1f79d317b..dfd6ff6a9 100644 --- a/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterReference.java +++ b/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterReference.java @@ -54,7 +54,7 @@ public class RepeatablePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { masterReference = pList.get(PR_MASTER_REFERENCE).getString(); @@ -66,7 +66,7 @@ public class RepeatablePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { PageSequenceMaster pageSequenceMaster = (PageSequenceMaster) parent; @@ -79,7 +79,7 @@ public class RepeatablePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -88,7 +88,7 @@ public class RepeatablePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.pagination.SubSequenceSpecifier + * {@inheritDoc} */ public String getNextPageMasterName(boolean isOddPage, boolean isFirstPage, @@ -119,13 +119,13 @@ public class RepeatablePageMasterReference extends FObj } } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#reset() */ + /** {@inheritDoc} */ public void reset() { this.numberConsumed = 0; } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#goToPrevious() */ + /** {@inheritDoc} */ public boolean goToPrevious() { if (numberConsumed == 0) { return false; @@ -135,17 +135,17 @@ public class RepeatablePageMasterReference extends FObj } } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#hasPagePositionLast() */ + /** {@inheritDoc} */ public boolean hasPagePositionLast() { return false; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "repeatable-page-master-reference"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_REPEATABLE_PAGE_MASTER_REFERENCE; } diff --git a/src/java/org/apache/fop/fo/pagination/Root.java b/src/java/org/apache/fop/fo/pagination/Root.java index 929c721ec..2e2c38b82 100644 --- a/src/java/org/apache/fop/fo/pagination/Root.java +++ b/src/java/org/apache/fop/fo/pagination/Root.java @@ -73,7 +73,7 @@ public class Root extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { mediaUsage = pList.get(PR_MEDIA_USAGE).getEnum(); @@ -90,7 +90,7 @@ public class Root extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL 1.0 Spec: (layout-master-set,declarations?,page-sequence+) FOP: (layout-master-set, declarations?, fox:bookmarks?, page-sequence+) */ @@ -281,19 +281,19 @@ public class Root extends FObj { } /** - * @see org.apache.fop.fo.FONode#getRoot() + * {@inheritDoc} */ public Root getRoot() { return this; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "root"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_ROOT; diff --git a/src/java/org/apache/fop/fo/pagination/SideRegion.java b/src/java/org/apache/fop/fo/pagination/SideRegion.java index 41786c83d..14328aa9b 100644 --- a/src/java/org/apache/fop/fo/pagination/SideRegion.java +++ b/src/java/org/apache/fop/fo/pagination/SideRegion.java @@ -36,7 +36,7 @@ public abstract class SideRegion extends Region { super(parent); } - /** @see org.apache.fop.fo.FObj#bind(PropertyList) */ + /** {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); extent = pList.get(PR_EXTENT).getLength(); diff --git a/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java b/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java index e26d27d63..ba1c0a6af 100644 --- a/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java +++ b/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java @@ -70,7 +70,7 @@ public class SimplePageMaster extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { commonMarginBlock = pList.getMarginBlockProps(); @@ -86,7 +86,7 @@ public class SimplePageMaster extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { LayoutMasterSet layoutMasterSet = (LayoutMasterSet) parent; @@ -103,7 +103,6 @@ public class SimplePageMaster extends FObj { /** * Make sure content model satisfied. - * @see org.apache.fop.fo.FONode#endOfNode */ protected void endOfNode() throws FOPException { if (!hasRegionBody) { @@ -113,7 +112,7 @@ public class SimplePageMaster extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (region-body,region-before?,region-after?,region-start?,region-end?) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -174,14 +173,14 @@ public class SimplePageMaster extends FObj { } /** - * @see org.apache.fop.fo.FObj#generatesReferenceAreas() + * {@inheritDoc} */ public boolean generatesReferenceAreas() { return true; } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { if (child instanceof Region) { @@ -264,13 +263,13 @@ public class SimplePageMaster extends FObj { return referenceOrientation.getValue(); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "simple-page-master"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_SIMPLE_PAGE_MASTER; diff --git a/src/java/org/apache/fop/fo/pagination/SinglePageMasterReference.java b/src/java/org/apache/fop/fo/pagination/SinglePageMasterReference.java index 623b50de7..68be2b82e 100644 --- a/src/java/org/apache/fop/fo/pagination/SinglePageMasterReference.java +++ b/src/java/org/apache/fop/fo/pagination/SinglePageMasterReference.java @@ -54,7 +54,7 @@ public class SinglePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { masterReference = pList.get(PR_MASTER_REFERENCE).getString(); @@ -65,7 +65,7 @@ public class SinglePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { PageSequenceMaster pageSequenceMaster = (PageSequenceMaster) parent; @@ -73,7 +73,7 @@ public class SinglePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -81,7 +81,7 @@ public class SinglePageMasterReference extends FObj invalidChildError(loc, nsURI, localName); } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier */ + /** {@inheritDoc} */ public String getNextPageMasterName(boolean isOddPage, boolean isFirstPage, boolean isLastPage, @@ -94,14 +94,14 @@ public class SinglePageMasterReference extends FObj } } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#reset() */ + /** {@inheritDoc} */ public void reset() { this.state = FIRST; } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#goToPrevious() */ + /** {@inheritDoc} */ public boolean goToPrevious() { if (state == FIRST) { return false; @@ -111,17 +111,17 @@ public class SinglePageMasterReference extends FObj } } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#hasPagePositionLast() */ + /** {@inheritDoc} */ public boolean hasPagePositionLast() { return false; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "single-page-master-reference"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_SINGLE_PAGE_MASTER_REFERENCE; } diff --git a/src/java/org/apache/fop/fo/pagination/StaticContent.java b/src/java/org/apache/fop/fo/pagination/StaticContent.java index cd55609cd..62d73e56d 100644 --- a/src/java/org/apache/fop/fo/pagination/StaticContent.java +++ b/src/java/org/apache/fop/fo/pagination/StaticContent.java @@ -39,7 +39,7 @@ public class StaticContent extends Flow { } /** - * @see org.apache.fop.fo.FONode#startOfNode() + * {@inheritDoc} */ protected void startOfNode() throws FOPException { if (getFlowName() == null || getFlowName().equals("")) { @@ -52,7 +52,7 @@ public class StaticContent extends Flow { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null && getUserAgent().validateStrictly()) { @@ -62,7 +62,7 @@ public class StaticContent extends Flow { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -72,12 +72,12 @@ public class StaticContent extends Flow { } } - /** @see org.apache.fop.fo.FObj#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "static-content"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_STATIC_CONTENT; } diff --git a/src/java/org/apache/fop/fo/pagination/Title.java b/src/java/org/apache/fop/fo/pagination/Title.java index 92c6e8f24..398424152 100644 --- a/src/java/org/apache/fop/fo/pagination/Title.java +++ b/src/java/org/apache/fop/fo/pagination/Title.java @@ -42,7 +42,7 @@ public class Title extends InlineLevel { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} String, String) XSL/FOP: (#PCDATA|%inline;)* */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -53,14 +53,14 @@ public class Title extends InlineLevel { } /** - * @see org.apache.fop.fo.FObj#getName() + * {@inheritDoc} */ public String getLocalName() { return "title"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_TITLE; diff --git a/src/java/org/apache/fop/fo/pagination/bookmarks/Bookmark.java b/src/java/org/apache/fop/fo/pagination/bookmarks/Bookmark.java index 9786a3db9..e588bb3f8 100644 --- a/src/java/org/apache/fop/fo/pagination/bookmarks/Bookmark.java +++ b/src/java/org/apache/fop/fo/pagination/bookmarks/Bookmark.java @@ -26,7 +26,6 @@ import org.apache.fop.fo.FObj; import org.apache.fop.fo.FONode; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; /** @@ -39,10 +38,13 @@ public class Bookmark extends FObj { private ArrayList childBookmarks = new ArrayList(); // The value of properties relevant for this FO - private CommonAccessibility commonAccessibility; private String internalDestination; private String externalDestination; private boolean bShow = true; // from starting-state property + + // Valid, but unused properties. Commented out for performance + // private CommonAccessibility commonAccessibility; + /** * Create a new bookmark object. @@ -54,10 +56,9 @@ public class Bookmark extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { - commonAccessibility = pList.getAccessibilityProps(); externalDestination = pList.get(PR_EXTERNAL_DESTINATION).getString(); internalDestination = pList.get(PR_INTERNAL_DESTINATION).getString(); bShow = (pList.get(PR_STARTING_STATE).getEnum() == EN_SHOW); @@ -75,7 +76,7 @@ public class Bookmark extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: (bookmark-title, bookmark*) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -94,7 +95,7 @@ public class Bookmark extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (bookmarkTitle == null) { @@ -103,7 +104,7 @@ public class Bookmark extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode obj) { if (obj instanceof BookmarkTitle) { @@ -144,13 +145,13 @@ public class Bookmark extends FObj { return childBookmarks; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "bookmark"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_BOOKMARK; diff --git a/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java b/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java index b7c5fc8c5..f31aad1cb 100644 --- a/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java +++ b/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java @@ -60,7 +60,7 @@ public class BookmarkTitle extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -77,13 +77,13 @@ public class BookmarkTitle extends FObj { return title; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "bookmark-title"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_BOOKMARK_TITLE; diff --git a/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTree.java b/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTree.java index 1b743d763..6190fa22a 100644 --- a/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTree.java +++ b/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTree.java @@ -46,7 +46,7 @@ public class BookmarkTree extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode obj) { if (obj instanceof Bookmark) { @@ -55,7 +55,7 @@ public class BookmarkTree extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (bookmarks == null) { @@ -65,7 +65,7 @@ public class BookmarkTree extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: (bookmark+) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -80,13 +80,13 @@ public class BookmarkTree extends FObj { return bookmarks; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "bookmark-tree"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_BOOKMARK_TREE; diff --git a/src/java/org/apache/fop/fo/properties/BackgroundPositionShorthandParser.java b/src/java/org/apache/fop/fo/properties/BackgroundPositionShorthandParser.java index 8bf79a242..76c934234 100644 --- a/src/java/org/apache/fop/fo/properties/BackgroundPositionShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/BackgroundPositionShorthandParser.java @@ -31,7 +31,7 @@ import org.apache.fop.fo.expr.PropertyException; public class BackgroundPositionShorthandParser extends GenericShorthandParser { /** - * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, diff --git a/src/java/org/apache/fop/fo/properties/BorderWidthPropertyMaker.java b/src/java/org/apache/fop/fo/properties/BorderWidthPropertyMaker.java index 819cae5d0..b828de285 100644 --- a/src/java/org/apache/fop/fo/properties/BorderWidthPropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/BorderWidthPropertyMaker.java @@ -50,7 +50,7 @@ public class BorderWidthPropertyMaker extends LengthProperty.Maker { /** * Check the value of the style property and return a length of 0 when * the style is NONE. - * @see org.apache.fop.fo.properties.PropertyMaker#get(int, PropertyList, boolean, boolean) + * {@inheritDoc} */ public Property get(int subpropId, PropertyList propertyList, diff --git a/src/java/org/apache/fop/fo/properties/BoxPropShorthandParser.java b/src/java/org/apache/fop/fo/properties/BoxPropShorthandParser.java index f568e5123..c71bc830f 100644 --- a/src/java/org/apache/fop/fo/properties/BoxPropShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/BoxPropShorthandParser.java @@ -38,7 +38,7 @@ public class BoxPropShorthandParser extends GenericShorthandParser { * Stores 1 to 4 values of same type. * Set the given property based on the number of values set. * Example: padding, border-width, border-color, border-style, margin - * @see org.apache.fop.fo.properties.GenericShorthandParser#convertValueForProperty( + * {@inheritDoc} * int, Property, PropertyMaker, PropertyList) */ protected Property convertValueForProperty(int propId, diff --git a/src/java/org/apache/fop/fo/properties/ColorProperty.java b/src/java/org/apache/fop/fo/properties/ColorProperty.java index c49546862..5eb399d3d 100644 --- a/src/java/org/apache/fop/fo/properties/ColorProperty.java +++ b/src/java/org/apache/fop/fo/properties/ColorProperty.java @@ -65,9 +65,6 @@ public class ColorProperty extends Property { * can't be converted to the correct type. * @throws PropertyException * for invalid or inconsistent FO input - * @see org.apache.fop.fo.properties.PropertyMaker#convertProperty( - * org.apache.fop.fo.properties.Property, - * org.apache.fop.fo.PropertyList, org.apache.fop.fo.FObj) */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) @@ -93,7 +90,7 @@ public class ColorProperty extends Property { * @param foUserAgent FOP user agent * @param value RGB value as String to be parsed * @throws PropertyException if the value can't be parsed - * @see ColorUtil#parseColorString(String) + * @see ColorUtil#parseColorString(FOUserAgent, String) */ public ColorProperty(FOUserAgent foUserAgent, String value) throws PropertyException { this.color = ColorUtil.parseColorString(foUserAgent, value); @@ -118,7 +115,7 @@ public class ColorProperty extends Property { } /** - * @see java.lang.Object#toString() + * {@inheritDoc} */ public String toString() { return ColorUtil.colorToString(color); diff --git a/src/java/org/apache/fop/fo/properties/CommonBorderPaddingBackground.java b/src/java/org/apache/fop/fo/properties/CommonBorderPaddingBackground.java index 8697cc978..712ae9703 100755 --- a/src/java/org/apache/fop/fo/properties/CommonBorderPaddingBackground.java +++ b/src/java/org/apache/fop/fo/properties/CommonBorderPaddingBackground.java @@ -111,7 +111,7 @@ public class CommonBorderPaddingBackground { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer("BorderInfo"); sb.append(" {"); @@ -367,7 +367,7 @@ public class CommonBorderPaddingBackground { + getBorderBeforeWidth(bDiscard) + getBorderAfterWidth(bDiscard); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "CommonBordersAndPadding (Before, After, Start, End):\n" + "Borders: (" + getBorderBeforeWidth(false) + ", " + getBorderAfterWidth(false) + ", " diff --git a/src/java/org/apache/fop/fo/properties/CommonFont.java b/src/java/org/apache/fop/fo/properties/CommonFont.java index 8c157e45e..d0d38223f 100755 --- a/src/java/org/apache/fop/fo/properties/CommonFont.java +++ b/src/java/org/apache/fop/fo/properties/CommonFont.java @@ -30,7 +30,6 @@ import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.expr.PropertyException; import org.apache.fop.fonts.Font; import org.apache.fop.fonts.FontInfo; -import org.apache.fop.fonts.FontMetrics; import org.apache.fop.fonts.FontTriplet; /** diff --git a/src/java/org/apache/fop/fo/properties/CommonMarginBlock.java b/src/java/org/apache/fop/fo/properties/CommonMarginBlock.java index 93d0868e0..6ca9e5817 100644 --- a/src/java/org/apache/fop/fo/properties/CommonMarginBlock.java +++ b/src/java/org/apache/fop/fo/properties/CommonMarginBlock.java @@ -87,7 +87,7 @@ public class CommonMarginBlock { endIndent = pList.get(Constants.PR_END_INDENT).getLength(); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "CommonMarginBlock:\n" + "Margins (top, bottom, left, right): (" diff --git a/src/java/org/apache/fop/fo/properties/CompoundPropertyMaker.java b/src/java/org/apache/fop/fo/properties/CompoundPropertyMaker.java index 39b2289a9..9852d5fdf 100644 --- a/src/java/org/apache/fop/fo/properties/CompoundPropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/CompoundPropertyMaker.java @@ -55,7 +55,7 @@ public class CompoundPropertyMaker extends PropertyMaker { } /** - * @see org.apache.fop.fo.properties.PropertyMaker#useGeneric(PropertyMaker) + * {@inheritDoc} */ public void useGeneric(PropertyMaker generic) { super.useGeneric(generic); diff --git a/src/java/org/apache/fop/fo/properties/CondLengthProperty.java b/src/java/org/apache/fop/fo/properties/CondLengthProperty.java index 638f525b1..34e72b09d 100644 --- a/src/java/org/apache/fop/fo/properties/CondLengthProperty.java +++ b/src/java/org/apache/fop/fo/properties/CondLengthProperty.java @@ -32,7 +32,7 @@ import org.apache.fop.fo.expr.PropertyException; */ public class CondLengthProperty extends Property implements CompoundDatatype { private Property length; - private Property conditionality; + private EnumProperty conditionality; /** * Inner class for creating instances of CondLengthProperty @@ -55,7 +55,7 @@ public class CondLengthProperty extends Property implements CompoundDatatype { } /** - * @see CompoundPropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) throws PropertyException { @@ -67,19 +67,19 @@ public class CondLengthProperty extends Property implements CompoundDatatype { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#setComponent(int, Property, boolean) + * {@inheritDoc} */ public void setComponent(int cmpId, Property cmpnValue, boolean bIsDefault) { if (cmpId == CP_LENGTH) { length = cmpnValue; } else if (cmpId == CP_CONDITIONALITY) { - conditionality = cmpnValue; + conditionality = (EnumProperty)cmpnValue; } } /** - * @see org.apache.fop.datatypes.CompoundDatatype#getComponent(int) + * {@inheritDoc} */ public Property getComponent(int cmpId) { if (cmpId == CP_LENGTH) { @@ -132,7 +132,7 @@ public class CondLengthProperty extends Property implements CompoundDatatype { return this.length.getLength().getValue(context); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "CondLength[" + length.getObject().toString() + ", " + (isDiscard() diff --git a/src/java/org/apache/fop/fo/properties/EnumLength.java b/src/java/org/apache/fop/fo/properties/EnumLength.java index efa1475ab..95b759356 100755 --- a/src/java/org/apache/fop/fo/properties/EnumLength.java +++ b/src/java/org/apache/fop/fo/properties/EnumLength.java @@ -32,7 +32,7 @@ public class EnumLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getEnum() + * {@inheritDoc} */ public int getEnum() { return enumProperty.getEnum(); @@ -43,7 +43,7 @@ public class EnumLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getValue() + * {@inheritDoc} */ public int getValue() { log.error("getValue() called on " + enumProperty + " length"); @@ -51,7 +51,7 @@ public class EnumLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getValue(PercentBaseContext) + * {@inheritDoc} */ public int getValue(PercentBaseContext context) { log.error("getValue() called on " + enumProperty + " length"); @@ -59,7 +59,7 @@ public class EnumLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue() { log.error("getNumericValue() called on " + enumProperty + " number"); @@ -67,7 +67,7 @@ public class EnumLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue(PercentBaseContext context) { log.error("getNumericValue() called on " + enumProperty + " number"); @@ -75,14 +75,14 @@ public class EnumLength extends LengthProperty { } /** - * @see org.apache.fop.fo.properties.Property#getString() + * {@inheritDoc} */ public String getString() { return enumProperty.toString(); } /** - * @see org.apache.fop.fo.properties.Property#getString() + * {@inheritDoc} */ public Object getObject() { return enumProperty.getObject(); diff --git a/src/java/org/apache/fop/fo/properties/EnumNumber.java b/src/java/org/apache/fop/fo/properties/EnumNumber.java index f8e940b01..fcd596d7e 100755 --- a/src/java/org/apache/fop/fo/properties/EnumNumber.java +++ b/src/java/org/apache/fop/fo/properties/EnumNumber.java @@ -72,21 +72,21 @@ public class EnumNumber extends NumberProperty { } /** - * @see org.apache.fop.fo.properties.Property#getString() + * {@inheritDoc} */ public String getString() { return enumProperty.toString(); } /** - * @see org.apache.fop.fo.properties.Property#getString() + * {@inheritDoc} */ public Object getObject() { return enumProperty.getObject(); } /** - * @see java.lang.Object#equals(Object) + * {@inheritDoc} */ public boolean equals(Object obj) { if (obj instanceof EnumNumber) { @@ -97,7 +97,7 @@ public class EnumNumber extends NumberProperty { } /** - * @see java.lang.Object#hashCode() + * {@inheritDoc} */ public int hashCode() { return enumProperty.hashCode(); diff --git a/src/java/org/apache/fop/fo/properties/EnumProperty.java b/src/java/org/apache/fop/fo/properties/EnumProperty.java index f9801e222..b5435b0f1 100644 --- a/src/java/org/apache/fop/fo/properties/EnumProperty.java +++ b/src/java/org/apache/fop/fo/properties/EnumProperty.java @@ -97,7 +97,7 @@ public class EnumProperty extends Property { } /** - * @see java.lang.Object#equals(Object) + * {@inheritDoc} */ public boolean equals(Object obj) { if (obj instanceof EnumProperty) { @@ -112,7 +112,7 @@ public class EnumProperty extends Property { } /** - * @see java.lang.Object#hashCode() + * {@inheritDoc} */ public int hashCode() { return value + text.hashCode(); diff --git a/src/java/org/apache/fop/fo/properties/FixedLength.java b/src/java/org/apache/fop/fo/properties/FixedLength.java index 80016ba2e..7acc899bf 100644 --- a/src/java/org/apache/fop/fo/properties/FixedLength.java +++ b/src/java/org/apache/fop/fo/properties/FixedLength.java @@ -45,7 +45,8 @@ public class FixedLength extends LengthProperty { * to the computed value * @param numUnits input units * @param units unit specifier - * @return + * @return the canonical FixedLength instance corresponding + * to the given number of units and unit specifier */ public static FixedLength getInstance(double numUnits, String units) { return (FixedLength) cache.fetch( @@ -105,28 +106,28 @@ public class FixedLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getValue() + * {@inheritDoc} */ public int getValue() { return millipoints; } /** - * @see org.apache.fop.datatypes.Numeric#getValue(PercentBaseContext) + * {@inheritDoc} */ public int getValue(PercentBaseContext context) { return millipoints; } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue() { return millipoints; } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue(PercentBaseContext) + * {@inheritDoc} */ public double getNumericValue(PercentBaseContext context) { return millipoints; @@ -134,21 +135,21 @@ public class FixedLength extends LengthProperty { /** * Return true since FixedLength are always absolute. - * @see org.apache.fop.datatypes.Numeric#isAbsolute() + * {@inheritDoc} */ public boolean isAbsolute() { return true; } /** - * @see java.lang.Object#toString() + * {@inheritDoc} */ public String toString() { return millipoints + "mpt"; } /** - * @see java.lang.Object#equals(Object) + * {@inheritDoc} */ public boolean equals(Object obj) { if (obj instanceof EnumProperty) { @@ -159,7 +160,7 @@ public class FixedLength extends LengthProperty { } /** - * @see java.lang.Object#hashCode() + * {@inheritDoc} */ public int hashCode() { return millipoints; diff --git a/src/java/org/apache/fop/fo/properties/FontFamilyProperty.java b/src/java/org/apache/fop/fo/properties/FontFamilyProperty.java index 58cbc6402..1b31351b8 100644 --- a/src/java/org/apache/fop/fo/properties/FontFamilyProperty.java +++ b/src/java/org/apache/fop/fo/properties/FontFamilyProperty.java @@ -41,7 +41,7 @@ public class FontFamilyProperty extends ListProperty { } /** - * @see org.apache.fop.fo.properties.PropertyMaker#make( + * {@inheritDoc} * org.apache.fop.fo.PropertyList, * java.lang.String, * org.apache.fop.fo.FObj) @@ -94,7 +94,7 @@ public class FontFamilyProperty extends ListProperty { } /** - * @see PropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) { @@ -127,7 +127,7 @@ public class FontFamilyProperty extends ListProperty { } } - /** @see org.apache.fop.fo.properties.Property#getString() */ + /** {@inheritDoc} */ public String getString() { if (list.size() > 0) { Property first = (Property)list.get(0); diff --git a/src/java/org/apache/fop/fo/properties/FontShorthandParser.java b/src/java/org/apache/fop/fo/properties/FontShorthandParser.java index b07bd0629..89e029c5e 100644 --- a/src/java/org/apache/fop/fo/properties/FontShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/FontShorthandParser.java @@ -20,8 +20,6 @@ package org.apache.fop.fo.properties; import org.apache.fop.fo.Constants; -import org.apache.fop.fo.FObj; -import org.apache.fop.fo.FOPropertyMapping; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.expr.PropertyException; @@ -31,7 +29,7 @@ import org.apache.fop.fo.expr.PropertyException; public class FontShorthandParser extends GenericShorthandParser { /** - * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, diff --git a/src/java/org/apache/fop/fo/properties/FontShorthandProperty.java b/src/java/org/apache/fop/fo/properties/FontShorthandProperty.java index 69177ad29..638f77338 100644 --- a/src/java/org/apache/fop/fo/properties/FontShorthandProperty.java +++ b/src/java/org/apache/fop/fo/properties/FontShorthandProperty.java @@ -48,7 +48,7 @@ public class FontShorthandProperty extends ListProperty { } /** - * @see PropertyMaker#make(PropertyList, String, FObj) + * {@inheritDoc} */ public Property make(PropertyList propertyList, String value, FObj fo) throws PropertyException { diff --git a/src/java/org/apache/fop/fo/properties/FontSizePropertyMaker.java b/src/java/org/apache/fop/fo/properties/FontSizePropertyMaker.java index cc39359c9..012a80b1a 100644 --- a/src/java/org/apache/fop/fo/properties/FontSizePropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/FontSizePropertyMaker.java @@ -44,7 +44,7 @@ public class FontSizePropertyMaker } /** - * @see PropertyMaker#convertProperty + * {@inheritDoc} * Implements the parts of 7.8.4 relevant to relative font sizes */ public Property convertProperty(Property p, diff --git a/src/java/org/apache/fop/fo/properties/FontStretchPropertyMaker.java b/src/java/org/apache/fop/fo/properties/FontStretchPropertyMaker.java index 719ed43e8..82f152ff5 100644 --- a/src/java/org/apache/fop/fo/properties/FontStretchPropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/FontStretchPropertyMaker.java @@ -43,7 +43,7 @@ public class FontStretchPropertyMaker } /** - * @see PropertyMaker#convertProperty + * {@inheritDoc} * Implements the parts of 7.8.5 relevant to relative font stretches */ public Property convertProperty(Property p, diff --git a/src/java/org/apache/fop/fo/properties/FontWeightPropertyMaker.java b/src/java/org/apache/fop/fo/properties/FontWeightPropertyMaker.java index 64155e14c..173b28f7c 100644 --- a/src/java/org/apache/fop/fo/properties/FontWeightPropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/FontWeightPropertyMaker.java @@ -14,7 +14,7 @@ * See the License for the specific language governing permissions and * limitations under the License. * -/* $Id:$ */ +/* $Id$ */ package org.apache.fop.fo.properties; @@ -36,7 +36,7 @@ public class FontWeightPropertyMaker extends EnumProperty.Maker { } /** - * @see org.apache.fop.fo.properties.PropertyMaker#make(PropertyList, String, FObj) + * {@inheritDoc} */ public Property make(PropertyList pList, String value, FObj fo) throws PropertyException { diff --git a/src/java/org/apache/fop/fo/properties/GenericShorthandParser.java b/src/java/org/apache/fop/fo/properties/GenericShorthandParser.java index 766c9e896..5802112bc 100644 --- a/src/java/org/apache/fop/fo/properties/GenericShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/GenericShorthandParser.java @@ -49,7 +49,7 @@ public class GenericShorthandParser implements ShorthandParser { } /** - * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, diff --git a/src/java/org/apache/fop/fo/properties/KeepProperty.java b/src/java/org/apache/fop/fo/properties/KeepProperty.java index fe3566d41..9ac33fad3 100644 --- a/src/java/org/apache/fop/fo/properties/KeepProperty.java +++ b/src/java/org/apache/fop/fo/properties/KeepProperty.java @@ -53,7 +53,7 @@ public class KeepProperty extends Property implements CompoundDatatype { } /** - * @see CompoundPropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) throws PropertyException @@ -66,7 +66,7 @@ public class KeepProperty extends Property implements CompoundDatatype { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#setComponent(int, Property, boolean) + * {@inheritDoc} */ public void setComponent(int cmpId, Property cmpnValue, boolean bIsDefault) { @@ -80,7 +80,7 @@ public class KeepProperty extends Property implements CompoundDatatype { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#getComponent(int) + * {@inheritDoc} */ public Property getComponent(int cmpId) { if (cmpId == CP_WITHIN_LINE) { diff --git a/src/java/org/apache/fop/fo/properties/LengthPairProperty.java b/src/java/org/apache/fop/fo/properties/LengthPairProperty.java index b5e8722e9..f89b7d8b7 100644 --- a/src/java/org/apache/fop/fo/properties/LengthPairProperty.java +++ b/src/java/org/apache/fop/fo/properties/LengthPairProperty.java @@ -52,7 +52,7 @@ public class LengthPairProperty extends Property implements CompoundDatatype { } /** - * @see CompoundPropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) throws PropertyException { @@ -91,7 +91,7 @@ public class LengthPairProperty extends Property implements CompoundDatatype { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#setComponent(int, Property, boolean) + * {@inheritDoc} */ public void setComponent(int cmpId, Property cmpnValue, boolean bIsDefault) { @@ -103,7 +103,7 @@ public class LengthPairProperty extends Property implements CompoundDatatype { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#getComponent(int) + * {@inheritDoc} */ public Property getComponent(int cmpId) { if (cmpId == CP_BLOCK_PROGRESSION_DIRECTION) { @@ -129,7 +129,7 @@ public class LengthPairProperty extends Property implements CompoundDatatype { return this.bpd; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "LengthPair[" + "ipd:" + getIPD().getObject() diff --git a/src/java/org/apache/fop/fo/properties/LengthProperty.java b/src/java/org/apache/fop/fo/properties/LengthProperty.java index 8b5565e68..7e7b37e06 100644 --- a/src/java/org/apache/fop/fo/properties/LengthProperty.java +++ b/src/java/org/apache/fop/fo/properties/LengthProperty.java @@ -37,6 +37,8 @@ public abstract class LengthProperty extends Property public static class Maker extends PropertyMaker { /** + * Constructor + * * @param propId the id of the property for which a Maker should be created */ public Maker(int propId) { @@ -44,9 +46,7 @@ public abstract class LengthProperty extends Property } /** - * @see org.apache.fop.fo.properties.PropertyMaker#convertProperty( - * org.apache.fop.fo.properties.Property, org.apache.fop.fo.PropertyList, - * org.apache.fop.fo.FObj) + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, diff --git a/src/java/org/apache/fop/fo/properties/LengthRangeProperty.java b/src/java/org/apache/fop/fo/properties/LengthRangeProperty.java index 68f85056e..acce6f564 100644 --- a/src/java/org/apache/fop/fo/properties/LengthRangeProperty.java +++ b/src/java/org/apache/fop/fo/properties/LengthRangeProperty.java @@ -66,7 +66,7 @@ public class LengthRangeProperty extends Property implements CompoundDatatype { } /** - * @see CompoundPropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) @@ -94,7 +94,7 @@ public class LengthRangeProperty extends Property implements CompoundDatatype { /** - * @see org.apache.fop.fo.properties.PropertyMaker#getSubprop(Property, int, Property) + * {@inheritDoc} */ protected Property setSubprop(Property baseProperty, int subpropertyId, Property subproperty) { @@ -121,7 +121,7 @@ public class LengthRangeProperty extends Property implements CompoundDatatype { /** - * @see org.apache.fop.datatypes.CompoundDatatype#setComponent(int, Property, boolean) + * {@inheritDoc} */ public void setComponent(int cmpId, Property cmpnValue, boolean bIsDefault) { @@ -135,7 +135,7 @@ public class LengthRangeProperty extends Property implements CompoundDatatype { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#getComponent(int) + * {@inheritDoc} */ public Property getComponent(int cmpId) { if (cmpId == CP_MINIMUM) { @@ -277,7 +277,7 @@ public class LengthRangeProperty extends Property implements CompoundDatatype { return this.optimum; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "LengthRange[" + "min:" + getMinimum(null).getObject() diff --git a/src/java/org/apache/fop/fo/properties/LineHeightPropertyMaker.java b/src/java/org/apache/fop/fo/properties/LineHeightPropertyMaker.java index c2eaeedc4..dcb8fd176 100644 --- a/src/java/org/apache/fop/fo/properties/LineHeightPropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/LineHeightPropertyMaker.java @@ -44,8 +44,7 @@ public class LineHeightPropertyMaker extends SpaceProperty.Maker { } /** - * @see PropertyMaker#make(PropertyList, String, FObj) - * @throws PropertyException + * {@inheritDoc} */ public Property make(PropertyList propertyList, String value, FObj fo) throws PropertyException { @@ -63,7 +62,6 @@ public class LineHeightPropertyMaker extends SpaceProperty.Maker { /** * Recalculate the line-height value based on the nearest specified * value. - * @see PropertyMaker#compute(PropertyList) */ protected Property compute(PropertyList propertyList) throws PropertyException { // recalculate based on last specified value @@ -80,7 +78,7 @@ public class LineHeightPropertyMaker extends SpaceProperty.Maker { } /** - * @see SpaceProperty.Maker#convertProperty(Property, PropertyList, FObj) + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, diff --git a/src/java/org/apache/fop/fo/properties/ListProperty.java b/src/java/org/apache/fop/fo/properties/ListProperty.java index 530ef5723..46d8c9496 100644 --- a/src/java/org/apache/fop/fo/properties/ListProperty.java +++ b/src/java/org/apache/fop/fo/properties/ListProperty.java @@ -42,7 +42,7 @@ public class ListProperty extends Property { } /** - * @see PropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) { diff --git a/src/java/org/apache/fop/fo/properties/NumberProperty.java b/src/java/org/apache/fop/fo/properties/NumberProperty.java index 55206cff7..c4ecd4a69 100644 --- a/src/java/org/apache/fop/fo/properties/NumberProperty.java +++ b/src/java/org/apache/fop/fo/properties/NumberProperty.java @@ -48,8 +48,7 @@ public class NumberProperty extends Property implements Numeric { } /** - * @throws PropertyException - * @see PropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) @@ -134,7 +133,6 @@ public class NumberProperty extends Property implements Numeric { /** * Plain number always has a dimension of 0. * @return a dimension of 0. - * @see Numeric#getDimension() */ public int getDimension() { return 0; @@ -143,7 +141,6 @@ public class NumberProperty extends Property implements Numeric { /** * Return the value of this Numeric. * @return The value as a double. - * @see Numeric#getNumericValue() */ public double getNumericValue() { return number.doubleValue(); @@ -153,13 +150,12 @@ public class NumberProperty extends Property implements Numeric { * Return the value of this Numeric. * @param context Evaluation context * @return The value as a double. - * @see Numeric#getNumericValue(PercentBaseContext) */ public double getNumericValue(PercentBaseContext context) { return getNumericValue(); } - /** @see org.apache.fop.datatypes.Numeric#getValue() */ + /** {@inheritDoc} */ public int getValue() { return number.intValue(); } @@ -168,7 +164,6 @@ public class NumberProperty extends Property implements Numeric { * Return the value * @param context Evaluation context * @return The value as an int. - * @see Numeric#getValue(PercentBaseContext) */ public int getValue(PercentBaseContext context) { return getValue(); @@ -177,7 +172,6 @@ public class NumberProperty extends Property implements Numeric { /** * Return true because all numbers are absolute. * @return true. - * @see Numeric#isAbsolute() */ public boolean isAbsolute() { return true; @@ -205,7 +199,7 @@ public class NumberProperty extends Property implements Numeric { return this; } - /** @see org.apache.fop.fo.properties.Property#getLength() */ + /** {@inheritDoc} */ public Length getLength() { //Assume pixels (like in HTML) when there's no unit return FixedLength.getInstance(getNumericValue(), "px"); diff --git a/src/java/org/apache/fop/fo/properties/PageBreakShorthandParser.java b/src/java/org/apache/fop/fo/properties/PageBreakShorthandParser.java index c2bf559a2..f04cdd3cc 100644 --- a/src/java/org/apache/fop/fo/properties/PageBreakShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/PageBreakShorthandParser.java @@ -30,7 +30,7 @@ import org.apache.fop.fo.expr.PropertyException; public class PageBreakShorthandParser implements ShorthandParser { /** - * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, diff --git a/src/java/org/apache/fop/fo/properties/PageDimensionMaker.java b/src/java/org/apache/fop/fo/properties/PageDimensionMaker.java index b41c3e87b..839ac7022 100644 --- a/src/java/org/apache/fop/fo/properties/PageDimensionMaker.java +++ b/src/java/org/apache/fop/fo/properties/PageDimensionMaker.java @@ -45,7 +45,7 @@ public class PageDimensionMaker extends LengthProperty.Maker { * Return the default or user-defined fallback in case the value * was specified as "auto" * - * @see org.apache.fop.fo.properties.PropertyMaker#get(int, PropertyList, boolean, boolean) + * @see PropertyMaker#get(int, PropertyList, boolean, boolean) */ public Property get(int subpropId, PropertyList propertyList, boolean tryInherit, boolean tryDefault) diff --git a/src/java/org/apache/fop/fo/properties/PercentLength.java b/src/java/org/apache/fop/fo/properties/PercentLength.java index a1865d7cd..e63d527a7 100644 --- a/src/java/org/apache/fop/fo/properties/PercentLength.java +++ b/src/java/org/apache/fop/fo/properties/PercentLength.java @@ -74,21 +74,21 @@ public class PercentLength extends LengthProperty { /** * Return false because percent-length are always relative. - * @see org.apache.fop.datatypes.Numeric#isAbsolute() + * {@inheritDoc} */ public boolean isAbsolute() { return false; } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue() { return getNumericValue(null); } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue(PercentBaseContext) + * {@inheritDoc} */ public double getNumericValue(PercentBaseContext context) { try { @@ -102,14 +102,14 @@ public class PercentLength extends LengthProperty { /** * Return the length of this PercentLength. - * @see org.apache.fop.datatypes.Length#getValue() + * {@inheritDoc} */ public int getValue() { return (int) getNumericValue(); } /** - * @see org.apache.fop.datatypes.Numeric#getValue(PercentBaseContext) + * {@inheritDoc} */ public int getValue(PercentBaseContext context) { return (int) getNumericValue(context); diff --git a/src/java/org/apache/fop/fo/properties/PositionShorthandParser.java b/src/java/org/apache/fop/fo/properties/PositionShorthandParser.java index a6a9671da..5f2468ed6 100755 --- a/src/java/org/apache/fop/fo/properties/PositionShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/PositionShorthandParser.java @@ -29,7 +29,7 @@ import org.apache.fop.fo.PropertyList; public class PositionShorthandParser implements ShorthandParser { /** - * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, diff --git a/src/java/org/apache/fop/fo/properties/Property.java b/src/java/org/apache/fop/fo/properties/Property.java index 0cab9da01..5aef1b881 100644 --- a/src/java/org/apache/fop/fo/properties/Property.java +++ b/src/java/org/apache/fop/fo/properties/Property.java @@ -191,7 +191,7 @@ public class Property { return null; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { Object obj = getObject(); if (obj != this) { diff --git a/src/java/org/apache/fop/fo/properties/PropertyCache.java b/src/java/org/apache/fop/fo/properties/PropertyCache.java index 176cdd4aa..0685ff514 100644 --- a/src/java/org/apache/fop/fo/properties/PropertyCache.java +++ b/src/java/org/apache/fop/fo/properties/PropertyCache.java @@ -39,7 +39,7 @@ public class PropertyCache { * Checks if the given property is present in the cache - if so, returns * a reference to the cached value. Otherwise the given object is added * to the cache and returned. - * @param obj + * @param prop the Property instance to check for * @return the cached instance */ public Property fetch(Property prop) { diff --git a/src/java/org/apache/fop/fo/properties/PropertyMaker.java b/src/java/org/apache/fop/fo/properties/PropertyMaker.java index a5373ef50..3faf1971e 100644 --- a/src/java/org/apache/fop/fo/properties/PropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/PropertyMaker.java @@ -283,7 +283,7 @@ public class PropertyMaker implements Cloneable { * inheritable, to return the inherited value. If all else fails, it returns * the default value. * @param subpropertyId The subproperty id of the property being retrieved. - * Is 0 when retriving a base property. + * Is 0 when retrieving a base property. * @param propertyList The PropertyList object being built for this FO. * @param tryInherit true if inherited properties should be examined. * @param tryDefault true if the default value should be returned. @@ -315,7 +315,6 @@ public class PropertyMaker implements Cloneable { * box. * Overridden by subclasses which allow percent specifications. See * the documentation on properties.xsl for details. - * @param fo the FObj containing the PercentBase * @param pl the PropertyList containing the property. (TODO: explain * what this is used for, or remove it from the signature.) * @return an object implementing the PercentBase interface. @@ -525,7 +524,8 @@ public class PropertyMaker implements Cloneable { */ protected Property checkEnumValues(String value) { if (enums != null) { - return (Property) enums.get(value); + Property p = (Property) enums.get(value); + return p; } return null; } @@ -651,7 +651,7 @@ public class PropertyMaker implements Cloneable { /** * Return a clone of the makers. Used by useGeneric() to clone the * subproperty makers of the generic compound makers. - * @see java.lang.Object#clone() + * {@inheritDoc} */ public Object clone() { try { diff --git a/src/java/org/apache/fop/fo/properties/ReferenceOrientationMaker.java b/src/java/org/apache/fop/fo/properties/ReferenceOrientationMaker.java index 124b2e559..505afccd5 100644 --- a/src/java/org/apache/fop/fo/properties/ReferenceOrientationMaker.java +++ b/src/java/org/apache/fop/fo/properties/ReferenceOrientationMaker.java @@ -31,7 +31,6 @@ public class ReferenceOrientationMaker extends Maker { /** * Constructor * @param propId the Constant Id for the property to be made - * @see org.apache.fop.fo.properties.NumberProperty.Maker#PropertyMaker(propId) */ public ReferenceOrientationMaker(int propId) { super(propId); @@ -40,7 +39,7 @@ public class ReferenceOrientationMaker extends Maker { /** * Check the value of the reference-orientation property. * - * @see org.apache.fop.fo.properties.PropertyMaker#get(int, PropertyList, boolean, boolean) + * {@inheritDoc} */ public Property get(int subpropId, PropertyList propertyList, boolean tryInherit, boolean tryDefault) diff --git a/src/java/org/apache/fop/fo/properties/SpaceProperty.java b/src/java/org/apache/fop/fo/properties/SpaceProperty.java index 9ad809cbd..98caa04ff 100644 --- a/src/java/org/apache/fop/fo/properties/SpaceProperty.java +++ b/src/java/org/apache/fop/fo/properties/SpaceProperty.java @@ -54,7 +54,7 @@ public class SpaceProperty extends LengthRangeProperty { } /** - * @see CompoundPropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, @@ -69,7 +69,7 @@ public class SpaceProperty extends LengthRangeProperty { /** - * @see org.apache.fop.datatypes.CompoundDatatype#setComponent(int, Property, boolean) + * {@inheritDoc} */ public void setComponent(int cmpId, Property cmpnValue, boolean bIsDefault) { @@ -83,7 +83,7 @@ public class SpaceProperty extends LengthRangeProperty { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#getComponent(int) + * {@inheritDoc} */ public Property getComponent(int cmpId) { if (cmpId == CP_PRECEDENCE) { diff --git a/src/java/org/apache/fop/fo/properties/SpacePropertyMaker.java b/src/java/org/apache/fop/fo/properties/SpacePropertyMaker.java index e5c572952..a4f0c412e 100644 --- a/src/java/org/apache/fop/fo/properties/SpacePropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/SpacePropertyMaker.java @@ -37,7 +37,7 @@ public class SpacePropertyMaker extends CorrespondingPropertyMaker { } /** - * @see org.apache.fop.fo.properties.CorrespondingPropertyMaker#compute(PropertyList) + * {@inheritDoc} */ public Property compute(PropertyList propertyList) throws PropertyException { Property prop = super.compute(propertyList); diff --git a/src/java/org/apache/fop/fo/properties/StringProperty.java b/src/java/org/apache/fop/fo/properties/StringProperty.java index 691942d78..a38840352 100644 --- a/src/java/org/apache/fop/fo/properties/StringProperty.java +++ b/src/java/org/apache/fop/fo/properties/StringProperty.java @@ -116,7 +116,7 @@ public class StringProperty extends Property { } /** - * @see java.lang.Object#hashCode() + * {@inheritDoc} */ public boolean equals(Object obj) { if (obj instanceof StringProperty) { @@ -129,7 +129,7 @@ public class StringProperty extends Property { } /** - * @see java.lang.Object#hashCode() + * {@inheritDoc} */ public int hashCode() { return str.hashCode(); diff --git a/src/java/org/apache/fop/fo/properties/TableBorderPrecedence.java b/src/java/org/apache/fop/fo/properties/TableBorderPrecedence.java index dff9626a1..181dd00d5 100644 --- a/src/java/org/apache/fop/fo/properties/TableBorderPrecedence.java +++ b/src/java/org/apache/fop/fo/properties/TableBorderPrecedence.java @@ -40,7 +40,7 @@ public class TableBorderPrecedence extends NumberProperty.Maker{ /** * Set default precedence according to the parent FObj * - * @see PropertyMaker#compute(PropertyList) + * {@inheritDoc} */ public Property make(PropertyList propertyList) throws PropertyException { FObj fo = propertyList.getFObj(); diff --git a/src/java/org/apache/fop/fo/properties/TableColLength.java b/src/java/org/apache/fop/fo/properties/TableColLength.java index d85c89aba..251007093 100644 --- a/src/java/org/apache/fop/fo/properties/TableColLength.java +++ b/src/java/org/apache/fop/fo/properties/TableColLength.java @@ -65,7 +65,7 @@ public class TableColLength extends LengthProperty { /** * Return false because table-col-units are a relative numeric. - * @see org.apache.fop.datatypes.Numeric#isAbsolute() + * {@inheritDoc} */ public boolean isAbsolute() { return false; @@ -73,7 +73,7 @@ public class TableColLength extends LengthProperty { /** * Return the value as a numeric value. - * @see org.apache.fop.datatypes.Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue() { throw new UnsupportedOperationException( @@ -81,7 +81,7 @@ public class TableColLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue(PercentBaseContext) + * {@inheritDoc} */ public double getNumericValue(PercentBaseContext context) { return tcolUnits * context.getBaseLength(LengthBase.TABLE_UNITS, column); @@ -89,7 +89,7 @@ public class TableColLength extends LengthProperty { /** * Return the value as a length. - * @see org.apache.fop.datatypes.Length#getValue() + * {@inheritDoc} */ public int getValue() { throw new UnsupportedOperationException( @@ -97,7 +97,7 @@ public class TableColLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getValue(PercentBaseContext) + * {@inheritDoc} */ public int getValue(PercentBaseContext context) { return (int) (tcolUnits * context.getBaseLength(LengthBase.TABLE_UNITS, column)); diff --git a/src/java/org/apache/fop/fo/properties/TextDecorationProperty.java b/src/java/org/apache/fop/fo/properties/TextDecorationProperty.java index 516537fb4..4cb1b2f4a 100644 --- a/src/java/org/apache/fop/fo/properties/TextDecorationProperty.java +++ b/src/java/org/apache/fop/fo/properties/TextDecorationProperty.java @@ -43,7 +43,7 @@ public class TextDecorationProperty extends ListProperty { } /** - * @see PropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) diff --git a/src/java/org/apache/fop/fo/properties/VerticalAlignShorthandParser.java b/src/java/org/apache/fop/fo/properties/VerticalAlignShorthandParser.java index 92d6095ca..d71dc4db1 100644 --- a/src/java/org/apache/fop/fo/properties/VerticalAlignShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/VerticalAlignShorthandParser.java @@ -29,7 +29,7 @@ import org.apache.fop.fo.PropertyList; public class VerticalAlignShorthandParser implements ShorthandParser, Constants { /** - * @see ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, diff --git a/src/java/org/apache/fop/fo/properties/WhiteSpaceShorthandParser.java b/src/java/org/apache/fop/fo/properties/WhiteSpaceShorthandParser.java index d7b13b540..2feb5e9c8 100644 --- a/src/java/org/apache/fop/fo/properties/WhiteSpaceShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/WhiteSpaceShorthandParser.java @@ -32,7 +32,7 @@ import org.apache.fop.fo.expr.PropertyException; public class WhiteSpaceShorthandParser implements ShorthandParser { /** - * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, PropertyMaker maker, PropertyList propertyList) |