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 ph...@apache.org on 2006/02/12 20:19:06 UTC
svn commit: r377219 - in
/xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc:
RtfListStyle.java RtfListStyleBullet.java RtfListStyleNumber.java
RtfListStyleText.java
Author: pherweg
Date: Sun Feb 12 11:19:03 2006
New Revision: 377219
URL: http://svn.apache.org/viewcvs?rev=377219&view=rev
Log:
RTF: fix a few checkstyle warnings
Modified:
xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyle.java
xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java
xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java
xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyle.java
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyle.java?rev=377219&r1=377218&r2=377219&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyle.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyle.java Sun Feb 12 11:19:03 2006
@@ -16,6 +16,7 @@
/* $Id$ */
+package org.apache.fop.render.rtf.rtflib.rtfdoc;
/*
* This file is part of the RTF library of the FOP project, which was originally
@@ -23,7 +24,6 @@
* contributors to the jfor project (www.jfor.org), who agreed to donate jfor to
* the FOP project.
*/
-package org.apache.fop.render.rtf.rtflib.rtfdoc;
//Java
import java.io.IOException;
@@ -37,33 +37,51 @@
public class RtfListStyle {
private RtfListItem rtfListItem;
+ /**
+ * Sets the RtfListItem this style belongs to.
+ * @param item RtfListItem this style belongs to
+ */
public void setRtfListItem(RtfListItem item) {
rtfListItem = item;
}
+ /**
+ * Gets the RtfListItem this style belongs to.
+ * @return RtfListItem this style belongs to
+ */
public RtfListItem getRtfListItem() {
return rtfListItem;
}
+ /**
+ * Gets the RtfList this style belongs to.
+ * @return RtfList this style belongs to
+ */
public RtfList getRtfList() {
return rtfListItem.getParentList();
}
/**
- * Gets call before a RtfListItem has to be written.
+ * Gets called before a RtfListItem has to be written.
+ * @param item RtfListItem this style belongs to
+ * @throws IOException Thrown when an IO-problem occurs.
*/
public void writeListPrefix(RtfListItem item)
throws IOException {
}
/**
- * Gets call before a paragraph, which is contained by a RtfListItem has to be written.
+ * Gets called before a paragraph has to be written, which is contained by a RtfListItem.
+ * @param element RtfElement in whose context is to be written
+ * @throws IOException Thrown when an IO-problem occurs.
*/
public void writeParagraphPrefix(RtfElement element)
throws IOException {
}
/**
- * Gets call when the list table has to be written.
+ * Gets called when the list table has to be written.
+ * @param element RtfElement in whose context is to be written
+ * @throws IOException Thrown when an IO-problem occurs.
*/
public void writeLevelGroup(RtfElement element)
throws IOException {
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java?rev=377219&r1=377218&r2=377219&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java Sun Feb 12 11:19:03 2006
@@ -16,6 +16,7 @@
/* $Id$ */
+package org.apache.fop.render.rtf.rtflib.rtfdoc;
/*
* This file is part of the RTF library of the FOP project, which was originally
@@ -23,7 +24,6 @@
* contributors to the jfor project (www.jfor.org), who agreed to donate jfor to
* the FOP project.
*/
-package org.apache.fop.render.rtf.rtflib.rtfdoc;
//Java
import java.io.IOException;
@@ -31,12 +31,16 @@
//FOP
import org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement;
+/**
+ * Class to handle bullet list style.
+ */
public class RtfListStyleBullet extends RtfListStyle {
/**
- * Gets call before a RtfListItem has to be written.
- *
+ * Gets called before a RtfListItem has to be written.
+ * @param item RtfListItem whose prefix has to be written
* @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeListPrefix(RtfListItem)
+ * @throws IOException Thrown when an IO-problem occurs
*/
public void writeListPrefix(RtfListItem item) throws IOException {
// bulleted list
@@ -55,9 +59,10 @@
}
/**
- * Gets call before a paragraph, which is contained by a RtfListItem has to be written.
- *
+ * Gets called before a paragraph, which is contained by a RtfListItem has to be written.
+ * @param element RtfElement in whose context is to be written
* @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeParagraphPrefix(RtfElement)
+ * @throws IOException Thrown when an IO-problem occurs
*/
public void writeParagraphPrefix(RtfElement element) throws IOException {
element.writeGroupMark(true);
@@ -66,9 +71,11 @@
}
/**
- * Gets call when the list table has to be written.
+ * Gets called when the list table has to be written.
*
+ * @param element RtfElement in whose context is to be written
* @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeLevelGroup(RtfElement)
+ * @throws IOException Thrown when an IO-problem occurs
*/
public void writeLevelGroup(RtfElement element) throws IOException {
element.attrib.set(RtfListTable.LIST_NUMBER_TYPE, 23);
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java?rev=377219&r1=377218&r2=377219&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java Sun Feb 12 11:19:03 2006
@@ -16,6 +16,7 @@
/* $Id$ */
+package org.apache.fop.render.rtf.rtflib.rtfdoc;
/*
* This file is part of the RTF library of the FOP project, which was originally
@@ -23,7 +24,6 @@
* contributors to the jfor project (www.jfor.org), who agreed to donate jfor to
* the FOP project.
*/
-package org.apache.fop.render.rtf.rtflib.rtfdoc;
//Java
import java.io.IOException;
@@ -31,12 +31,16 @@
//FOP
import org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement;
+/**
+ * Class to handle number list style.
+ */
public class RtfListStyleNumber extends RtfListStyle {
/**
- * Gets call before a RtfListItem has to be written.
- *
+ * Gets called before a RtfListItem has to be written.
+ * @param item RtfListItem whose prefix has to be written
* @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeListPrefix(RtfListItem)
+ * @throws IOException Thrown when an IO-problem occurs
*/
public void writeListPrefix(RtfListItem item)
throws IOException {
@@ -51,9 +55,11 @@
}
/**
- * Gets call before a paragraph, which is contained by a RtfListItem has to be written.
+ * Gets called before a paragraph, which is contained by a RtfListItem has to be written.
*
+ * @param element RtfElement in whose context is to be written
* @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeParagraphPrefix(RtfElement)
+ * @throws IOException Thrown when an IO-problem occurs
*/
public void writeParagraphPrefix(RtfElement element)
throws IOException {
@@ -66,9 +72,11 @@
}
/**
- * Gets call when the list table has to be written.
+ * Gets called when the list table has to be written.
*
+ * @param element RtfElement in whose context is to be written
* @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeLevelGroup(RtfElement)
+ * @throws IOException Thrown when an IO-problem occurs
*/
public void writeLevelGroup(RtfElement element)
throws IOException {
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java?rev=377219&r1=377218&r2=377219&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java Sun Feb 12 11:19:03 2006
@@ -16,6 +16,7 @@
/* $Id$ */
+package org.apache.fop.render.rtf.rtflib.rtfdoc;
/*
* This file is part of the RTF library of the FOP project, which was originally
@@ -23,7 +24,6 @@
* contributors to the jfor project (www.jfor.org), who agreed to donate jfor to
* the FOP project.
*/
-package org.apache.fop.render.rtf.rtflib.rtfdoc;
//Java
import java.io.IOException;
@@ -31,17 +31,25 @@
//FOP
import org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement;
+/**
+ * Class to handle text list style.
+ */
public class RtfListStyleText extends RtfListStyle {
private String text;
+ /**
+ * Constructs a RtfListStyleText object.
+ * @param s Text to be displayed
+ */
public RtfListStyleText(String s) {
text = s;
}
/**
- * Gets call before a RtfListItem has to be written.
- *
+ * Gets called before a RtfListItem has to be written.
+ * @param item RtfListItem whose prefix has to be written
* @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeListPrefix(RtfListItem)
+ * @throws IOException Thrown when an IO-problem occurs
*/
public void writeListPrefix(RtfListItem item)
throws IOException {
@@ -53,16 +61,18 @@
item.getParentList().attrib.getValue(RtfListTable.LIST_INDENT));
item.writeControlWord("pnf1");
item.writeGroupMark(true);
- item.writeControlWord("pndec");
+ //item.writeControlWord("pndec");
item.writeOneAttribute(RtfListTable.LIST_FONT_TYPE, "2");
item.writeControlWord("pntxtb " + text);
item.writeGroupMark(false);
}
/**
- * Gets call before a paragraph, which is contained by a RtfListItem has to be written.
+ * Gets called before a paragraph, which is contained by a RtfListItem has to be written.
*
+ * @param element RtfElement in whose context is to be written
* @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeParagraphPrefix(RtfElement)
+ * @throws IOException Thrown when an IO-problem occurs
*/
public void writeParagraphPrefix(RtfElement element)
throws IOException {
@@ -72,9 +82,11 @@
}
/**
- * Gets call when the list table has to be written.
+ * Gets called when the list table has to be written.
*
+ * @param element RtfElement in whose context is to be written
* @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeLevelGroup(RtfElement)
+ * @throws IOException Thrown when an IO-problem occurs
*/
public void writeLevelGroup(RtfElement element)
throws IOException {
---------------------------------------------------------------------
To unsubscribe, e-mail: fop-commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: fop-commits-help@xmlgraphics.apache.org