From d58773be311e3c66a01d057b7430cf0381933c4e Mon Sep 17 00:00:00 2001 From: Peter Herweg Date: Sun, 12 Feb 2006 19:19:03 +0000 Subject: [PATCH] RTF: fix a few checkstyle warnings git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@377219 13f79535-47bb-0310-9956-ffa450edef68 --- .../rtf/rtflib/rtfdoc/RtfListStyle.java | 26 ++++++++++++++++--- .../rtf/rtflib/rtfdoc/RtfListStyleBullet.java | 19 +++++++++----- .../rtf/rtflib/rtfdoc/RtfListStyleNumber.java | 18 +++++++++---- .../rtf/rtflib/rtfdoc/RtfListStyleText.java | 24 ++++++++++++----- 4 files changed, 66 insertions(+), 21 deletions(-) diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyle.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyle.java index c6809c46e..a4e85f684 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyle.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyle.java @@ -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 @@ import org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java index e7f7b7204..02a79e841 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java @@ -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 @@ import java.io.IOException; //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 @@ public class RtfListStyleBullet extends RtfListStyle { } /** - * 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 @@ public class RtfListStyleBullet extends RtfListStyle { } /** - * 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); diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java index 899f1ce3e..7d08ae85f 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java @@ -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 @@ import java.io.IOException; //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 @@ public class RtfListStyleNumber extends RtfListStyle { } /** - * 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 @@ public class RtfListStyleNumber extends RtfListStyle { } /** - * 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java index d11d69ba6..e81115b6f 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java @@ -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 @@ import java.io.IOException; //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 @@ public class RtfListStyleText extends RtfListStyle { 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 @@ public class RtfListStyleText extends RtfListStyle { } /** - * 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 { -- 2.39.5