git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@990148 13f79535-47bb-0310-9956-ffa450edef68tags/fop-1_1rc1old
* object that corresponds to the IDRef | * object that corresponds to the IDRef | ||||
* | * | ||||
* {@inheritDoc} List) | * {@inheritDoc} List) | ||||
* @asf.todo check to make sure it works if multiple bookmark-items | |||||
* TODO check to make sure it works if multiple bookmark-items | |||||
* have the same idref | * have the same idref | ||||
*/ | */ | ||||
public void resolveIDRef(String id, List pages) { | public void resolveIDRef(String id, List pages) { |
* This class creates and returns an array of Property.Maker instances | * This class creates and returns an array of Property.Maker instances | ||||
* indexed by the PR_* propId from Constants.java. | * indexed by the PR_* propId from Constants.java. | ||||
* | * | ||||
* @asf.todo Check multi-threading safety of the statics below | |||||
* TODO Check multi-threading safety of the statics below | |||||
*/ | */ | ||||
public final class FOPropertyMapping implements Constants { | public final class FOPropertyMapping implements Constants { | ||||
/** | /** | ||||
* Check if this formatting object generates reference areas. | * Check if this formatting object generates reference areas. | ||||
* @return true if generates reference areas | * @return true if generates reference areas | ||||
* @asf.todo see if needed | |||||
* TODO see if needed | |||||
*/ | */ | ||||
public boolean generatesReferenceAreas() { | public boolean generatesReferenceAreas() { | ||||
return false; | return false; |
/** | /** | ||||
* {@inheritDoc} | * {@inheritDoc} | ||||
* <br>XSL Content Model: (inline,footnote-body) | * <br>XSL Content Model: (inline,footnote-body) | ||||
* @asf.todo implement additional constraint: A fo:footnote is not permitted | |||||
* TODO implement additional constraint: A fo:footnote is not permitted | |||||
* to have a fo:float, fo:footnote, or fo:marker as a descendant. | * to have a fo:float, fo:footnote, or fo:marker as a descendant. | ||||
* @asf.todo implement additional constraint: A fo:footnote is not | |||||
* TODO implement additional constraint: A fo:footnote is not | |||||
* permitted to have as a descendant a fo:block-container that | * permitted to have as a descendant a fo:block-container that | ||||
* generates an absolutely positioned area. | * generates an absolutely positioned area. | ||||
*/ | */ |
* <code>fo:leader</code></a> object. | * <code>fo:leader</code></a> object. | ||||
* The main property of <code>fo:leader</code> is leader-pattern. | * The main property of <code>fo:leader</code> is leader-pattern. | ||||
* The following patterns are treated: rule, space, dots and use-content. | * The following patterns are treated: rule, space, dots and use-content. | ||||
* @asf.todo implement validateChildNode() | |||||
* TODO implement validateChildNode() | |||||
*/ | */ | ||||
public class Leader extends InlineLevel { | public class Leader extends InlineLevel { | ||||
// The value of properties relevant for fo:leader. | // The value of properties relevant for fo:leader. |
/** | /** | ||||
* {@inheritDoc} | * {@inheritDoc} | ||||
* @asf.todo see if can/should rely on base class for this | |||||
* TODO see if can/should rely on base class for this | |||||
* (i.e., add to childNodes instead) | * (i.e., add to childNodes instead) | ||||
*/ | */ | ||||
public void addChildNode(FONode child) { | public void addChildNode(FONode child) { |
* <br><i>Additionally: "An fo:marker may contain any formatting objects that | * <br><i>Additionally: "An fo:marker may contain any formatting objects that | ||||
* are permitted as a replacement of any fo:retrieve-marker that retrieves | * are permitted as a replacement of any fo:retrieve-marker that retrieves | ||||
* the fo:marker's children."</i> | * the fo:marker's children."</i> | ||||
* @asf.todo implement "additional" constraint, possibly within fo:retrieve-marker | |||||
* TODO implement "additional" constraint, possibly within fo:retrieve-marker | |||||
*/ | */ | ||||
protected void validateChildNode(Locator loc, String nsURI, String localName) | protected void validateChildNode(Locator loc, String nsURI, String localName) | ||||
throws ValidationException { | throws ValidationException { |
/** | /** | ||||
* Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_multi-case"> | * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_multi-case"> | ||||
* <code>fo:multi-case</code></a> object. | * <code>fo:multi-case</code></a> object. | ||||
* @asf.todo implement validateChildNode() | |||||
* TODO implement validateChildNode() | |||||
*/ | */ | ||||
public class MultiCase extends FObj { | public class MultiCase extends FObj { | ||||
// The value of properties relevant for fo:multi-case. | // The value of properties relevant for fo:multi-case. |
/** | /** | ||||
* Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_table-and-caption"> | * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_table-and-caption"> | ||||
* <code>fo:table-and-caption</code></a> property. | * <code>fo:table-and-caption</code></a> property. | ||||
* @asf.todo needs implementation | |||||
* TODO needs implementation | |||||
*/ | */ | ||||
public class TableAndCaption extends FObj /*implements BreakPropertySet*/ { | public class TableAndCaption extends FObj /*implements BreakPropertySet*/ { | ||||
// The value of properties relevant for fo:table-and-caption. | // The value of properties relevant for fo:table-and-caption. |
/** | /** | ||||
* {@inheritDoc} | * {@inheritDoc} | ||||
* @asf.todo see if addChildNode() should also be called for fo's other than | |||||
* TODO see if addChildNode() should also be called for fo's other than | |||||
* fo:flow. | * fo:flow. | ||||
*/ | */ | ||||
public void addChildNode(FONode child) throws FOPException { | public void addChildNode(FONode child) throws FOPException { |
/** | /** | ||||
* Superclass for properties that wrap a character value | * Superclass for properties that wrap a character value | ||||
* @asf.todo convert character value to int in order to denote unicode scalar value | |||||
* TODO convert character value to int in order to denote unicode scalar value | |||||
* instead of a single UTF-16 code element | * instead of a single UTF-16 code element | ||||
*/ | */ | ||||
public final class CharacterProperty extends Property { | public final class CharacterProperty extends Property { |
/** | /** | ||||
* Construct byte vector instance. | * Construct byte vector instance. | ||||
* @param a byte array to use | * @param a byte array to use | ||||
* @asf.todo should n should be initialized to a.length to be consistent with | |||||
* TODO should n should be initialized to a.length to be consistent with | |||||
* CharVector behavior? [GA] | * CharVector behavior? [GA] | ||||
*/ | */ | ||||
public ByteVector(byte[] a) { | public ByteVector(byte[] a) { | ||||
* Construct byte vector instance. | * Construct byte vector instance. | ||||
* @param a byte array to use | * @param a byte array to use | ||||
* @param capacity initial block size | * @param capacity initial block size | ||||
* @asf.todo should n should be initialized to a.length to be consistent with | |||||
* TODO should n should be initialized to a.length to be consistent with | |||||
* CharVector behavior? [GA] | * CharVector behavior? [GA] | ||||
*/ | */ | ||||
public ByteVector(byte[] a, int capacity) { | public ByteVector(byte[] a, int capacity) { |
/** | /** | ||||
* An hyphenation exception. | * An hyphenation exception. | ||||
* @author Carlos Villegas <cav@uniscope.co.jp> | * @author Carlos Villegas <cav@uniscope.co.jp> | ||||
* @asf.todo Derive from FOPException | |||||
* TODO Derive from FOPException | |||||
*/ | */ | ||||
public class HyphenationException extends Exception { | public class HyphenationException extends Exception { | ||||
* Its parent LM is the PageSequenceLayoutManager. | * Its parent LM is the PageSequenceLayoutManager. | ||||
* This LM is responsible for getting columns of the appropriate size | * This LM is responsible for getting columns of the appropriate size | ||||
* and filling them with block-level areas generated by its children. | * and filling them with block-level areas generated by its children. | ||||
* @asf.todo Reintroduce emergency counter (generate error to avoid endless loop) | |||||
* TODO Reintroduce emergency counter (generate error to avoid endless loop) | |||||
*/ | */ | ||||
public class FlowLayoutManager extends BlockStackingLayoutManager | public class FlowLayoutManager extends BlockStackingLayoutManager | ||||
implements BlockLevelLayoutManager { | implements BlockLevelLayoutManager { |
* Exception thrown by FOP if an unrecoverable layout error occurs. An example: An area overflows | * Exception thrown by FOP if an unrecoverable layout error occurs. An example: An area overflows | ||||
* a viewport that has overflow="error-if-overflow". | * a viewport that has overflow="error-if-overflow". | ||||
* | * | ||||
* @asf.todo Discuss if this should become a checked exception. | |||||
* TODO Discuss if this should become a checked exception. | |||||
*/ | */ | ||||
public class LayoutException extends RuntimeException { | public class LayoutException extends RuntimeException { | ||||
* an exception to this rule.) | * an exception to this rule.) | ||||
* This class can be extended to handle the creation and adding of the | * This class can be extended to handle the creation and adding of the | ||||
* inline area. | * inline area. | ||||
* @asf.todo [GA] replace use of hungarian notation with normalized java naming | |||||
* TODO [GA] replace use of hungarian notation with normalized java naming | |||||
*/ | */ | ||||
public abstract class LeafNodeLayoutManager extends AbstractLayoutManager | public abstract class LeafNodeLayoutManager extends AbstractLayoutManager | ||||
implements InlineLevelLayoutManager { | implements InlineLevelLayoutManager { |
* Constructor | * Constructor | ||||
* | * | ||||
* @param node the formatting object that creates this area | * @param node the formatting object that creates this area | ||||
* @asf.todo better retrieval of font info | |||||
* TODO better retrieval of font info | |||||
*/ | */ | ||||
public PageNumberCitationLastLayoutManager(PageNumberCitationLast node) { | public PageNumberCitationLastLayoutManager(PageNumberCitationLast node) { | ||||
super(node); | super(node); |
* Constructor | * Constructor | ||||
* | * | ||||
* @param node the formatting object that creates this area | * @param node the formatting object that creates this area | ||||
* @asf.todo better retrieval of font info | |||||
* TODO better retrieval of font info | |||||
*/ | */ | ||||
public PageNumberCitationLayoutManager(PageNumberCitation node) { | public PageNumberCitationLayoutManager(PageNumberCitation node) { | ||||
super(node); | super(node); |
* The caption contains blocks that are positioned next to the | * The caption contains blocks that are positioned next to the | ||||
* table on the caption side. | * table on the caption side. | ||||
* The caption blocks have an implicit keep with the table. | * The caption blocks have an implicit keep with the table. | ||||
* @asf.todo Implement getNextKnuthElements() | |||||
* TODO Implement getNextKnuthElements() | |||||
*/ | */ | ||||
public class TableAndCaptionLayoutManager extends BlockStackingLayoutManager { | public class TableAndCaptionLayoutManager extends BlockStackingLayoutManager { | ||||
* LayoutManager for a table-caption FO. | * LayoutManager for a table-caption FO. | ||||
* The table caption contains blocks that are placed beside the | * The table caption contains blocks that are placed beside the | ||||
* table. | * table. | ||||
* @asf.todo Implement getNextKnuthElements() | |||||
* TODO Implement getNextKnuthElements() | |||||
*/ | */ | ||||
public class TableCaptionLayoutManager extends BlockStackingLayoutManager { | public class TableCaptionLayoutManager extends BlockStackingLayoutManager { | ||||