git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@232563 13f79535-47bb-0310-9956-ffa450edef68pull/31/head
@@ -101,7 +101,7 @@ public class Fop implements Constants { | |||
/** | |||
* Constructor that creates a default FOUserAgent | |||
* @see org.apache.fop.apps.Fop#(int, FOUserAgent) | |||
* @see org.apache.fop.apps.Fop#Fop(int, FOUserAgent) | |||
*/ | |||
public Fop(int renderType) { | |||
this(renderType, new FOUserAgent()); |
@@ -53,7 +53,7 @@ public class BookmarkData extends OffDocumentItem implements Resolvable { | |||
* This should only be called by the bookmark-tree item because | |||
* it has no idref item that needs to be resolved. | |||
* | |||
* @param bookmarks fo:bookmark-tree for this document | |||
* @param bookmarkTree fo:bookmark-tree for this document | |||
*/ | |||
public BookmarkData(BookmarkTree bookmarkTree) { | |||
idRef = null; |
@@ -46,7 +46,7 @@ public class CachedRenderPagesModel extends RenderPagesModel { | |||
/** | |||
* Constructor | |||
* @see org.apache.fop.area.RenderPagesModel(FOUserAgent, int, FontInfo, OutputStream) | |||
* @see org.apache.fop.area.RenderPagesModel#RenderPagesModel(FOUserAgent, int, FontInfo, OutputStream) | |||
*/ | |||
public CachedRenderPagesModel (FOUserAgent userAgent, int renderType, | |||
FontInfo fontInfo, OutputStream stream) throws FOPException { |
@@ -61,7 +61,7 @@ public class LinkResolver implements Resolvable, Serializable { | |||
/** | |||
* Resolve by adding an internal link. | |||
* | |||
* @see org.apache.fop.area.Resolveable#resolveIDRef(String, List) | |||
* @see org.apache.fop.area.Resolvable#resolveIDRef(String, List) | |||
*/ | |||
public void resolveIDRef(String id, List pages) { | |||
if (idRef.equals(id) && pages != null) { |
@@ -68,19 +68,18 @@ public class MainReference extends Area { | |||
} | |||
/** | |||
* Get the span area currently being filled (i.e., the last span created) | |||
* | |||
* @return the active span | |||
* Get the span area currently being filled (i.e., the last span created). | |||
* @return the active span. | |||
*/ | |||
public Span getCurrentSpan() { | |||
return (Span) spanAreas.get(spanAreas.size()-1); | |||
} | |||
/** | |||
* indicates whether any child areas have been added to this reference area | |||
* this is achieved by looping through each span | |||
* Indicates whether any child areas have been added to this reference area. | |||
* | |||
* @return | |||
* This is achieved by looping through each span. | |||
* @return true if no child areas have been added yet. | |||
*/ | |||
public boolean isEmpty() { | |||
if (isEmpty) { |
@@ -153,7 +153,7 @@ public class PageViewport implements Resolvable, Cloneable { | |||
* to unresolvedIDRefs, for subsequent resolution by AreaTreeHandler | |||
* calls to this object's resolveIDRef(). | |||
* | |||
* @param id the idref | |||
* @param idref the idref | |||
* @param res the child element of this page that needs this | |||
* idref resolved | |||
*/ | |||
@@ -188,7 +188,7 @@ public class PageViewport implements Resolvable, Cloneable { | |||
} | |||
/** | |||
* @see org.apache.fop.area.Resolveable#resolveIDRef(String, List) | |||
* @see org.apache.fop.area.Resolvable#resolveIDRef(String, List) | |||
*/ | |||
public void resolveIDRef(String id, List pages) { | |||
if (page == null) { | |||
@@ -516,4 +516,4 @@ public class PageViewport implements Resolvable, Cloneable { | |||
public RegionReference getRegionReference(int id) { | |||
return getPage().getRegionViewport(id).getRegionReference(); | |||
} | |||
} | |||
} |
@@ -44,7 +44,8 @@ public class RegionReference extends Area implements Cloneable { | |||
/** | |||
* Create a new region reference area. | |||
* | |||
* @param type the region class type | |||
* @param regionFO the region. | |||
* @param parent the viewport for this region. | |||
*/ | |||
public RegionReference(Region regionFO, RegionViewport parent) { | |||
this.regionFO = regionFO; |
@@ -28,7 +28,7 @@ public interface CompoundDatatype extends Constants { | |||
/** | |||
* Sets a component of the compound datatype. | |||
* @param Constants ID of the component | |||
* @param cmpId ID of the component | |||
* @param cmpnValue value of the component | |||
* @param bIsDefault Indicates if it's the default value | |||
*/ | |||
@@ -36,7 +36,7 @@ public interface CompoundDatatype extends Constants { | |||
/** | |||
* Returns a component of the compound datatype. | |||
* @param Constants ID of the component | |||
* @param cmpId ID of the component | |||
* @return the value of the component | |||
*/ | |||
Property getComponent(int cmpId); |
@@ -84,7 +84,7 @@ public abstract class FOEventHandler { | |||
/** | |||
* Main constructor | |||
* @param FOUserAgent the apps.FOUserAgent instance for this process | |||
* @param foUserAgent the apps.FOUserAgent instance for this process | |||
*/ | |||
public FOEventHandler(FOUserAgent foUserAgent) { | |||
this.foUserAgent = foUserAgent; | |||
@@ -203,7 +203,7 @@ public abstract class FOEventHandler { | |||
/** | |||
* | |||
* @param bl BlockContainer that is starting. | |||
* @param blc BlockContainer that is starting. | |||
*/ | |||
public void startBlockContainer(BlockContainer blc) { | |||
} |
@@ -355,10 +355,9 @@ public abstract class FONode implements Cloneable { | |||
} | |||
/** | |||
* Helper function to return missing child element errors | |||
* (e.g., fo:layout-master-set not having any page-master child element) | |||
* @param contentModel The XSL Content Model for the fo: object. | |||
* or a similar description indicating child elements needed. | |||
* Helper function to throw an error caused by missing mandatory child elements. | |||
* E.g., fo:layout-master-set not having any page-master child element. | |||
* @param contentModel The XSL Content Model for the fo: object or a similar description indicating the necessary child elements. | |||
*/ | |||
protected void missingChildElementError(String contentModel) | |||
throws ValidationException { | |||
@@ -368,10 +367,8 @@ public abstract class FONode implements Cloneable { | |||
} | |||
/** | |||
* Helper function to return missing child element errors | |||
* (e.g., fo:layout-master-set not having any page-master child element) | |||
* @param contentModel The XSL Content Model for the fo: object. | |||
* or a similar description indicating child elements needed. | |||
* Helper function to throw an error caused by missing mandatory properties | |||
* @param propertyName the name of the missing property. | |||
*/ | |||
protected void missingPropertyError(String propertyName) | |||
throws ValidationException { |
@@ -140,10 +140,9 @@ public class NumericOp { | |||
} | |||
/** | |||
* Return the absolute value of the operand Numeric. | |||
* @param op1 The first operand. | |||
* @param op2 The second operand. | |||
* @return A new Numeric object representing the absolute value. | |||
* Return the absolute value of a Numeric. | |||
* @param op the operand. | |||
* @return a new Numeric object representing the absolute value of the operand. | |||
*/ | |||
public static Numeric abs(Numeric op) throws PropertyException { | |||
if (op.isAbsolute()) { | |||
@@ -158,10 +157,9 @@ public class NumericOp { | |||
} | |||
/** | |||
* Return the absolute value of the operand Numeric. | |||
* @param op1 The first operand. | |||
* @param op2 The second operand. | |||
* @return A new Numeric object representing the absolute value. | |||
* Return the negation of a Numeric. | |||
* @param op the operand. | |||
* @return a new Numeric object representing the negation of the operand. | |||
*/ | |||
public static Numeric negate(Numeric op) throws PropertyException { | |||
if (op.isAbsolute()) { | |||
@@ -176,12 +174,11 @@ public class NumericOp { | |||
} | |||
/** | |||
* Return the largest of the two operands. | |||
* Return the larger of the two Numerics. | |||
* @param op1 The first operand. | |||
* @param op2 The second operand. | |||
* @return a Numeric which is the maximum of the two operands. | |||
* @throws PropertyException If the dimensions or value types of the | |||
* object and the operand are different. | |||
* @throws PropertyException if the dimensions or value types of the operands are different. | |||
*/ | |||
public static Numeric max(Numeric op1, Numeric op2) throws PropertyException { | |||
if (op1.isAbsolute() && op2.isAbsolute()) { | |||
@@ -199,12 +196,11 @@ public class NumericOp { | |||
} | |||
/** | |||
* Return the smallest of the two operands. | |||
* Return the smaller of two Numerics. | |||
* @param op1 The first operand. | |||
* @param op2 The second operand. | |||
* @return a Numeric which is the minimum of the two operands. | |||
* @throws PropertyException If the dimensions or value types of the | |||
* object and the operand are different. | |||
* @throws PropertyException if the dimensions or value types of the operands are different. | |||
*/ | |||
public static Numeric min(Numeric op1, Numeric op2) throws PropertyException { | |||
if (op1.isAbsolute() && op2.isAbsolute()) { |
@@ -34,7 +34,6 @@ public class NumericProperty extends Property implements Numeric, Length { | |||
/** | |||
* Construct a Numeric object by specifying one or more components, | |||
* including absolute length, percent length, table units. | |||
* @param valType A combination of bits representing the value types. | |||
* @param value The value of the numeric. | |||
* @param dim The dimension of the value. 0 for a Number, 1 for a Length | |||
* (any type), >1, <0 if Lengths have been multiplied or divided. |
@@ -280,7 +280,7 @@ public class ExternalGraphic extends FObj { | |||
} | |||
/** | |||
* @see org.apache.fop.fo.FObj#getLayoutDimension(org.apache.fop.datatypes.PercentBase.DimensionType) | |||
* @see org.apache.fop.fo.FObj#getLayoutDimension(org.apache.fop.datatypes.PercentBase.LayoutDimension) | |||
*/ | |||
public Number getLayoutDimension(PercentBase.LayoutDimension key) { | |||
if (key == PercentBase.IMAGE_INTRINSIC_WIDTH) { |
@@ -121,7 +121,7 @@ public class InstreamForeignObject extends FObj { | |||
} | |||
/** | |||
* @see org.apache.fop.fo.FONode#start | |||
* @see org.apache.fop.fo.FONode#startOfNode | |||
*/ | |||
protected void startOfNode() throws FOPException { | |||
checkId(id); |
@@ -69,7 +69,7 @@ public class SimplePageMaster extends FObj { | |||
} | |||
/** | |||
* @see org.apache.fop.fo.FObj#resolve | |||
* @see org.apache.fop.fo.FObj#bind | |||
*/ | |||
public void bind(PropertyList pList) throws FOPException { | |||
commonMarginBlock = pList.getMarginBlockProps(); |
@@ -849,7 +849,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager { | |||
/** | |||
* Force current area to be added to parent area. | |||
* @see org.apache.fop.layoutmgr.AbstractLayoutManager#flush() | |||
* @see org.apache.fop.layoutmgr.BlockStackingLayoutManager#flush() | |||
*/ | |||
protected void flush() { | |||
viewportBlockArea.addBlock(referenceArea, autoHeight); |
@@ -730,17 +730,17 @@ public abstract class BreakingAlgorithm { | |||
/** | |||
* Return the element at index idx in the paragraph. | |||
* @param idx index of the element. | |||
* @return | |||
* @return the element at index idx in the paragraph. | |||
*/ | |||
protected KnuthElement getElement(int idx) { | |||
return (KnuthElement) par.get(idx); | |||
} | |||
/** | |||
* Compare two KnuthNodes and return the node with the least demerit. | |||
* Compare two KnuthNodes and return the node with the least demerit. | |||
* @param node1 The first knuth node. | |||
* @param node2 The other knuth node. | |||
* @return | |||
* @return the node with the least demerit. | |||
*/ | |||
protected KnuthNode compareNodes(KnuthNode node1, KnuthNode node2) { | |||
if (node1 == null || node2.position > node1.position) { |
@@ -723,7 +723,7 @@ public abstract class Java2DRenderer extends AbstractRenderer implements Printab | |||
} | |||
/** | |||
* @see org.apache.fop.render.Renderer#renderText(TextArea) | |||
* @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) | |||
*/ | |||
public void renderText(TextArea text) { | |||
@@ -752,7 +752,7 @@ public abstract class Java2DRenderer extends AbstractRenderer implements Printab | |||
} | |||
/** | |||
* @see org.apache.fop.render.Renderer#renderCharacter(Character) | |||
* @see org.apache.fop.render.AbstractRenderer#renderCharacter(Character) | |||
*/ | |||
public void renderCharacter(Character ch) { | |||
@@ -120,7 +120,7 @@ public interface RendererState { | |||
/** | |||
* Overwrites the Transform in the Graphics2D context. Use <code>transform()</code> if you | |||
* wish to compose with the current Affinetransform instead. | |||
* @see java.awt.Graphics2D.setTransform(). | |||
* @see java.awt.Graphics2D#setTransform(AffineTransform tf). | |||
* @param tf the transform to concatonate to the current level transform | |||
*/ | |||
public abstract void setTransform(AffineTransform tf); | |||
@@ -128,7 +128,7 @@ public interface RendererState { | |||
/** | |||
* Composes an AffineTransform object with the Transform in this Graphics2D | |||
* according to the rule last-specified-first-applied. | |||
* @see java.awt.Graphics2D.transform(). | |||
* @see java.awt.Graphics2D#transform(AffineTransform tf). | |||
* | |||
* @param tf the transform to concatonate to the current level transform | |||
*/ |
@@ -1315,7 +1315,7 @@ public class PDFRenderer extends PrintRenderer { | |||
} | |||
/** | |||
* @see org.apache.fop.render.Renderer#renderCharacter(Character) | |||
* @see org.apache.fop.render.AbstractRenderer#renderCharacter(Character) | |||
*/ | |||
public void renderCharacter(Character ch) { | |||
StringBuffer pdf = new StringBuffer(); | |||
@@ -1388,7 +1388,7 @@ public class PDFRenderer extends PrintRenderer { | |||
} | |||
/** | |||
* @see org.apache.fop.render.Renderer#renderText(TextArea) | |||
* @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) | |||
*/ | |||
public void renderText(TextArea text) { | |||
beginTextObject(); |
@@ -441,7 +441,7 @@ public class PSRenderer extends PrintRenderer { | |||
} | |||
/** | |||
* @see org.apache.fop.render.Renderer#renderText(TextArea) | |||
* @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) | |||
*/ | |||
public void renderText(TextArea area) { | |||
String fontname = (String)area.getTrait(Trait.FONT_NAME); |
@@ -202,7 +202,7 @@ public class SVGRenderer extends AbstractRenderer implements XMLHandler { | |||
} | |||
/** | |||
* @see org.apache.fop.render.Renderer#startPageSequence(Title) | |||
* @see org.apache.fop.render.Renderer#startPageSequence(LineArea) | |||
*/ | |||
public void startPageSequence(LineArea seqTitle) { | |||
totalWidth += sequenceWidth; | |||
@@ -351,7 +351,7 @@ public class SVGRenderer extends AbstractRenderer implements XMLHandler { | |||
} | |||
/** | |||
* @see org.apache.fop.render.Renderer#renderLeader(Leader) | |||
* @see org.apache.fop.render.AbstractRenderer#renderLeader(Leader) | |||
*/ | |||
public void renderLeader(Leader area) { | |||
String style = "stroke:black;stroke-width:" | |||
@@ -386,7 +386,7 @@ public class SVGRenderer extends AbstractRenderer implements XMLHandler { | |||
} | |||
/** | |||
* @see org.apache.fop.render.Renderer#renderText(TextArea) | |||
* @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) | |||
*/ | |||
public void renderText(TextArea text) { | |||
Element textElement = SVGUtilities.createText(svgDocument, | |||
@@ -399,7 +399,7 @@ public class SVGRenderer extends AbstractRenderer implements XMLHandler { | |||
} | |||
/** | |||
* @see org.apache.fop.render.Renderer#renderCharacter(Character) | |||
* @see org.apache.fop.render.AbstractRenderer#renderCharacter(Character) | |||
*/ | |||
public void renderCharacter(org.apache.fop.area.inline.Character ch) { | |||
Element text = SVGUtilities.createText(svgDocument, |
@@ -346,7 +346,7 @@ public class XMLRenderer extends AbstractRenderer { | |||
} | |||
/** | |||
* @see org.apache.fop.render.Renderer#startPageSequence(Title) | |||
* @see org.apache.fop.render.Renderer#startPageSequence(LineArea) | |||
*/ | |||
public void startPageSequence(LineArea seqTitle) { | |||
if (startedSequence) { | |||
@@ -454,7 +454,7 @@ public class XMLRenderer extends AbstractRenderer { | |||
} | |||
/** | |||
* @see org.apache.fop.render.AbstractRenderer#renderFlow(Flow) | |||
* @see org.apache.fop.render.AbstractRenderer#renderFlow(NormalFlow) | |||
*/ | |||
protected void renderFlow(NormalFlow flow) { | |||
// the normal flow reference area contains stacked blocks |