You are viewing a plain text version of this content. The canonical link for it is here.
Posted to fop-commits@xmlgraphics.apache.org by ad...@apache.org on 2008/04/27 00:08:15 UTC
svn commit: r651866 [2/3] - in
/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo: ./ flow/ flow/table/
pagination/ pagination/bookmarks/
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/Leader.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/Leader.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/Leader.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/Leader.java Sat Apr 26 15:08:10 2008
@@ -26,8 +26,9 @@
import org.apache.fop.fo.properties.LengthRangeProperty;
/**
- * Class modelling fo:leader object.
- * The main property of fo:leader is leader-pattern.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_leader">
+ * <code>fo:leader</code></a> object.
+ * The main property of <code>fo:leader</code> is leader-pattern.
* The following patterns are treated: rule, space, dots and use-content.
* @todo implement validateChildNode()
*/
@@ -53,15 +54,15 @@
// End of property values
/**
- * @param parent FONode that is the parent of this object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public Leader(FONode parent) {
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
alignmentAdjust = pList.get(PR_ALIGNMENT_ADJUST).getLength();
@@ -95,72 +96,52 @@
// textShadow = pList.get(PR_TEXT_SHADOW);
}
- /**
- * @return the "rule-style" property.
- */
+ /** @return the "rule-style" property */
public int getRuleStyle() {
return ruleStyle;
}
- /**
- * @return the "rule-thickness" property.
- */
+ /** @return the "rule-thickness" property */
public Length getRuleThickness() {
return ruleThickness;
}
- /**
- * @return the "leader-alignment" property.
- */
+ /** @return the "leader-alignment" property */
public int getLeaderAlignment() {
return leaderAlignment;
}
- /**
- * @return the "leader-length" property.
- */
+ /** @return the "leader-length" property */
public LengthRangeProperty getLeaderLength() {
return leaderLength;
}
- /**
- * @return the "leader-pattern" property.
- */
+ /** @return the "leader-pattern" property */
public int getLeaderPattern() {
return leaderPattern;
}
- /**
- * @return the "leader-pattern-width" property.
- */
+ /** @return the "leader-pattern-width" property */
public Length getLeaderPatternWidth() {
return leaderPatternWidth;
}
- /**
- * @return the "alignment-adjust" property
- */
+ /** @return the "alignment-adjust" property */
public Length getAlignmentAdjust() {
return alignmentAdjust;
}
- /**
- * @return the "alignment-baseline" property
- */
+ /** @return the "alignment-baseline" property */
public int getAlignmentBaseline() {
return alignmentBaseline;
}
- /**
- * @return the "baseline-shift" property
- */
+ /** @return the "baseline-shift" property */
public Length getBaselineShift() {
return baselineShift;
}
- /**
- * @return the "dominant-baseline" property
- */
+ /** @return the "dominant-baseline" property */
public int getDominantBaseline() {
return dominantBaseline;
}
@@ -172,6 +153,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_LEADER}
*/
public int getNameId() {
return FO_LEADER;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListBlock.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListBlock.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListBlock.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListBlock.java Sat Apr 26 15:08:10 2008
@@ -32,7 +32,8 @@
import org.apache.fop.fo.properties.KeepProperty;
/**
- * Class modelling the fo:list-block object.
+ * Class modelling the <a href=http://www.w3.org/TR/xsl/#fo_list-block">
+ * <code>fo:list-block</code></a> object.
*/
public class ListBlock extends FObj {
// The value of properties relevant for fo:list-block.
@@ -60,15 +61,15 @@
private boolean hasListItem = false;
/**
- * @param parent FONode that is the parent of this object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public ListBlock(FONode parent) {
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps();
@@ -83,17 +84,16 @@
orphanContentLimit = pList.get(PR_X_ORPHAN_CONTENT_LIMIT).getLength();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void startOfNode() throws FOPException {
super.startOfNode();
getFOEventHandler().startList(this);
}
/**
- * Make sure content model satisfied, if so then tell the
- * FOEventHandler that we are at the end of the flow.
+ * Make sure the content model is satisfied, if so then tell the
+ * {@link org.apache.fop.fo.FOEventHandler} that we are at the end
+ * of the list-block.
* {@inheritDoc}
*/
protected void endOfNode() throws FOPException {
@@ -105,7 +105,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: marker* (list-item)+
+ * <br>XSL Content Model: marker* (list-item)+
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -122,30 +122,22 @@
}
}
- /**
- * @return the Common Margin Properties-Block.
- */
+ /** @return the {@link CommonMarginBlock} */
public CommonMarginBlock getCommonMarginBlock() {
return commonMarginBlock;
}
- /**
- * @return the Common Border, Padding, and Background Properties.
- */
+ /** @return the {@link CommonBorderPaddingBackground} */
public CommonBorderPaddingBackground getCommonBorderPaddingBackground() {
return commonBorderPaddingBackground;
}
- /**
- * @return the "break-after" property.
- */
+ /** @return the "break-after" property */
public int getBreakAfter() {
return breakAfter;
}
- /**
- * @return the "break-before" property.
- */
+ /** @return the "break-before" property */
public int getBreakBefore() {
return breakBefore;
}
@@ -180,7 +172,10 @@
return "list-block";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_LIST_BLOCK}
+ */
public int getNameId() {
return FO_LIST_BLOCK;
}
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListItem.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListItem.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListItem.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListItem.java Sat Apr 26 15:08:10 2008
@@ -31,7 +31,8 @@
import org.apache.fop.fo.properties.KeepProperty;
/**
- * Class modelling the fo:list-item object.
+ * Class modelling the <a href=http://www.w3.org/TR/xsl/#fo_list-item">
+ * <code>fo:list-item</code></a> object.
*/
public class ListItem extends FObj {
// The value of properties relevant for fo:list-item.
@@ -54,15 +55,15 @@
private ListItemBody body = null;
/**
- * @param parent FONode that is the parent of this object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public ListItem(FONode parent) {
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps();
@@ -74,17 +75,13 @@
keepWithPrevious = pList.get(PR_KEEP_WITH_PREVIOUS).getKeep();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void startOfNode() throws FOPException {
super.startOfNode();
getFOEventHandler().startListItem(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void endOfNode() throws FOPException {
if (label == null || body == null) {
missingChildElementError("marker* (list-item-label,list-item-body)");
@@ -94,7 +91,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: marker* (list-item-label,list-item-body)
+ * <br>XSL Content Model: marker* (list-item-label,list-item-body)
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -125,7 +122,7 @@
* (i.e., add to childNodes instead)
*/
public void addChildNode(FONode child) {
- int nameId = ((FObj)child).getNameId();
+ int nameId = child.getNameId();
if (nameId == FO_LIST_ITEM_LABEL) {
label = (ListItemLabel) child;
@@ -136,52 +133,42 @@
}
}
- /**
- * @return the Common Margin Properties-Block.
- */
+ /** @return the {@link CommonMarginBlock} */
public CommonMarginBlock getCommonMarginBlock() {
return commonMarginBlock;
}
- /**
- * @return the Common Border, Padding, and Background Properties.
- */
+ /** @return the {@link CommonBorderPaddingBackground} */
public CommonBorderPaddingBackground getCommonBorderPaddingBackground() {
return commonBorderPaddingBackground;
}
- /**
- * @return the "break-after" property.
- */
+ /** @return the "break-after" property */
public int getBreakAfter() {
return breakAfter;
}
- /**
- * @return the "break-before" property.
- */
+ /** @return the "break-before" property */
public int getBreakBefore() {
return breakBefore;
}
- /** @return the "keep-with-next" property. */
+ /** @return the "keep-with-next" property */
public KeepProperty getKeepWithNext() {
return keepWithNext;
}
- /** @return the "keep-with-previous" property. */
+ /** @return the "keep-with-previous" property */
public KeepProperty getKeepWithPrevious() {
return keepWithPrevious;
}
- /** @return the "keep-together" property. */
+ /** @return the "keep-together" property */
public KeepProperty getKeepTogether() {
return keepTogether;
}
- /**
- * @return the label of the list item
- */
+ /** @return the label of the list item */
public ListItemLabel getLabel() {
return label;
}
@@ -200,6 +187,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_LIST_ITEM}
*/
public int getNameId() {
return FO_LIST_ITEM;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListItemBody.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListItemBody.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListItemBody.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListItemBody.java Sat Apr 26 15:08:10 2008
@@ -23,7 +23,8 @@
import org.apache.fop.fo.FONode;
/**
- * Class modelling the fo:list-item-body object.
+ * Class modelling the <a href=http://www.w3.org/TR/xsl/#fo_list-item-body">
+ * <code>fo:list-item-body object</code></a>.
*/
public class ListItemBody extends AbstractListItemPart {
@@ -34,17 +35,13 @@
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void startOfNode() throws FOPException {
super.startOfNode();
getFOEventHandler().startListBody();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void endOfNode() throws FOPException {
super.endOfNode();
getFOEventHandler().endListBody();
@@ -57,6 +54,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_LIST_ITEM_BODY}
*/
public int getNameId() {
return FO_LIST_ITEM_BODY;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListItemLabel.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListItemLabel.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListItemLabel.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/ListItemLabel.java Sat Apr 26 15:08:10 2008
@@ -23,28 +23,27 @@
import org.apache.fop.fo.FONode;
/**
- * Class modelling the fo:list-item-label object.
+ * Class modelling the <a href=http://www.w3.org/TR/xsl/#fo_list-item-label">
+ * <code>fo:list-item-label</code></a> object.
*/
public class ListItemLabel extends AbstractListItemPart {
/**
- * @param parent FONode that is the parent of this object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public ListItemLabel(FONode parent) {
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void startOfNode() throws FOPException {
super.startOfNode();
getFOEventHandler().startListLabel();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void endOfNode() throws FOPException {
super.endOfNode();
getFOEventHandler().endListLabel();
@@ -57,6 +56,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_LIST_ITEM_LABEL}
*/
public int getNameId() {
return FO_LIST_ITEM_LABEL;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/Marker.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/Marker.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/Marker.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/Marker.java Sat Apr 26 15:08:10 2008
@@ -36,7 +36,8 @@
import org.apache.fop.fo.properties.Property;
/**
- * Class modelling the fo:marker object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_marker">
+ * <code>fo:marker<code></a> object.
*/
public class Marker extends FObjMixed {
// The value of properties relevant for fo:marker.
@@ -48,15 +49,14 @@
/**
* Create a marker fo.
- * @param parent the parent fo node
+ *
+ * @param parent the parent {@link FONode}
*/
public Marker(FONode parent) {
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
if (findAncestor(FO_FLOW) < 0) {
invalidChildError(locator, getParent().getName(), FO_URI, getName(),
@@ -71,9 +71,11 @@
}
/**
- * retrieve the property list of foNode
- * @param foNode the FO node whose property list is requested
- * @return the MarkerPropertyList of foNode
+ * Retrieve the property list of the given {@link FONode}
+ * descendant
+ *
+ * @param foNode the {@link FONode} whose property list is requested
+ * @return the {@link MarkerPropertyList} for the given node
*/
protected MarkerPropertyList getPropertyListFor(FONode foNode) {
return (MarkerPropertyList)
@@ -104,10 +106,10 @@
/**
* {@inheritDoc}
- * XSL Content Model: (#PCDATA|%inline;|%block;)*
- * Additionally: "An fo:marker may contain any formatting objects that
+ * <br>XSL Content Model: (#PCDATA|%inline;|%block;)*
+ * <br><i>Additionally: "An fo:marker may contain any formatting objects that
* are permitted as a replacement of any fo:retrieve-marker that retrieves
- * the fo:marker's children."
+ * the fo:marker's children."</i>
* @todo implement "additional" constraint, possibly within fo:retrieve-marker
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
@@ -119,13 +121,12 @@
}
}
+ /** {@inheritDoc} */
protected boolean inMarker() {
return true;
}
- /**
- * Return the "marker-class-name" property.
- */
+ /** @return the "marker-class-name" property */
public String getMarkerClassName() {
return markerClassName;
}
@@ -137,6 +138,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_MARKER}
*/
public int getNameId() {
return FO_MARKER;
@@ -150,7 +152,7 @@
}
/**
- * An implementation of PropertyList which only stores the explicitly
+ * An implementation of {@link PropertyList} which only stores the explicitly
* specified properties/attributes as bundles of name-value-namespace
* strings
*/
@@ -163,7 +165,7 @@
/**
* Overriding default constructor
*
- * @param fobj the FObj to attach
+ * @param fobj the {@link FObj} to attach
* @param parentPropertyList ignored
*/
public MarkerPropertyList(FObj fobj, PropertyList parentPropertyList) {
@@ -175,10 +177,10 @@
}
/**
- * Override that doesn't convert the attributes to Property instances,
- * but simply stores the attributes for later processing;
+ * Override that doesn't convert the attributes to {@link Property}
+ * instances, but simply stores the attributes for later processing.
*
- * @see org.apache.fop.fo.PropertyList#addAttributesToList(Attributes)
+ * {@inheritDoc}
*/
public void addAttributesToList(Attributes attributes)
throws ValidationException {
@@ -201,23 +203,17 @@
}
}
- /**
- * Null implementation; not used by this type of PropertyList
- */
+ /** Null implementation; not used by this type of {@link PropertyList} */
public void putExplicit(int propId, Property value) {
//nop
}
- /**
- * Null implementation; not used by this type of PropertyList
- */
+ /** Null implementation; not used by this type of {@link PropertyList} */
public Property getExplicit(int propId) {
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int getLength() {
if (attribs == null) {
return 0;
@@ -226,9 +222,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getURI(int index) {
if (attribs != null
&& index < attribs.length
@@ -240,9 +234,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getLocalName(int index) {
if (attribs != null
&& index < attribs.length
@@ -254,9 +246,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getQName(int index) {
if (attribs != null
&& index < attribs.length
@@ -268,16 +258,12 @@
}
}
- /**
- * Default implementation; not used
- */
+ /** Default implementation; not used */
public String getType(int index) {
return "CDATA";
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getValue(int index) {
if (attribs != null
&& index < attribs.length
@@ -289,9 +275,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int getIndex(String name, String namespace) {
int index = -1;
if (attribs != null && name != null && namespace != null) {
@@ -306,9 +290,7 @@
return index;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public int getIndex(String qname) {
int index = -1;
if (attribs != null && qname != null) {
@@ -322,23 +304,17 @@
return index;
}
- /**
- * Default implementation; not used
- */
+ /** Default implementation; not used */
public String getType(String name, String namespace) {
return "CDATA";
}
- /**
- * Default implementation; not used
- */
+ /** Default implementation; not used */
public String getType(String qname) {
return "CDATA";
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getValue(String name, String namespace) {
int index = getIndex(name, namespace);
if (index > 0) {
@@ -347,9 +323,7 @@
return null;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public String getValue(String qname) {
int index = getIndex(qname);
if (index > 0) {
@@ -359,9 +333,7 @@
}
}
- /**
- * Convenience inner class
- */
+ /** Convenience inner class */
private static final class MarkerAttribute {
private static Map attributeCache =
@@ -390,7 +362,9 @@
/**
* Convenience method, reduces the number
* of distinct MarkerAttribute instances
- *
+ *
+ * @param namespace the attribute namespace
+ * @param qname the fully qualified name of the attribute
* @param name the attribute name
* @param value the attribute value
* @return the single MarkerAttribute instance corresponding to
@@ -409,9 +383,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public boolean equals(Object o) {
if (o instanceof MarkerAttribute) {
MarkerAttribute attr = (MarkerAttribute) o;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiCase.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiCase.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiCase.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiCase.java Sat Apr 26 15:08:10 2008
@@ -25,7 +25,8 @@
import org.apache.fop.fo.PropertyList;
/**
- * Class modelling the fo:multi-case object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_multi-case">
+ * <code>fo:multi-case</code></a> object.
* @todo implement validateChildNode()
*/
public class MultiCase extends FObj {
@@ -40,7 +41,9 @@
static boolean notImplementedWarningGiven = false;
/**
- * @param parent FONode that is the parent of this object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public MultiCase(FONode parent) {
super(parent);
@@ -52,9 +55,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
startingState = pList.get(PR_STARTING_STATE).getEnum();
@@ -62,9 +63,7 @@
// caseTitle = pList.get(PR_CASE_TITLE);
}
- /**
- * Return the "starting-state" property.
- */
+ /** @return the "starting-state" property */
public int getStartingState() {
return startingState;
}
@@ -76,6 +75,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_MULTI_CASE}
*/
public int getNameId() {
return FO_MULTI_CASE;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiProperties.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiProperties.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiProperties.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiProperties.java Sat Apr 26 15:08:10 2008
@@ -28,7 +28,8 @@
import org.apache.fop.fo.ValidationException;
/**
- * Class modelling the fo:multi-properties object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_multi-properties">
+ * <code>fo:multi-properties</code></a> object.
*/
public class MultiProperties extends FObj {
// The value of properties relevant for fo:multi-properties.
@@ -43,7 +44,9 @@
boolean hasWrapper = false;
/**
- * @param parent FONode that is the parent of this object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public MultiProperties(FONode parent) {
super(parent);
@@ -55,9 +58,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void endOfNode() throws FOPException {
if (!hasMultiPropertySet || !hasWrapper) {
missingChildElementError("(multi-property-set+, wrapper)");
@@ -66,7 +67,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: (multi-property-set+, wrapper)
+ * <br>XSL Content Model: (multi-property-set+, wrapper)
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -96,6 +97,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_MULTI_PROPERTIES}
*/
public int getNameId() {
return FO_MULTI_PROPERTIES;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiPropertySet.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiPropertySet.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiPropertySet.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiPropertySet.java Sat Apr 26 15:08:10 2008
@@ -29,7 +29,8 @@
import org.apache.fop.fo.ValidationException;
/**
- * Class modelling the fo:multi-property-set object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_multi-property-set">
+ * <code>fo:multi-property-set</code></a> object.
*/
public class MultiPropertySet extends FObj {
// The value of properties relevant for fo:multi-property-set.
@@ -39,7 +40,9 @@
static boolean notImplementedWarningGiven = false;
/**
- * @param parent FONode that is the parent of this object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public MultiPropertySet(FONode parent) {
super(parent);
@@ -51,9 +54,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
// activeState = pList.get(PR_ACTIVE_STATE);
@@ -61,7 +62,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: empty
+ * <br>XSL Content Model: empty
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -77,6 +78,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_MULTI_PROPERTY_SET}
*/
public int getNameId() {
return FO_MULTI_PROPERTY_SET;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiSwitch.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiSwitch.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiSwitch.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiSwitch.java Sat Apr 26 15:08:10 2008
@@ -29,7 +29,8 @@
import org.apache.fop.fo.ValidationException;
/**
- * Class modelling the fo:multi-switch object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_multi-switch">
+ * <code>fo:multi-switch</code></a> object.
*/
public class MultiSwitch extends FObj {
// The value of properties relevant for fo:multi-switch.
@@ -41,7 +42,9 @@
static boolean notImplementedWarningGiven = false;
/**
- * @param parent FONode that is the parent of this object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public MultiSwitch(FONode parent) {
super(parent);
@@ -53,18 +56,14 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
// autoRestore = pList.get(PR_AUTO_RESTORE);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void endOfNode() throws FOPException {
if (firstChild == null) {
missingChildElementError("(multi-case+)");
@@ -73,7 +72,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: (multi-case+)
+ * <br>XSL Content Model: (multi-case+)
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -91,6 +90,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_MULTI_SWITCH}
*/
public int getNameId() {
return FO_MULTI_SWITCH;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiToggle.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiToggle.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiToggle.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/MultiToggle.java Sat Apr 26 15:08:10 2008
@@ -30,7 +30,8 @@
/**
- * Class modelling the fo:multi-toggle property.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_multi-toggle">
+ * <code>fo:multi-toggle<code></a> property.
*/
public class MultiToggle extends FObj {
// The value of properties relevant for fo:multi-toggle (commented out for performance).
@@ -41,7 +42,9 @@
static boolean notImplementedWarningGiven = false;
/**
- * @param parent FONode that is the parent of this object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public MultiToggle(FONode parent) {
super(parent);
@@ -53,9 +56,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
// prSwitchTo = pList.get(PR_SWITCH_TO);
@@ -63,7 +64,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: (#PCDATA|%inline;|%block;)*
+ * <br>XSL Content Model: (#PCDATA|%inline;|%block;)*
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -81,6 +82,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_MULTI_TOGGLE}
*/
public int getNameId() {
return FO_MULTI_TOGGLE;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/PageNumber.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/PageNumber.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/PageNumber.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/PageNumber.java Sat Apr 26 15:08:10 2008
@@ -36,7 +36,8 @@
import org.apache.fop.fo.properties.SpaceProperty;
/**
- * Class modelling the fo:page-number object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_page-number">
+ * <code>fo:page-number</code></a> object.
*/
public class PageNumber extends FObj {
// The value of properties relevant for fo:page-number.
@@ -71,15 +72,15 @@
private Color color;
/**
- * @param parent FONode that is the parent of this object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public PageNumber(FONode parent) {
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps();
@@ -97,24 +98,20 @@
color = pList.get(Constants.PR_COLOR).getColor(getUserAgent());
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void startOfNode() throws FOPException {
super.startOfNode();
getFOEventHandler().startPageNumber(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void endOfNode() throws FOPException {
getFOEventHandler().endPageNumber(this);
}
/**
* {@inheritDoc}
- * XSL Content Model: empty
+ * <br>XSL Content Model: empty
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -143,37 +140,27 @@
return textDecoration;
}
- /**
- * @return the "alignment-adjust" property
- */
+ /** @return the "alignment-adjust" property */
public Length getAlignmentAdjust() {
return alignmentAdjust;
}
- /**
- * @return the "alignment-baseline" property
- */
+ /** @return the "alignment-baseline" property */
public int getAlignmentBaseline() {
return alignmentBaseline;
}
- /**
- * @return the "baseline-shift" property
- */
+ /** @return the "baseline-shift" property */
public Length getBaselineShift() {
return baselineShift;
}
- /**
- * @return the "dominant-baseline" property
- */
+ /** @return the "dominant-baseline" property */
public int getDominantBaseline() {
return dominantBaseline;
}
- /**
- * @return the "line-height" property
- */
+ /** @return the "line-height" property */
public SpaceProperty getLineHeight() {
return lineHeight;
}
@@ -183,7 +170,10 @@
return "page-number";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_PAGE_NUMBER}
+ */
public int getNameId() {
return FO_PAGE_NUMBER;
}
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/PageNumberCitation.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/PageNumberCitation.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/PageNumberCitation.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/PageNumberCitation.java Sat Apr 26 15:08:10 2008
@@ -23,7 +23,8 @@
import org.apache.fop.fo.FONode;
/**
- * Class modelling the fo:page-number-citation object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_page-number-citation">
+ * <code>fo:page-number-citation</code></a> object.
* This inline fo is replaced with the text for a page number.
* The page number used is the page that contains the start of the
* block referenced with the ref-id attribute.
@@ -32,7 +33,8 @@
/**
* Main constructor
- * @param parent FONode that is the parent of this object
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public PageNumberCitation(FONode parent) {
super(parent);
@@ -55,7 +57,10 @@
return "page-number-citation";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_PAGE_NUMBER_CITATION}
+ */
public int getNameId() {
return FO_PAGE_NUMBER_CITATION;
}
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/PageNumberCitationLast.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/PageNumberCitationLast.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/PageNumberCitationLast.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/PageNumberCitationLast.java Sat Apr 26 15:08:10 2008
@@ -23,7 +23,8 @@
import org.apache.fop.fo.FONode;
/**
- * Class modelling the fo:page-number-citation-last object from XSL 1.1.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_page-number-citation-last">
+ * <code>fo:page-number-citation-last</code></a> object from XSL 1.1.
* This inline fo is replaced with the text for a page number.
* The page number used is the page that contains the end of the
* block referenced with the ref-id attribute.
@@ -33,7 +34,8 @@
/**
* Main constructor
- * @param parent the parent FO node
+ *
+ * @param parent the parent {@link FONode}
*/
public PageNumberCitationLast(FONode parent) {
super(parent);
@@ -56,7 +58,10 @@
return "page-number-citation-last";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_PAGE_NUMBER_CITATION_LAST}
+ */
public int getNameId() {
return FO_PAGE_NUMBER_CITATION_LAST;
}
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/RetrieveMarker.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/RetrieveMarker.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/RetrieveMarker.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/RetrieveMarker.java Sat Apr 26 15:08:10 2008
@@ -21,8 +21,6 @@
import java.util.Iterator;
-import org.xml.sax.Locator;
-
import org.apache.fop.apps.FOPException;
import org.apache.fop.fo.FONode;
import org.apache.fop.fo.FOText;
@@ -32,6 +30,7 @@
import org.apache.fop.fo.ValidationException;
import org.apache.fop.fo.flow.table.Table;
import org.apache.fop.fo.flow.table.TableFObj;
+import org.xml.sax.Locator;
/**
* Class modelling the fo:retrieve-marker object.
@@ -48,9 +47,10 @@
private PropertyList propertyList;
/**
- * Create a retrieve marker object.
- * @param parent FONode that is the parent of this object
- * @see org.apache.fop.fo.FONode#FONode(FONode)
+ * Create a new RetrieveMarker instance that is a
+ * child of the given {@link FONode}.
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public RetrieveMarker(FONode parent) {
super(parent);
@@ -59,26 +59,27 @@
/** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
if (findAncestor(FO_STATIC_CONTENT) < 0) {
- invalidChildError(locator, getParent().getName(), FO_URI, getName(),
+ invalidChildError(locator, getParent().getName(), FO_URI, getName(),
"rule.retrieveMarkerDescendatOfStaticContent");
}
retrieveClassName = pList.get(PR_RETRIEVE_CLASS_NAME).getString();
retrievePosition = pList.get(PR_RETRIEVE_POSITION).getEnum();
retrieveBoundary = pList.get(PR_RETRIEVE_BOUNDARY).getEnum();
-
+
if (retrieveClassName == null || retrieveClassName.equals("")) {
missingPropertyError("retrieve-class-name");
}
-
+
propertyList = pList.getParentPropertyList();
+ super.bind(pList);
}
-
+
/**
* {@inheritDoc}
* XSL Content Model: empty
*/
- protected void validateChildNode(Locator loc, String nsURI, String localName)
+ protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
if (FO_URI.equals(nsURI)) {
invalidChildError(loc, nsURI, localName);
@@ -105,7 +106,7 @@
public int getRetrieveBoundary() {
return retrieveBoundary;
}
-
+
private PropertyList createPropertyListFor(FObj fo, PropertyList parent) {
return getFOEventHandler().getPropertyListMaker().make(fo, parent);
}
@@ -120,7 +121,7 @@
Marker.MarkerPropertyList pList;
PropertyList newPropertyList = createPropertyListFor(
(FObj) newChild, parentPropertyList);
-
+
pList = marker.getPropertyListFor(child);
newChild.processNode(
child.getLocalName(),
@@ -159,7 +160,7 @@
}
}
}
-
+
/**
* Clone the FO nodes in the parent iterator,
* attach the new nodes to the new parent,
@@ -178,7 +179,7 @@
FONode child;
while (parentIter.hasNext()) {
child = (FONode) parentIter.next();
- cloneSingleNode(child, newParent,
+ cloneSingleNode(child, newParent,
marker, parentPropertyList);
}
}
@@ -191,14 +192,14 @@
currentTextNode = null;
firstChild = null;
}
- cloneSubtree(marker.getChildNodes(), this,
+ cloneSubtree(marker.getChildNodes(), this,
marker, propertyList);
handleWhiteSpaceFor(this);
}
/**
* Clone the subtree of the given marker
- *
+ *
* @param marker the marker that is to be cloned
*/
public void bindMarker(Marker marker) {
@@ -213,7 +214,6 @@
} else if (log.isDebugEnabled()) {
log.debug("Empty marker retrieved...");
}
- return;
}
/** {@inheritDoc} */
@@ -221,7 +221,10 @@
return "retrieve-marker";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_RETRIEVE_MARKER}
+ */
public int getNameId() {
return FO_RETRIEVE_MARKER;
}
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/Wrapper.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/Wrapper.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/Wrapper.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/Wrapper.java Sat Apr 26 15:08:10 2008
@@ -28,8 +28,9 @@
import org.apache.fop.fo.ValidationException;
/**
- * Class modelling the fo:wrapper object.
- * The wrapper object serves as a property holder for
+ * Class modelling the <a href=http://www.w3.org/TR/xsl/#fo_wrapper">
+ * <code>fo:wrapper</code></a> object.
+ * The <code>fo:wrapper</code> object serves as a property holder for
* its child node objects.
*/
public class Wrapper extends FObjMixed {
@@ -41,7 +42,9 @@
private boolean inlineChildrenAllowed = false;
/**
- * @param parent FONode that is the parent of this object
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public Wrapper(FONode parent) {
super(parent);
@@ -101,7 +104,10 @@
return "wrapper";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_WRAPPER}
+ */
public int getNameId() {
return FO_WRAPPER;
}
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/Table.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/Table.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/Table.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/Table.java Sat Apr 26 15:08:10 2008
@@ -39,7 +39,8 @@
import org.apache.fop.fo.properties.TableColLength;
/**
- * Class modelling the fo:table object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_table">
+ * <code>fo:table</code></a> object.
*/
public class Table extends TableFObj implements ColumnNumberManagerHolder {
@@ -96,7 +97,10 @@
private PropertyList propList;
/**
- * @param parent FONode that is the parent of this object
+ * Construct a Table instance with the given {@link FONode}
+ * as parent.
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public Table(FONode parent) {
super(parent);
@@ -163,7 +167,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: (marker*,table-column*,table-header?,table-footer?,table-body+)
+ * <br>XSL Content Model: (marker*,table-column*,table-header?,table-footer?,table-body+)
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -255,7 +259,7 @@
if (!inMarker()) {
addColumnNode((TableColumn) child);
} else {
- columns.add((TableColumn) child);
+ columns.add(child);
}
break;
case FO_TABLE_HEADER:
@@ -344,7 +348,6 @@
* used for determining initial values for column-number
*
* @param col the column to add
- * @throws FOPException
*/
private void addColumnNode(TableColumn col) {
@@ -518,7 +521,10 @@
return "table";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_TABLE}
+ */
public int getNameId() {
return FO_TABLE;
}
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableAndCaption.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableAndCaption.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableAndCaption.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableAndCaption.java Sat Apr 26 15:08:10 2008
@@ -28,7 +28,8 @@
import org.apache.fop.fo.ValidationException;
/**
- * Class modelling the fo:table-and-caption property.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_table-and-caption">
+ * <code>fo:table-and-caption</code></a> property.
* @todo needs implementation
*/
public class TableAndCaption extends FObj {
@@ -56,6 +57,8 @@
private boolean tableFound = false;
/**
+ * Create a TableAndCaption instance with the given {@link FONode}
+ * as parent.
* @param parent FONode that is the parent of this object
*/
public TableAndCaption(FONode parent) {
@@ -81,7 +84,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: marker* table-caption? table
+ * <br>XSL Content Model: marker* table-caption? table
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -120,6 +123,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_TABLE_AND_CAPTION}
*/
public int getNameId() {
return FO_TABLE_AND_CAPTION;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableBody.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableBody.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableBody.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableBody.java Sat Apr 26 15:08:10 2008
@@ -33,7 +33,8 @@
import org.apache.fop.fo.properties.CommonBorderPaddingBackground;
/**
- * Class modelling the fo:table-body object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_table-body">
+ * <code>fo:table-body</code></a> object.
*/
public class TableBody extends TableCellContainer {
// The value of properties relevant for fo:table-body.
@@ -63,23 +64,21 @@
private List rowGroups = new LinkedList();
/**
+ * Create a TableBody instance with the given {@link FONode}
+ * as parent.
* @param parent FONode that is the parent of the object
*/
public TableBody(FONode parent) {
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps();
super.bind(pList);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void processNode(String elementName, Locator locator,
Attributes attlist, PropertyList pList)
throws FOPException {
@@ -99,17 +98,13 @@
super.processNode(elementName, locator, attlist, pList);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void startOfNode() throws FOPException {
super.startOfNode();
getFOEventHandler().startBody(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void endOfNode() throws FOPException {
if (!inMarker()) {
@@ -150,8 +145,8 @@
}
/**
- * {@inheritDoc} String, String)
- * XSL Content Model: marker* (table-row+|table-cell+)
+ * {@inheritDoc}
+ * <br>XSL Content Model: marker* (table-row+|table-cell+)
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -180,9 +175,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void addChildNode(FONode child) throws FOPException {
if (!inMarker()) {
switch (child.getNameId()) {
@@ -236,7 +229,9 @@
}
/**
- * @return the Common Border, Padding, and Background Properties.
+ * Get the {@link CommonBorderPaddingBackground} instance attached
+ * to this TableBody.
+ * @return the {@link CommonBorderPaddingBackground} instance.
*/
public CommonBorderPaddingBackground getCommonBorderPaddingBackground() {
return commonBorderPaddingBackground;
@@ -249,6 +244,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_TABLE_BODY}
*/
public int getNameId() {
return FO_TABLE_BODY;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableCaption.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableCaption.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableCaption.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableCaption.java Sat Apr 26 15:08:10 2008
@@ -30,7 +30,8 @@
/**
- * Class modelling the fo:table-caption object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_table-caption">
+ * <code>fo:table-caption</code></a> object.
*/
public class TableCaption extends FObj {
// The value of properties relevant for fo:table-caption.
@@ -51,7 +52,9 @@
static boolean notImplementedWarningGiven = false;
/**
- * @param parent FONode that is the parent of this object
+ * Create a TableCaption instance with the given {@link FONode}
+ * as parent.
+ * @param parent {@link FONode} that is the parent of this object
*/
public TableCaption(FONode parent) {
super(parent);
@@ -63,16 +66,12 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void endOfNode() throws FOPException {
if (firstChild == null) {
missingChildElementError("marker* (%block;)");
@@ -81,7 +80,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: marker* (%block;)
+ * <br>XSL Content Model: marker* (%block;)
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -105,6 +104,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_TABLE_CAPTION}
*/
public int getNameId() {
return FO_TABLE_CAPTION;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableCell.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableCell.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableCell.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableCell.java Sat Apr 26 15:08:10 2008
@@ -30,7 +30,8 @@
import org.apache.fop.fo.properties.LengthRangeProperty;
/**
- * Class modelling the fo:table-cell object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_table-cell">
+ * <code>fo:table-cell</code></a> object.
*/
public class TableCell extends TableFObj {
// The value of properties relevant for fo:table-cell.
@@ -60,7 +61,9 @@
private boolean blockItemFound = false;
/**
- * @param parent FONode that is the parent of this object
+ * Create a TableCell instance with the given {@link FONode}
+ * as parent.
+ * @param parent {@link FONode} that is the parent of this object
*/
public TableCell(FONode parent) {
super(parent);
@@ -87,9 +90,7 @@
width = pList.get(PR_WIDTH).getLength();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void startOfNode() throws FOPException {
super.startOfNode();
getFOEventHandler().startCell(this);
@@ -115,7 +116,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: marker* (%block;)+
+ * <br>XSL Content Model: marker* (%block;)+
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -146,25 +147,32 @@
}
/**
- * @return the Common Border, Padding, and Background Properties.
+ * Get the {@link CommonBorderPaddingBackground} instance
+ * attached to this TableCell.
+ * @return the {@link CommonBorderPaddingBackground} instance
*/
public CommonBorderPaddingBackground getCommonBorderPaddingBackground() {
return this.commonBorderPaddingBackground;
}
/**
+ * Get the value for the <code>column-number</code> property.
* @return the "column-number" property.
*/
public int getColumnNumber() {
return columnNumber;
}
- /** @return true if "empty-cells" is "show" */
+ /**
+ * Get the value for the <code>empty-cells</code> property.
+ * @return true if "empty-cells" is "show"
+ */
public boolean showEmptyCells() {
return (this.emptyCells == EN_SHOW);
}
/**
+ * Get the value for the <code>number-columns-spanned</code> property
* @return the "number-columns-spanned" property.
*/
public int getNumberColumnsSpanned() {
@@ -172,6 +180,7 @@
}
/**
+ * Get the value for the <code>number-rows-spanned</code> property
* @return the "number-rows-spanned" property.
*/
public int getNumberRowsSpanned() {
@@ -179,30 +188,41 @@
}
/**
+ * Get the value for the <code>block-progression-dimension</code> property
* @return the "block-progression-dimension" property.
*/
public LengthRangeProperty getBlockProgressionDimension() {
return blockProgressionDimension;
}
- /** @return the display-align property. */
+ /**
+ * Get the value for the <code>display-align</code> property
+ * @return the display-align property.
+ */
public int getDisplayAlign() {
return displayAlign;
}
/**
+ * Get the value for the <code>width</code> property
* @return the "width" property.
*/
public Length getWidth() {
return width;
}
- /** @return true if the cell starts a row. */
+ /**
+ * Get the value for the <code>starts-row</code> property
+ * @return true if the cell starts a row.
+ */
public boolean startsRow() {
return (startsRow == EN_TRUE);
}
- /** @return true if the cell ends a row. */
+ /**
+ * Get the value for the <code>ends-row</code> property
+ * @return true if the cell ends a row.
+ */
public boolean endsRow() {
return (endsRow == EN_TRUE);
}
@@ -214,6 +234,7 @@
/**
* {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_TABLE_CELL}
*/
public final int getNameId() {
return FO_TABLE_CELL;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableColumn.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableColumn.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableColumn.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableColumn.java Sat Apr 26 15:08:10 2008
@@ -34,7 +34,8 @@
import org.apache.fop.layoutmgr.table.CollapsingBorderModel;
/**
- * Class modelling the fo:table-column object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_table-column">
+ * <code>fo:table-column</code></a> object.
*/
public class TableColumn extends TableFObj {
// The value of properties relevant for fo:table-column.
@@ -51,13 +52,19 @@
private PropertyList pList = null;
/**
- * @param parent FONode that is the parent of this object
+ * Create a TableColumn instance with the given {@link FONode}
+ * as parent.
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public TableColumn(FONode parent) {
this(parent, false);
}
/**
+ * Create a TableColumn instance with the given {@link FONode}
+ * as parent
+ *
* @param parent FONode that is the parent of this object
* @param implicit true if this table-column has automatically been created (does not
* correspond to an explicit fo:table-column in the input document)
@@ -68,9 +75,7 @@
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps();
columnNumber = pList.get(PR_COLUMN_NUMBER).getNumeric().getValue();
@@ -117,9 +122,7 @@
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void startOfNode() throws FOPException {
super.startOfNode();
getFOEventHandler().startColumn(this);
@@ -146,7 +149,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: empty
+ * <br>XSL Content Model: empty
*/
protected void validateChildNode(Locator loc,
String nsURI, String localName)
@@ -157,13 +160,17 @@
}
/**
- * @return the Common Border, Padding, and Background Properties.
+ * Get the {@link CommonBorderPaddingBackground} instance
+ * attached to this TableColumn.
+ * @return the {@link CommonBorderPaddingBackground} instance
*/
public CommonBorderPaddingBackground getCommonBorderPaddingBackground() {
return commonBorderPaddingBackground;
}
/**
+ * Get a {@link Length} instance corresponding to the
+ * <code>column-width</code> property.
* @return the "column-width" property.
*/
public Length getColumnWidth() {
@@ -179,6 +186,7 @@
}
/**
+ * Get the value of the <code>column-number</code> property
* @return the "column-number" property.
*/
public int getColumnNumber() {
@@ -187,7 +195,7 @@
/**
* Used for setting the column-number for an implicit column
- * @param columnNumber
+ * @param columnNumber the number to set
*/
protected void setColumnNumber(int columnNumber) {
this.columnNumber = columnNumber;
@@ -208,7 +216,10 @@
return "table-column";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_TABLE_COLUMN}
+ */
public int getNameId() {
return FO_TABLE_COLUMN;
}
@@ -244,10 +255,10 @@
/**
* Retrieve a property value through its Id; used by
* from-table-column() function
- *
+ *
* @param propId the id for the property to retrieve
* @return the requested Property
- * @throws PropertyException if there is a problem evaluating the property
+ * @throws PropertyException if there is a problem evaluating the property
*/
public Property getProperty(int propId) throws PropertyException {
return this.pList.get(propId);
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableFooter.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableFooter.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableFooter.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableFooter.java Sat Apr 26 15:08:10 2008
@@ -25,36 +25,33 @@
/**
- * Class modelling the fo:table-footer object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_table-footer">
+ * <code>fo:table-footer</code></a> object.
*/
public class TableFooter extends TableBody {
/**
- * @param parent FONode that is the parent of this object
+ * Create a TableFooter instance with the given {@link FONode}
+ * as parent.
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public TableFooter(FONode parent) {
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void startOfNode() throws FOPException {
super.startOfNode();
- //getFOEventHandler().startBody(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void endOfNode() throws FOPException {
-// getFOEventHandler().endFooter(this);
if (!(tableRowsFound || tableCellsFound)) {
missingChildElementError("marker* (table-row+|table-cell+)");
} else {
finishLastRowGroup();
}
-// convertCellsToRows();
}
/** {@inheritDoc} */
@@ -62,7 +59,10 @@
return "table-footer";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_TABLE_FOOTER}
+ */
public int getNameId() {
return FO_TABLE_FOOTER;
}
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableHeader.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableHeader.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableHeader.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableHeader.java Sat Apr 26 15:08:10 2008
@@ -25,36 +25,32 @@
/**
- * Class modelling the fo:table-header object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_table-header">
+ * <code>fo:table-header</code></a> object.
*/
public class TableHeader extends TableBody {
/**
- * @param parent FONode that is the parent of this object
+ * Create a TableHeader instance with the given {@link FONode}
+ * as parent.
+ * @param parent {@link FONode} that is the parent of this object
*/
public TableHeader(FONode parent) {
super(parent);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void startOfNode() throws FOPException {
super.startOfNode();
- //getFOEventHandler().startHeader(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void endOfNode() throws FOPException {
-// getFOEventHandler().endHeader(this);
if (!(tableRowsFound || tableCellsFound)) {
missingChildElementError("marker* (table-row+|table-cell+)");
} else {
finishLastRowGroup();
}
-// convertCellsToRows();
}
/** {@inheritDoc} */
@@ -62,7 +58,10 @@
return "table-header";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_TABLE_HEADER}
+ */
public int getNameId() {
return FO_TABLE_HEADER;
}
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableRow.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableRow.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableRow.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/flow/table/TableRow.java Sat Apr 26 15:08:10 2008
@@ -32,7 +32,8 @@
import org.apache.fop.fo.properties.LengthRangeProperty;
/**
- * Class modelling the fo:table-row object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_table-row">
+ * <code>fo:table-row</code></a> object.
*/
public class TableRow extends TableCellContainer {
// The value of properties relevant for fo:table-row.
@@ -52,7 +53,9 @@
// End of property values
/**
- * @param parent FONode that is the parent of this object
+ * Create a TableRow instance with the given {@link FONode}
+ * as parent.
+ * @param parent {@link FONode} that is the parent of this object
*/
public TableRow(FONode parent) {
super(parent);
@@ -83,9 +86,7 @@
super.processNode(elementName, locator, attlist, pList);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
protected void addChildNode(FONode child) throws FOPException {
if (!inMarker()) {
TableCell cell = (TableCell) child;
@@ -95,17 +96,13 @@
super.addChildNode(child);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void startOfNode() throws FOPException {
super.startOfNode();
getFOEventHandler().startRow(this);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void endOfNode() throws FOPException {
if (firstChild == null) {
missingChildElementError("(table-cell+)");
@@ -119,7 +116,7 @@
/**
* {@inheritDoc} String, String)
- * XSL Content Model: (table-cell+)
+ * <br>XSL Content Model: (table-cell+)
*/
protected void validateChildNode(Locator loc, String nsURI,
String localName)
@@ -141,7 +138,7 @@
return true;
}
- /** {inheritDoc} */
+ /** {@inheritDoc} */
protected void setCollapsedBorders() {
TableBody body = (TableBody) parent;
createBorder(CommonBorderPaddingBackground.START, body);
@@ -231,7 +228,10 @@
return "table-row";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_TABLE_ROW}
+ */
public int getNameId() {
return FO_TABLE_ROW;
}
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/AbstractPageSequence.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/AbstractPageSequence.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/AbstractPageSequence.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/AbstractPageSequence.java Sat Apr 26 15:08:10 2008
@@ -26,15 +26,15 @@
import org.apache.fop.fo.PropertyList;
/**
- * Abstract base class for the fo:page-sequence formatting object and the fox:external-document
- * extension object.
+ * Abstract base class for the <a href="http://www.w3.org/TR/xsl/#fo_page-sequence">
+ * <code>fo:page-sequence</code></a> formatting object and the
+ * <a href="http://xmlgraphics.apache.org/fop/0.95/extensions.html#external-document">
+ * <code>fox:external-document</code></a> extension object.
*/
public abstract class AbstractPageSequence extends FObj {
// The value of properties relevant for fo:page-sequence.
- /** the initial-page-number value */
protected Numeric initialPageNumber;
- /** the force-page-count value */
protected int forcePageCount;
private String format;
private int letterValue;
@@ -45,13 +45,13 @@
private PageNumberGenerator pageNumberGenerator;
- /** the first page number generated by the page sequence */
protected int startingPageNumber = 0;
/**
- * Create a page sequence FO node.
+ * Create an AbstractPageSequence that is a child
+ * of the given parent {@link FONode}.
*
- * @param parent the parent FO node
+ * @param parent the parent {@link FONode}
*/
public AbstractPageSequence(FONode parent) {
super(parent);
@@ -76,10 +76,6 @@
}
- /** {@inheritDoc} */
- protected void endOfNode() throws FOPException {
- }
-
/**
* Initialize the current page number for the start of the page sequence.
*/
@@ -132,18 +128,25 @@
return (Root)this.getParent();
}
- /** @return the force-page-count value */
+ /**
+ * Get the value of the <code>force-page-count</code> property.
+ * @return the force-page-count value
+ */
public int getForcePageCount() {
return forcePageCount;
}
- /** @return the initial-page-number property value */
+ /**
+ * Get the value of the <code>initial-page-number</code> property.
+ * @return the initial-page-number property value
+ */
public Numeric getInitialPageNumber() {
return initialPageNumber;
}
/**
- * @return the "reference-orientation" property.
+ * Get the value of the <code>reference-orientation</code> property.
+ * @return the "reference-orientation" property
* @since XSL 1.1
*/
public int getReferenceOrientation() {
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/ColorProfile.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/ColorProfile.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/ColorProfile.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/ColorProfile.java Sat Apr 26 15:08:10 2008
@@ -19,16 +19,18 @@
package org.apache.fop.fo.pagination;
-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.xml.sax.Locator;
+
/**
- * The fo:color-profile formatting object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_color-profile">
+ * <code>fo:color-profile</code></a> object.
+ *
* This loads the color profile when needed and resolves a requested color.
*/
public class ColorProfile extends FObj {
@@ -39,9 +41,9 @@
// End of property values
/**
- * Creates a new color-profile element.
- * @param parent the parent node
- * @see org.apache.fop.fo.FONode#FONode(FONode)
+ * Base constructor
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public ColorProfile(FONode parent) {
super(parent);
@@ -56,7 +58,7 @@
/**
* {@inheritDoc}
- XSL 1.0/FOP: EMPTY (no child nodes permitted)
+ * <br>XSL 1.0/FOP: EMPTY (no child nodes permitted)
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -66,8 +68,7 @@
}
/**
- * Return the "color-profile-name" property.
- * @return the color-profile-name property
+ * @return the "color-profile-name" property.
*/
public String getColorProfileName() {
return colorProfileName;
@@ -78,7 +79,10 @@
return "color-profile";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_COLOR_PROFILE}
+ */
public int getNameId() {
return FO_COLOR_PROFILE;
}
@@ -86,7 +90,7 @@
/**
* Get src attribute
*
- * @return Value of color-profile src attribute
+ * @return value of color-profile src attribute
*/
public String getSrc() {
return this.src;
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java Sat Apr 26 15:08:10 2008
@@ -29,7 +29,9 @@
import org.apache.fop.fo.ValidationException;
/**
- * A conditional-page-master-reference formatting object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_conditional-page-master-reference">
+ * <code>fo:conditional-page-master-reference</code></a> object.
+ *
* This is a reference to a page master with a set of conditions.
* The conditions must be satisfied for the referenced master to
* be used.
@@ -45,9 +47,10 @@
// End of property values
/**
- * Creates a new conditional-page-master-reference element.
- * @param parent the parent node
- * @see org.apache.fop.fo.FONode#FONode(FONode)
+ * Create a ConditionalPageMasterReference instance that is a
+ * child of the given {@link FONode}.
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public ConditionalPageMasterReference(FONode parent) {
super(parent);
@@ -76,13 +79,11 @@
/**
* {@inheritDoc}
- * XSL Content Model: empty
+ * <br>XSL Content Model: empty
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
- throws ValidationException {
- if (FO_URI.equals(nsURI)) {
- invalidChildError(loc, nsURI, localName);
- }
+ throws ValidationException {
+ invalidChildError(loc, nsURI, localName);
}
/**
@@ -150,12 +151,18 @@
return true;
}
- /** @return the "master-reference" property. */
+ /**
+ * Get the value for the <code>master-reference</code> property.
+ * @return the "master-reference" property
+ */
public String getMasterReference() {
return masterReference;
}
- /** @return the page-position property value */
+ /**
+ * Get the value for the <code>page-position</code> property.
+ * @return the page-position property value
+ */
public int getPagePosition() {
return this.pagePosition;
}
@@ -165,7 +172,10 @@
return "conditional-page-master-reference";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_CONDITIONAL_PAGE_MASTER_REFERENCE}
+ */
public int getNameId() {
return FO_CONDITIONAL_PAGE_MASTER_REFERENCE;
}
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/Declarations.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/Declarations.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/Declarations.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/Declarations.java Sat Apr 26 15:08:10 2008
@@ -31,7 +31,9 @@
import org.apache.fop.fo.ValidationException;
/**
- * Declarations formatting object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_declarations">
+ * <code>fo:declarations</code></a> object.
+ *
* A declarations formatting object holds a set of color-profiles
* and optionally additional non-XSL namespace elements.
* The color-profiles are held in a hashmap for use with color-profile
@@ -42,7 +44,6 @@
private Map colorProfiles = null;
/**
- * Creates a new declarations element.
* @param parent FONode that is the parent of this object
*/
public Declarations(FONode parent) {
@@ -57,13 +58,13 @@
/**
* {@inheritDoc}
- * XSL 1.0: (color-profile)+ (and non-XSL NS nodes)
- * FOP/XSL 1.1: (color-profile)* (and non-XSL NS nodes)
+ * <br>XSL 1.0: (color-profile)+ (and non-XSL NS nodes)
+ * <br>FOP/XSL 1.1: (color-profile)* (and non-XSL NS nodes)
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
if (FO_URI.equals(nsURI)) {
- if (!localName.equals("color-profile")) {
+ if (!localName.equals("color-profile")) {
invalidChildError(loc, nsURI, localName);
}
} // anything outside of XSL namespace is OK.
@@ -112,7 +113,10 @@
return "declarations";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_DECLARATIONS}
+ */
public int getNameId() {
return FO_DECLARATIONS;
}
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/Flow.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/Flow.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/Flow.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/Flow.java Sat Apr 26 15:08:10 2008
@@ -28,7 +28,9 @@
import org.apache.fop.fo.ValidationException;
/**
- * Class modelling the fo:flow object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_flow">
+ * <code>fo:flow</code></a> object.
+ *
*/
public class Flow extends FObj {
// The value of properties relevant for fo:flow.
@@ -39,7 +41,8 @@
private boolean blockItemFound = false;
/**
- * @param parent FONode that is the parent of this object
+ * Create a Flow instance that is a child of the given {@link FONode}.
+ * @param parent the {@link FONode} that is the parent of this object
*/
public Flow(FONode parent) {
super(parent);
@@ -86,7 +89,7 @@
/**
* {@inheritDoc}
- * XSL Content Model: marker* (%block;)+
+ * <br>XSL Content Model: marker* (%block;)+
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -103,7 +106,10 @@
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return true (Flow can generate reference areas)
+ */
public boolean generatesReferenceAreas() {
return true;
}
@@ -118,7 +124,10 @@
return "flow";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_FLOW}
+ */
public int getNameId() {
return FO_FLOW;
}
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java?rev=651866&r1=651865&r2=651866&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java Sat Apr 26 15:08:10 2008
@@ -32,7 +32,9 @@
import org.apache.fop.fo.ValidationException;
/**
- * The layout-master-set formatting object.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_layout-master-set">
+ * <code>fo:layout-master-set</code></a> object.
+ *
* This class maintains the set of simple page master and
* page sequence masters.
* The masters are stored so that the page sequence can obtain
@@ -46,9 +48,10 @@
private Map pageSequenceMasters;
/**
- * Creates a new layout-master-set element.
- * @param parent the parent node
- * @see org.apache.fop.fo.FONode#FONode(FONode)
+ * Create a LayoutMasterSet instance that is a child of the given
+ * parent {@link FONode}.
+ *
+ * @param parent {@link FONode} that is the parent of this object
*/
public LayoutMasterSet(FONode parent) {
super(parent);
@@ -76,7 +79,7 @@
/**
* {@inheritDoc}
- XSL/FOP: (simple-page-master|page-sequence-master)+
+ * <br>XSL/FOP: (simple-page-master|page-sequence-master)+
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
@@ -205,7 +208,10 @@
return "layout-master-set";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_LAYOUT_MASTER_SET}
+ */
public int getNameId() {
return FO_LAYOUT_MASTER_SET;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: fop-commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: fop-commits-help@xmlgraphics.apache.org