bella 01/07/04 23:21:04
Modified: sources/org/apache/batik/gvt/font Kern.java
KerningTable.java GVTLineMetrics.java
AltGlyphHandler.java
Log:
improved javadoc
Revision Changes Path
1.2 +7 -5 xml-batik/sources/org/apache/batik/gvt/font/Kern.java
Index: Kern.java
===================================================================
RCS file: /home/cvs/xml-batik/sources/org/apache/batik/gvt/font/Kern.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Kern.java 2001/06/12 23:49:42 1.1
+++ Kern.java 2001/07/05 06:21:04 1.2
@@ -14,7 +14,7 @@
* by side. It may be used for either horizontal or vertical kerning.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Dean Jackson</a>
- * @version $Id: Kern.java,v 1.1 2001/06/12 23:49:42 bella Exp $
+ * @version $Id: Kern.java,v 1.2 2001/07/05 06:21:04 bella Exp $
*/
public class Kern {
@@ -55,7 +55,7 @@
/**
* Returns true if the specified glyph is one of the glyphs considered
- * as first by this kerning pair. Returns false otherwise.
+ * as first by this kerning entry. Returns false otherwise.
*
* @param glyphCode The id of the glyph to test.
* @param glyphUnicode The unicode value of the glyph to test.
@@ -77,7 +77,7 @@
/**
* Returns true if the specified glyph is one of the glyphs considered
- * as second by this kerning pair. Returns false otherwise.
+ * as second by this kerning entry. Returns false otherwise.
*
* @param glyphCode The id of the glyph to test.
* @param glyphUnicode The unicode value of the glyph to test.
@@ -99,8 +99,10 @@
}
/**
- * Give the kerning adjustment value for this entry (positive
- * value means the space between characters should decrease)
+ * Returns the kerning adjustment value for this kerning entry (a positive
+ * value means the space between characters should decrease).
+ *
+ * @return The kerning adjustment for this kerning entry.
*/
public float getAdjustValue() {
return kerningAdjust;
1.2 +3 -3 xml-batik/sources/org/apache/batik/gvt/font/KerningTable.java
Index: KerningTable.java
===================================================================
RCS file: /home/cvs/xml-batik/sources/org/apache/batik/gvt/font/KerningTable.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- KerningTable.java 2001/06/12 23:49:42 1.1
+++ KerningTable.java 2001/07/05 06:21:04 1.2
@@ -15,7 +15,7 @@
* kerning values when laying out glyphs.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Dean Jackson</a>
- * @version $Id: KerningTable.java,v 1.1 2001/06/12 23:49:42 bella Exp $
+ * @version $Id: KerningTable.java,v 1.2 2001/07/05 06:21:04 bella Exp $
*/
public class KerningTable {
@@ -24,8 +24,8 @@
/**
* Creates a KerningTable from an array of Kern entries.
*
- * @param entries The array of Kern elements that represent the kerning
- * entries for the font that this kerning table is associated with.
+ * @param entries The array of Kern objects that represent the kerning
+ * entries for the font that this kerning table belongs to.
*/
public KerningTable(Kern[] entries) {
1.3 +25 -2 xml-batik/sources/org/apache/batik/gvt/font/GVTLineMetrics.java
Index: GVTLineMetrics.java
===================================================================
RCS file: /home/cvs/xml-batik/sources/org/apache/batik/gvt/font/GVTLineMetrics.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- GVTLineMetrics.java 2001/06/12 23:49:41 1.2
+++ GVTLineMetrics.java 2001/07/05 06:21:04 1.3
@@ -14,7 +14,7 @@
* GVTLineMetrics is a GVT version of java.awt.font.LineMetrics.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Bella Robinson</a>
- * @version $Id: GVTLineMetrics.java,v 1.2 2001/06/12 23:49:41 bella Exp $
+ * @version $Id: GVTLineMetrics.java,v 1.3 2001/07/05 06:21:04 bella Exp $
*/
public class GVTLineMetrics {
@@ -33,7 +33,12 @@
protected float overlineOffset;
protected float overlineThickness;
-
+ /**
+ * Constructs a GVTLineMetrics object based on the specified line metrics.
+ *
+ * @param lineMetrics The lineMetrics object that this metrics object will
+ * be based upon.
+ */
public GVTLineMetrics(LineMetrics lineMetrics) {
this.ascent = lineMetrics.getAscent();
@@ -51,6 +56,15 @@
this.overlineThickness = this.underlineThickness;
}
+
+ /**
+ * Constructs a GVTLineMetrics object based on the specified line metrics
+ * with a scale factor applied.
+ *
+ * @param lineMetrics The lineMetrics object that this metrics object will
+ * be based upon.
+ * @param scaleFactor The scale factor to apply to all metrics.
+ */
public GVTLineMetrics(LineMetrics lineMetrics, float scaleFactor) {
this.ascent = lineMetrics.getAscent() * scaleFactor;
@@ -69,6 +83,9 @@
}
+ /**
+ * Constructs a GVTLineMetrics object with the specified attributes.
+ */
public GVTLineMetrics(float ascent, int baselineIndex, float[] baselineOffsets,
float descent, float height, float leading, int numChars,
float strikethroughOffset, float strikethroughThickness,
@@ -169,10 +186,16 @@
return underlineThickness;
}
+ /**
+ * Returns the position of the overline relative to the baseline.
+ */
public float getOverlineOffset() {
return overlineOffset;
}
+ /**
+ * Returns the thickness of the overline.
+ */
public float getOverlineThickness() {
return overlineThickness;
}
1.4 +9 -1 xml-batik/sources/org/apache/batik/gvt/font/AltGlyphHandler.java
Index: AltGlyphHandler.java
===================================================================
RCS file:
/home/cvs/xml-batik/sources/org/apache/batik/gvt/font/AltGlyphHandler.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AltGlyphHandler.java 2001/06/12 23:49:40 1.3
+++ AltGlyphHandler.java 2001/07/05 06:21:04 1.4
@@ -14,10 +14,18 @@
* An interface for handling altGlyphs.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Bella Robinson</a>
- * @version $Id: AltGlyphHandler.java,v 1.3 2001/06/12 23:49:40 bella Exp $
+ * @version $Id: AltGlyphHandler.java,v 1.4 2001/07/05 06:21:04 bella Exp $
*/
public interface AltGlyphHandler {
+ /**
+ * Creates a glyph vector containing the alternate glyphs.
+ *
+ * @param frc The current font render context.
+ * @param fontSize The required font size.
+ * @return The GVTGlyphVector containing the alternate glyphs, or null if
+ * the alternate glyphs could not be found.
+ */
GVTGlyphVector createGlyphVector(FontRenderContext frc, float fontSize);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
