Each class's author is now listed as Than.

This commit is contained in:
dchandler 2003-02-01 05:38:48 +00:00
parent d453e801ef
commit a1f6b9e117
25 changed files with 50 additions and 1 deletions

View file

@ -52,6 +52,8 @@ import javax.swing.text.*;
* These are read and converted into characters by DiacriticPanel and they are displayed in the order they are read.
* Thus, to reorder, modify, or add diacritics, one needs only to make the appropriate changes to the dia.dat file.
* </p>
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class DiacriticPanel extends JPanel implements TibConstants

View file

@ -33,6 +33,8 @@ import org.jdom.*;
* There are two types of discussion: brief (no paragraphs) and long (with paragraphs). It provides the user
* with a {@link DiacriticPanel} so that diacritics can be easily entered into the discussion. It also provides
* means to format the text as either bold and/or italic.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class DiscDialog extends JDialog implements TibConstants, ActionListener
{

View file

@ -29,6 +29,8 @@ import java.util.NoSuchElementException;
* This class displays a separate window with information concerning a texts doxographical category and it
* allows the user to set the doxographical categorization for a text. It changes options as the category is
* specificed and allows the user to view the categories in either English or Tibetan.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class DoxWindow extends JFrame

View file

@ -31,6 +31,8 @@ import java.awt.event.ActionEvent;
* <li>{@link TibConstants.REMOVE_APP REMOVE_APP} - calls {@link TiblEdit#removeApp()}
* <li>{@link TibConstants.REMOVE_TITLE REMOVE_TITLE} - calls {@link TiblEdit#removeTitle()}
* </ul>
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class EditAction extends TibAction

View file

@ -26,7 +26,7 @@ import org.jdom.*;
* Element List is a list of elements and ranges. The ranges refer to the {@link TextPanel} locations
* where the text for that element is found. The {@link #getElement} method takes an integer location
* in the TextPanel and returns the <code>org.jdom.Element</code> that is associated with that location
* <i>if ther is one</i>! If not, it returns <code>null</code>, indicating there is nothing to edit at
* <i>if there is one</i>! If not, it returns <code>null</code>, indicating there is nothing to edit at
* that location. This is created by the TextPanel and given to the {@link TiblEdit} controller so
* it can turn on and off menu options and functionality, depending on the position of the cursor in
* the TextPane.

View file

@ -24,6 +24,8 @@ import org.jdom.*;
* This wrapper class associates a String of text with a Style (as defined in {@link TibConstants}?) and a particular
* element. It is used for interactivity with the {@link TextPane} so that highlighting or clicking on a string in the
* text pane can be associated with actions for processing the text within an element.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class ElementStyle implements TibConstants

View file

@ -22,6 +22,8 @@ import java.awt.event.ActionEvent;
/**
* This class is used to associate actions with the File menu of {@link TibFrame}.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class FileAction extends TibAction

View file

@ -25,6 +25,8 @@ import org.jdom.output.*;
/**
* This abstract class is extended by both {@link IDFactory} and {@link TitleFactory}, and provides general functionality
* such as setting the document associated with the factory and setting text/styles for the {@link TextPane}.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
abstract class GenericTibFactory implements TibConstants

View file

@ -25,6 +25,8 @@ import org.jdom.output.*;
/**
* Like its sister class, {@link TitleFactory}, this class is used to access and display the information
* in the ID section of a TIBBIBL record.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class IDFactory extends GenericTibFactory implements TibConstants

View file

@ -32,6 +32,8 @@ import java.awt.event.ActionEvent;
* <li>{@link TibConstants.TITLE_DISC TITLE_DISC} - calls {@link TiblEdit#insertDiscussion()}
* <li>{@link TibConstants.INSERT_APP INSERT_APP} - calls {@link TiblEdit#insertApp()}
* </ul>
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class InsertAction extends TibAction

View file

@ -34,6 +34,8 @@ import javax.swing.border.BevelBorder;
/**
* This class displays the initial splash screen upon opening the program.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class IntroSign extends JFrame implements Runnable

View file

@ -35,6 +35,8 @@ import org.jdom.output.*;
* text's bibliographic information. The panel is created using the text's information
* contained in a {@link TibDoc} and then is added or set to the content pane
* of the main frame which is an {@link TibFrame}.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class TextPane extends JTextPane implements TibConstants

View file

@ -25,6 +25,8 @@ import java.io.File;
* This extension of javax.swing.AbstractAction is used for the various menus in {@link TibFrame}. It assigns two
* special key/value pairs: the frame, which points to the TibFrame, and the controller which is the main program,
* TiblEdit.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
abstract class TibAction extends AbstractAction implements TibConstants

View file

@ -26,6 +26,8 @@ import java.util.Hashtable;
/**
* This interface contains all the constants used throughout the TiblEdit program. They are roughly organized
* according to type, but the organization could definitely be cleaned up some.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public interface TibConstants

View file

@ -21,6 +21,10 @@ package org.thdl.tib.bibl;
import org.xml.sax.EntityResolver;
import org.xml.sax.InputSource;
/* FIXMEDOC.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class TibDTDResolver implements EntityResolver, TibConstants {
public InputSource resolveEntity (String publicId, String systemId)
{

View file

@ -31,6 +31,7 @@ import javax.swing.event.*;
* TiblEdit. It may be a relic. CHECK!
* </p>
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class TibDialog extends JDialog implements ActionListener, TibConstants

View file

@ -36,6 +36,8 @@ import org.jdom.output.*;
* contained inside the associated Title element that contains as its text the transliteration
* of the Tibetan title.
* </p>
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class TibDoc extends XMLDoc

View file

@ -38,6 +38,8 @@ import javax.swing.event.*;
* view window, but also allows split screens with a {@link DiacriticPanel} on the left and/or
* a {@link TibTable} at the bottom.
* </p>
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class TibFrame extends JFrame implements CaretListener, TibConstants

View file

@ -33,6 +33,8 @@ import org.jdom.*;
/**
* This element is a wrapper element for a JTable that sets up two kinds of tables for editing a Tibbibl--one for
* displaying various editions and one for displaying alternative readings.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class TibTable extends Observable implements TibConstants, ActionListener

View file

@ -25,6 +25,8 @@ import org.jdom.output.*;
/**
* The TitleFactory class extends the GenericTibFactory to provide means for locating and manipulating title elements
* within a {@link TibDoc}.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class TitleFactory extends GenericTibFactory implements TibConstants

View file

@ -28,6 +28,8 @@ import org.jdom.output.*;
* This class provides the mechanism to "parse" a Tibbibl title tag and understand its contents. Some title tags
* will contain AP children that represent variant readings. TitleParser can among other things supply the text
* of the main readings in the title, weeding out the alternative one.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class TitleParser implements TibConstants

View file

@ -30,6 +30,8 @@ import java.awt.event.ActionEvent;
* <li>{@link TibConstants.USER_ID_VIEW USER_ID_VIEW} - calls {@link TiblEdit#getEditorInfo()}
* <li>{@link TibConstants.ABOUT ABOUT} - calls {@link TiblEdit#showSplash()}
* </ul>
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class ViewAction extends TibAction

View file

@ -29,6 +29,8 @@ import org.jdom.output.*;
* extended by {@link TibDoc}, which adds more specific functionality and is the class used in the TiblEdit program.
* This class needs to be cleaned up so that only the most general XML functions remain and the functions that are
* specific to our DTD are relegated to TibDoc.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class XMLDoc extends org.jdom.Document implements TibConstants

View file

@ -25,6 +25,8 @@ import javax.swing.filechooser.*;
/**
* XMLFilter extends java.io.FileFilter to display only XML files in the open filechooser window.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class XMLFilter extends FileFilter {

View file

@ -30,6 +30,8 @@ import org.xml.sax.*;
/**
* This class reads in an XML file using the SAXBuilder in org.jdom.input.
*
* @author Than Garson, Tibetan and Himalayan Digital Library
*/
public class XMLReader extends Observable implements TibConstants