Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> nwalsh >> [ xalan overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.nwalsh.xalan
Class Callout  

java.lang.Object
  com.nwalsh.xalan.Callout

All Implemented Interfaces:

java.lang.Comparable

---

public class Callout

extends java.lang.Object

implements java.lang.Comparable

Utility class for the Verbatim extension (ignore this).

Copyright (C) 2000 Norman Walsh.

This class is just for book keeping in the Verbatim class. It stores information about the location of callouts.

Only line/column based callouts are supported. This class implements the Comparable interface so that callouts can be sorted. Callouts are sorted so that they occur in left-to-right, top-to-bottom order based on line/column.

Change Log:

1.0

Initial release.

---

Field Summary
private  org.w3c.dom.Element	area           The area Element item that generated this callout.
private  int	callout           The callout number.
static int	CALS_PAIR
private  int	col           The column in which this callout appears.
private  int	line           The line on which this callout occurs.
static int	LINE_COLUMN
static int	LINE_COLUMN_PAIR
static int	LINE_RANGE
static int	OTHER
private  java.lang.String	otherType           The other type of callout.
private  int	type           The type of callout.

 

Constructor Summary

Callout(int callout, org.w3c.dom.Element area, int line, int col, int type)           The constructor; initialize the private data structures.

Callout(int callout, org.w3c.dom.Element area, int line, int col, java.lang.String otherType)           The constructor; initialize the private data structures.

 

Method Summary
int	compareTo(java.lang.Object o)           The compareTo method compares this Callout with another.
org.w3c.dom.Element	getArea()           Access the Callout's area.
int	getCallout()           Access the Callout's callout number.
int	getColumn()           Access the Callout's column.
int	getLine()           Access the Callout's line.
java.lang.String	getOtherType()           Access the Callout's otherType.
int	getType()           Access the Callout's type.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

callout

private int callout

The callout number.

---

area

private org.w3c.dom.Element area

The area Element item that generated this callout.

---

line

private int line

The line on which this callout occurs.

---

col

private int col

The column in which this callout appears.

---

type

private int type

The type of callout.

---

otherType

private java.lang.String otherType

The other type of callout.

---

CALS_PAIR

public static final int CALS_PAIR

See Also:

Constant Field Values

---

LINE_COLUMN

public static final int LINE_COLUMN

See Also:

Constant Field Values

---

LINE_COLUMN_PAIR

public static final int LINE_COLUMN_PAIR

See Also:

Constant Field Values

---

LINE_RANGE

public static final int LINE_RANGE

See Also:

Constant Field Values

---

OTHER

public static final int OTHER

See Also:

Constant Field Values

Constructor Detail

Callout

public Callout(int callout,
               org.w3c.dom.Element area,
               int line,
               int col,
               int type)

The constructor; initialize the private data structures.

---

Callout

public Callout(int callout,
               org.w3c.dom.Element area,
               int line,
               int col,
               java.lang.String otherType)

The constructor; initialize the private data structures.

Method Detail

compareTo

public int compareTo(java.lang.Object o)

The compareTo method compares this Callout with another.

Given two Callouts, A and B, A < B if:

1. A.line < B.line, or
2. A.line = B.line && A.col < B.col, or
3. A.line = B.line && A.col = B.col && A.callout < B.callout
4. Otherwise, they're equal.

Specified by:

compareTo in interface java.lang.Comparable

---

getArea

public org.w3c.dom.Element getArea()

Access the Callout's area.

---

getLine

public int getLine()

Access the Callout's line.

---

getColumn

public int getColumn()

Access the Callout's column.

---

getCallout

public int getCallout()

Access the Callout's callout number.

---

getType

public int getType()

Access the Callout's type.

---

getOtherType

public java.lang.String getOtherType()

Access the Callout's otherType.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> nwalsh >> [ xalan overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---