vmote       2003/07/01 09:36:04

  Modified:    src/java/org/apache/fop/rtf/rtflib/rtfdoc
                        IRtfAfterContainer.java IRtfBeforeContainer.java
                        IRtfBookmarkContainer.java
                        IRtfExternalGraphicContainer.java
                        IRtfHyperLinkContainer.java
                        IRtfJforCmdContainer.java IRtfListContainer.java
                        IRtfPageBreakContainer.java IRtfPageContainer.java
                        IRtfPageNumberCitationContainer.java
                        IRtfPageNumberContainer.java
                        IRtfParagraphContainer.java
                        IRtfParagraphKeepTogetherContainer.java
                        IRtfTableContainer.java IRtfTextContainer.java
                        ITableAttributes.java IrtfTemplateContainer.java
  Log:
  Cleanup style issues, mostly javadoc comments.
  
  Revision  Changes    Path
  1.4       +7 -1      
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfAfterContainer.java
  
  Index: IRtfAfterContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfAfterContainer.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- IRtfAfterContainer.java   30 Jun 2003 01:31:14 -0000      1.3
  +++ IRtfAfterContainer.java   1 Jul 2003 16:36:02 -0000       1.4
  @@ -62,5 +62,11 @@
   
   /** interface for RTF objects that can contain footers */
   public interface IRtfAfterContainer {
  +    /**
  +     *
  +     * @param attrs Attributes for new footer
  +     * @return RtfAfter for footer
  +     * @throws IOException for I/O problems
  +     */
       RtfAfter newAfter(RtfAttributes attrs) throws IOException;
   }
  
  
  
  1.4       +11 -1     
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfBeforeContainer.java
  
  Index: IRtfBeforeContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfBeforeContainer.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- IRtfBeforeContainer.java  30 Jun 2003 01:31:14 -0000      1.3
  +++ IRtfBeforeContainer.java  1 Jul 2003 16:36:03 -0000       1.4
  @@ -60,6 +60,16 @@
   
   import java.io.IOException;
   
  +/**
  + * Interface for classes containing headers.
  + */
   public interface IRtfBeforeContainer {
  +
  +    /**
  +     *
  +     * @param attrs Attributes of new header
  +     * @return RtfBefore for new header object
  +     * @throws IOException for I/O problems
  +     */
       RtfBefore newBefore(RtfAttributes attrs) throws IOException;
   }
  
  
  
  1.5       +2 -5      
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfBookmarkContainer.java
  
  Index: IRtfBookmarkContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfBookmarkContainer.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- IRtfBookmarkContainer.java        30 Jun 2003 01:31:15 -0000      1.4
  +++ IRtfBookmarkContainer.java        1 Jul 2003 16:36:03 -0000       1.5
  @@ -68,12 +68,9 @@
   
       /**
        * Create a new RTF bookmark.
  -     *
        * @param bookmark Name of the bookmark
  -     *
        * @return RTF bookmark
  -     *
  -     * @throws IOException On eror
  +     * @throws IOException for I/O problems
        */
       RtfBookmark newBookmark (String bookmark) throws IOException;
   }
  
  
  
  1.5       +5 -2      
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfExternalGraphicContainer.java
  
  Index: IRtfExternalGraphicContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfExternalGraphicContainer.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- IRtfExternalGraphicContainer.java 30 Jun 2003 01:31:15 -0000      1.4
  +++ IRtfExternalGraphicContainer.java 1 Jul 2003 16:36:03 -0000       1.5
  @@ -60,11 +60,14 @@
   
   import java.io.IOException;
   
  +/**
  + * Interface for classes containing images.
  + */
   public interface IRtfExternalGraphicContainer {
   
       /**
        * Creates a new image on external graphic base.
  -     *
  +     * @return RtfExternalGraphic for the new image
        * @exception IOException On error
        */
       RtfExternalGraphic newImage () throws IOException;
  
  
  
  1.5       +4 -2      
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfHyperLinkContainer.java
  
  Index: IRtfHyperLinkContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfHyperLinkContainer.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- IRtfHyperLinkContainer.java       30 Jun 2003 01:31:15 -0000      1.4
  +++ IRtfHyperLinkContainer.java       1 Jul 2003 16:36:03 -0000       1.5
  @@ -66,8 +66,10 @@
   public interface IRtfHyperLinkContainer extends IRtfTextContainer {
       /**
        * Creates a new hyperlink.
  -     *
  +     * @param str Hyperlink string
  +     * @param attr Hyperlink attributes
        * @exception IOException on error
  +     * @return new Hyperlink object
        */
       RtfHyperLink newHyperLink (String str, RtfAttributes attr) throws IOException;
   }
  
  
  
  1.5       +10 -1     
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfJforCmdContainer.java
  
  Index: IRtfJforCmdContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfJforCmdContainer.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- IRtfJforCmdContainer.java 30 Jun 2003 01:31:15 -0000      1.4
  +++ IRtfJforCmdContainer.java 1 Jul 2003 16:36:03 -0000       1.5
  @@ -61,6 +61,15 @@
   
   import java.io.IOException;
   
  +/**
  + * Interface for objects containing Commands
  + */
   public interface IRtfJforCmdContainer {
  +    /**
  +     *
  +     * @param attr Attributes for the command
  +     * @return new Command object
  +     * @throws IOException for I/O problems
  +     */
       RtfJforCmd newJforCmd(RtfAttributes attr) throws IOException;
   }
  
  
  
  1.4       +6 -2      
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfListContainer.java
  
  Index: IRtfListContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfListContainer.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- IRtfListContainer.java    30 Jun 2003 01:31:15 -0000      1.3
  +++ IRtfListContainer.java    1 Jul 2003 16:36:03 -0000       1.4
  @@ -65,6 +65,10 @@
    */
   
   public interface IRtfListContainer {
  -    /** close current list if any and start a new one */
  +    /** Close the current list, if any, and starts a new one
  +     * @param attrs attributes of new List
  +     * @return new List object
  +     * @throws IOException for I/O problems
  +     */
       RtfList newList(RtfAttributes attrs) throws IOException;
   }
  
  
  
  1.4       +4 -2      
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfPageBreakContainer.java
  
  Index: IRtfPageBreakContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfPageBreakContainer.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- IRtfPageBreakContainer.java       30 Jun 2003 01:31:15 -0000      1.3
  +++ IRtfPageBreakContainer.java       1 Jul 2003 16:36:03 -0000       1.4
  @@ -65,6 +65,8 @@
    */
   
   public interface IRtfPageBreakContainer {
  -    /** add a page break */
  +    /** add a page break
  +     * @throws IOException for I/O problems
  +     */
       void newPageBreak() throws IOException;
   }
  
  
  
  1.4       +4 -2      
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfPageContainer.java
  
  Index: IRtfPageContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfPageContainer.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- IRtfPageContainer.java    30 Jun 2003 01:31:15 -0000      1.3
  +++ IRtfPageContainer.java    1 Jul 2003 16:36:03 -0000       1.4
  @@ -66,7 +66,9 @@
   
   public interface IRtfPageContainer {
       /** close current text run if any and start a new one with specified attributes
  -     *  @param str if not null, added to the RtfText created
  +     * @param attrs attributes for the new Page
  +     * @return new Page object
  +     * @throws IOException for I/O problems.
        */
       RtfPage newPage(RtfAttributes attrs) throws IOException;
   }
  
  
  
  1.4       +10 -1     
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfPageNumberCitationContainer.java
  
  Index: IRtfPageNumberCitationContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfPageNumberCitationContainer.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- IRtfPageNumberCitationContainer.java      30 Jun 2003 17:45:32 -0000      1.3
  +++ IRtfPageNumberCitationContainer.java      1 Jul 2003 16:36:03 -0000       1.4
  @@ -60,6 +60,15 @@
   
   import java.io.IOException;
   
  +/**
  + * Interface for classes containing page number citations
  + */
   public interface IRtfPageNumberCitationContainer {
  +    /**
  +     *
  +     * @param id String identifying new page number citation
  +     * @return RtfPageNumberCitation new page number citation object
  +     * @throws IOException for I/O problems
  +     */
       RtfPageNumberCitation newPageNumberCitation(String id) throws IOException;
   }
  
  
  
  1.4       +10 -1     
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfPageNumberContainer.java
  
  Index: IRtfPageNumberContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfPageNumberContainer.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- IRtfPageNumberContainer.java      30 Jun 2003 17:45:32 -0000      1.3
  +++ IRtfPageNumberContainer.java      1 Jul 2003 16:36:03 -0000       1.4
  @@ -60,6 +60,15 @@
   
   import java.io.IOException;
   
  +/**
  + * Interface for objects containing page numbers
  + */
   public interface IRtfPageNumberContainer {
  +
  +    /**
  +     *
  +     * @return new RtfPageNumber
  +     * @throws IOException for I/O problems.
  +     */
       RtfPageNumber newPageNumber() throws IOException;
   }
  
  
  
  1.4       +14 -3     
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfParagraphContainer.java
  
  Index: IRtfParagraphContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfParagraphContainer.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- IRtfParagraphContainer.java       30 Jun 2003 17:45:32 -0000      1.3
  +++ IRtfParagraphContainer.java       1 Jul 2003 16:36:03 -0000       1.4
  @@ -65,10 +65,21 @@
    */
   
   public interface IRtfParagraphContainer {
  -    /** close current paragraph if any and start a new one with default attributes 
*/
  +    /**
  +     * Close current paragraph, if any, and start a new one with default
  +     * attributes.
  +     * @throws IOException for I/O problems.
  +     * @return new paragraph object
  +     */
       RtfParagraph newParagraph() throws IOException;
   
  -    /** close current paragraph if any and start a new one with specified 
attributes */
  +    /**
  +     * Close current paragraph, if any, and start a new one with specified
  +     * attributes
  +     * @param attr attributes for new paragraph
  +     * @return new paragraph object
  +     * @throws IOException for I/O problems.
  +     */
       RtfParagraph newParagraph(RtfAttributes attr) throws IOException;
   
   }
  
  
  
  1.4       +9 -2      
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfParagraphKeepTogetherContainer.java
  
  Index: IRtfParagraphKeepTogetherContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfParagraphKeepTogetherContainer.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- IRtfParagraphKeepTogetherContainer.java   30 Jun 2003 17:45:32 -0000      1.3
  +++ IRtfParagraphKeepTogetherContainer.java   1 Jul 2003 16:36:03 -0000       1.4
  @@ -60,8 +60,15 @@
   
   import java.io.IOException;
   
  +/**
  + * Interface for classes containing Paragraphs with Keep Together
  + */
   public interface IRtfParagraphKeepTogetherContainer {
   
  -    /** close current paragraph if any and start a new one */
  +    /**
  +     * Close current paragraph, if any, and start a new one
  +     * @return new paragraph object (with keep together)
  +     * @throws IOException for I/O problems
  +     */
       RtfParagraphKeepTogether newParagraphKeepTogether() throws IOException;
   }
  
  
  
  1.7       +17 -8     
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfTableContainer.java
  
  Index: IRtfTableContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfTableContainer.java,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- IRtfTableContainer.java   30 Jun 2003 17:45:32 -0000      1.6
  +++ IRtfTableContainer.java   1 Jul 2003 16:36:03 -0000       1.7
  @@ -61,17 +61,26 @@
   import java.io.IOException;
   import org.apache.fop.rtf.rtflib.interfaces.ITableColumnsInfo;
   
  -/**  Interface for RtfElements that can contain RtfTables
  +/**
  + *  Interface for RtfElements that can contain RtfTables
    *  @author Bertrand Delacretaz [EMAIL PROTECTED]
  + *  @author Boris Poudérous
    */
  -
   public interface IRtfTableContainer {
  -    /** close current table if any and start a new one */
  +   /**
  +    * Close current table, if any, and start a new one
  +    * @param tc Table Columns Info
  +    * @return new table object
  +    * @throws IOException for I/O problems
  +    */
       RtfTable newTable(ITableColumnsInfo tc) throws IOException;
   
  -    /** close current table if any and start a new one
  -   *  @param tc added by Boris Poudérous on july 2002 in order to process
  -   *  number-columns-spanned attribute
  -   **/
  +   /**
  +    * Close current table, if any, and start a new one
  +    * @param attrs for the Table attributes
  +    * @param tc to process number-columns-spanned attribute
  +    * @return new table object
  +    * @throws IOException for I/O problems
  +    */
       RtfTable newTable(RtfAttributes attrs, ITableColumnsInfo tc) throws IOException;
   }
  
  
  
  1.4       +19 -8     
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfTextContainer.java
  
  Index: IRtfTextContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IRtfTextContainer.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- IRtfTextContainer.java    30 Jun 2003 17:45:32 -0000      1.3
  +++ IRtfTextContainer.java    1 Jul 2003 16:36:03 -0000       1.4
  @@ -65,21 +65,32 @@
    */
   
   public interface IRtfTextContainer {
  -    /** close current text run if any and start a new one with specified attributes
  -     *  @param str if not null, added to the RtfText created
  +    /**
  +     * Close current text element, if any, and start a new one
  +     * @param str if not null, added to the RtfText created
  +     * @param attr attributes for text
  +     * @return new text object
  +     * @throws IOException for I/O problems
        */
       RtfText newText(String str, RtfAttributes attr) throws IOException;
   
  -    /** close current text run if any and start a new one with default attributes
  -     *  @param str if not null, added to the RtfText created
  +    /**
  +     * Close current text run, if any, and start a new one with default attributes
  +     * @param str if not null, added to the RtfText created
  +     * @return a new text object
  +     * @throws IOException for I/O problems
        */
       RtfText newText(String str) throws IOException;
   
  -    /** add a line break */
  +    /**
  +     * Add a line break
  +     * @throws IOException for I/O problems
  +     */
       void newLineBreak() throws IOException;
   
  -    /** text containers usually provide default attributes for all texts that they 
contain.
  -     *  This returns a copy of the container's attributes
  +    /**
  +     * Text containers usually provide default attributes for all texts that they 
contain.
  +     * @return a copy of the container's attributes.
        */
       RtfAttributes getTextContainerAttributes();
   }
  
  
  
  1.4       +128 -76   
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/ITableAttributes.java
  
  Index: ITableAttributes.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/ITableAttributes.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- ITableAttributes.java     30 Jun 2003 00:20:07 -0000      1.3
  +++ ITableAttributes.java     1 Jul 2003 16:36:03 -0000       1.4
  @@ -58,33 +58,47 @@
   
   package org.apache.fop.rtf.rtflib.rtfdoc;
   
  -/** Constants for RTF table attribute names */
  +/**
  + * Constants for RTF table attribute names
  + * @author unascribed
  + * @author Boris POUDEROUS
  + * @author Chris Scott, Westinghouse
  + */
   public interface ITableAttributes {
  -    /**
  -     * Added by Boris POUDEROUS on 2002/06/27 in order to
  -     * process column/row spanning :
  -     */
  +    /** to process column spanning */
       public static final String COLUMN_SPAN = "number-columns-spanned";
  +    /** to process row spanning */
       public static final String ROW_SPAN = "number-rows-spanned";
   
  -    // RTF 1.5 attributes (word 97)
  -    // half the space between the cells of a table row in twips
  -    String ATTR_RTF_15_TRGAPH = "trgaph";
  -
  -    // RTF 1.6 Row and table attributes
  -    String ATTR_ROW_PADDING_TOP = "trpaddt";
  -    String ATTR_ROW_PADDING_BOTTOM = "trpaddb";
  -    String ATTR_ROW_PADDING_LEFT = "trpaddl";
  -    String ATTR_ROW_PADDING_RIGHT = "trpaddr";
  -
  -    String ATTR_ROW_U_PADDING_TOP = "trpaddft";
  -    String ATTR_ROW_U_PADDING_BOTTOM = "trpaddfb";
  -    String ATTR_ROW_U_PADDING_LEFT = "trpaddfl";
  -    String ATTR_ROW_U_PADDING_RIGHT = "trpaddfr";
  -
  -    // list of ALL ROW PADDING attributes, used to select them
  -    // when writing attributes
  -    String[] ATTRIB_ROW_PADDING = {
  +// RTF 1.5 attributes (word 97)
  +
  +    /** half the space between the cells of a table row in twips */
  +    public static final String ATTR_RTF_15_TRGAPH = "trgaph";
  +
  +// RTF 1.6 Row and table attributes
  +    /** table row padding, top */
  +    public static final String ATTR_ROW_PADDING_TOP = "trpaddt";
  +    /** table row padding, bottom */
  +    public static final String ATTR_ROW_PADDING_BOTTOM = "trpaddb";
  +    /** table row padding, left */
  +    public static final String ATTR_ROW_PADDING_LEFT = "trpaddl";
  +    /** table row padding, right */
  +    public static final String ATTR_ROW_PADDING_RIGHT = "trpaddr";
  +
  +    /** table row padding, top */
  +    public static final String ATTR_ROW_U_PADDING_TOP = "trpaddft";
  +    /** table row padding, bottom */
  +    public static final String ATTR_ROW_U_PADDING_BOTTOM = "trpaddfb";
  +    /** table row padding, left */
  +    public static final String ATTR_ROW_U_PADDING_LEFT = "trpaddfl";
  +    /** table row padding, right */
  +    public static final String ATTR_ROW_U_PADDING_RIGHT = "trpaddfr";
  +
  +    /**
  +     * List of ALL ROW PADDING attributes, used to select them when writing
  +     * attributes
  +     */
  +    public static final String[] ATTRIB_ROW_PADDING = {
           ATTR_ROW_PADDING_TOP, ATTR_ROW_U_PADDING_TOP,
           ATTR_ROW_PADDING_BOTTOM, ATTR_ROW_U_PADDING_BOTTOM,
           ATTR_ROW_PADDING_LEFT, ATTR_ROW_U_PADDING_LEFT,
  @@ -92,68 +106,106 @@
           ATTR_RTF_15_TRGAPH
       };
   
  -    // Cell attributes
  -    String ATTR_CELL_PADDING_TOP = "clpadt";
  -    String ATTR_CELL_PADDING_BOTTOM = "clpadb";
  -    String ATTR_CELL_PADDING_LEFT = "clpadl";
  -    String ATTR_CELL_PADDING_RIGHT = "clpadr";
  -
  -    String ATTR_CELL_U_PADDING_TOP = "clpadft";
  -    String ATTR_CELL_U_PADDING_BOTTOM = "clpadfb";
  -    String ATTR_CELL_U_PADDING_LEFT = "clpadfl";
  -    String ATTR_CELL_U_PADDING_RIGHT = "clpadfr";
  -
  -    // These lines added by Chris Scott, Westinghouse
  -    // need to make a border style file
  -
  -    String CELL_BORDER_TOP = "clbrdrt";
  -    String CELL_BORDER_BOTTOM = "clbrdrb";
  -    String CELL_BORDER_LEFT = "clbrdrl";
  -    String CELL_BORDER_RIGHT = "clbrdrr";
  -    //Table row border attributes
  -    String ROW_BORDER_TOP = "trbrdrt";
  -    String ROW_BORDER_BOTTOM = "trbrdrb";
  -    String ROW_BORDER_LEFT = "trbrdrl";
  -    String ROW_BORDER_RIGHT = "trbrdrr";
  -    String ROW_BORDER_HORIZONTAL = "trbrdrh";
  -    String ROW_BORDER_VERTICAL = "trbrdrv";
  -
  -    //Table row attributes
  -    String ROW_KEEP_TOGETHER = "trkeep";
  -
  -    //This control word is nonexistent in RTF, used
  -    //to simulate the FO:keep-with-next attribute.
  -     String ROW_KEEP_WITH_NEXT = "knext";
  -
  -    //This control word is nonexistent in RTF, used
  -    //to simulate the FO:keep-with-previous attribute.
  -      String ROW_KEEP_WITH_PREVIOUS = "kprevious";
  -
  -    //shading and color, all are unit based attributes
  -    String CELL_SHADE = "clshdng";
  -    String CELL_COLOR_BACKGROUND = "clcbpat";
  -    String CELL_COLOR_FOREGROUND = "clcfpat";
  -
  -    // list of ALL CELL PADDING attributes, used to select them
  -    // when writing attributes
  -    String[] ATTRIB_CELL_PADDING = {
  +// Cell attributes
  +    /** cell padding, top */
  +    public static final String ATTR_CELL_PADDING_TOP = "clpadt";
  +    /** cell padding, bottom */
  +    public static final String ATTR_CELL_PADDING_BOTTOM = "clpadb";
  +    /** cell padding, left */
  +    public static final String ATTR_CELL_PADDING_LEFT = "clpadl";
  +    /** cell padding, right */
  +    public static final String ATTR_CELL_PADDING_RIGHT = "clpadr";
  +
  +    /** cell padding, top */
  +    public static final String ATTR_CELL_U_PADDING_TOP = "clpadft";
  +    /** cell padding, bottom */
  +    public static final String ATTR_CELL_U_PADDING_BOTTOM = "clpadfb";
  +    /** cell padding, left */
  +    public static final String ATTR_CELL_U_PADDING_LEFT = "clpadfl";
  +    /** cell padding, right */
  +    public static final String ATTR_CELL_U_PADDING_RIGHT = "clpadfr";
  +
  +// for border style file
  +    /** cell border, top */
  +    public static final String CELL_BORDER_TOP = "clbrdrt";
  +    /** cell border, bottom */
  +    public static final String CELL_BORDER_BOTTOM = "clbrdrb";
  +    /** cell border, left */
  +    public static final String CELL_BORDER_LEFT = "clbrdrl";
  +    /** cell border, right */
  +    public static final String CELL_BORDER_RIGHT = "clbrdrr";
  +
  +//Table row border attributes
  +    /** row border, top */
  +    public static final String ROW_BORDER_TOP = "trbrdrt";
  +    /** row border, bottom */
  +    public static final String ROW_BORDER_BOTTOM = "trbrdrb";
  +    /** row border, left */
  +    public static final String ROW_BORDER_LEFT = "trbrdrl";
  +    /** row border, right */
  +    public static final String ROW_BORDER_RIGHT = "trbrdrr";
  +    /** row border, horizontal */
  +    public static final String ROW_BORDER_HORIZONTAL = "trbrdrh";
  +    /** row border, vertical */
  +    public static final String ROW_BORDER_VERTICAL = "trbrdrv";
  +
  +//Table row attributes
  +    /** row attribute, keep-together */
  +    public static final String ROW_KEEP_TOGETHER = "trkeep";
  +
  +    /**
  +     * This control word is nonexistent in RTF, used to simulate the
  +     * FO:keep-with-next attribute.
  +     */
  +    public static final String ROW_KEEP_WITH_NEXT = "knext";
  +
  +    /**
  +     * This control word is nonexistent in RTF, used to simulate the
  +     * FO:keep-with-previous attribute.
  +     */
  +    public static final String ROW_KEEP_WITH_PREVIOUS = "kprevious";
  +
  +    /** cell shading, a unit-based attribute */
  +    public static final String CELL_SHADE = "clshdng";
  +    /** cell background color, a unit-based attribute */
  +    public static final String CELL_COLOR_BACKGROUND = "clcbpat";
  +    /** cell foreground color, a unit-based attribute */
  +    public static final String CELL_COLOR_FOREGROUND = "clcfpat";
  +
  +    /**
  +     * List of ALL CELL PADDING attributes, used to select them when writing
  +     * attributes
  +     */
  +    public static final String[] ATTRIB_CELL_PADDING = {
           ATTR_CELL_PADDING_TOP, ATTR_CELL_U_PADDING_TOP,
           ATTR_CELL_PADDING_BOTTOM, ATTR_CELL_U_PADDING_BOTTOM,
           ATTR_CELL_PADDING_LEFT, ATTR_CELL_U_PADDING_LEFT,
           ATTR_CELL_PADDING_RIGHT, ATTR_CELL_U_PADDING_RIGHT,
       };
   
  -    String[] CELL_BORDER = {
  -        CELL_BORDER_TOP,        CELL_BORDER_BOTTOM,
  -        CELL_BORDER_LEFT,        CELL_BORDER_RIGHT
  +    /**
  +     * List of ALL CELL BORDER attributes, used to select them when writing
  +     * attributes
  +     */
  +    public static final String[] CELL_BORDER = {
  +        CELL_BORDER_TOP,    CELL_BORDER_BOTTOM,
  +        CELL_BORDER_LEFT,   CELL_BORDER_RIGHT
       };
   
  -    String[] ROW_BORDER = {
  -        ROW_BORDER_TOP,         ROW_BORDER_BOTTOM,         ROW_BORDER_LEFT,
  -        ROW_BORDER_RIGHT,    ROW_BORDER_HORIZONTAL,    ROW_BORDER_VERTICAL
  +    /**
  +     * List of ALL ROW BORDER attributes, used to select them when writing
  +     * attributes
  +     */
  +    public static final String[] ROW_BORDER = {
  +        ROW_BORDER_TOP,     ROW_BORDER_BOTTOM,        ROW_BORDER_LEFT,
  +        ROW_BORDER_RIGHT,   ROW_BORDER_HORIZONTAL,    ROW_BORDER_VERTICAL
       };
   
  -    String[] CELL_COLOR = {
  +    /**
  +     * List of ALL CELL SHADING AND COLOR attributes, used to select them when
  +     * writing attributes
  +     */
  +    public static final String[] CELL_COLOR = {
           CELL_SHADE,    CELL_COLOR_BACKGROUND,    CELL_COLOR_FOREGROUND
       };
   }
  
  
  
  1.5       +7 -3      
xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IrtfTemplateContainer.java
  
  Index: IrtfTemplateContainer.java
  ===================================================================
  RCS file: 
/home/cvs/xml-fop/src/java/org/apache/fop/rtf/rtflib/rtfdoc/IrtfTemplateContainer.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- IrtfTemplateContainer.java        30 Jun 2003 17:45:32 -0000      1.4
  +++ IrtfTemplateContainer.java        1 Jul 2003 16:36:03 -0000       1.5
  @@ -60,12 +60,16 @@
   
   import java.io.IOException;
   
  -
  +/**
  + * Interface for classes containing templates.
  + */
   public interface IrtfTemplateContainer {
   
       /**
        * Creates a new Template.
  -     *
  +     * @param str description of Template
  +     * @param attr attributes of Template
  +     * @return new Template object
        * @exception IOException on error
        */
       RtfTemplate newTemplate (String str, RtfAttributes attr) throws IOException;
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to