Javadoc 1.4.1_01 no longer has a single warning about this package.
This commit is contained in:
dchandler
parent
c379db6ff5
commit
aa144dd599
13 changed files with 76 additions and 50 deletions
|
|
@ -102,7 +102,7 @@ public class DiacriticPanel extends JPanel implements TibConstants
|
|||
/**
|
||||
* This method takes a character, which is actually a String variable and creates a label
|
||||
* with a border and a margin with the supplied character string as the
|
||||
* centered text. Adds a MouseListener that is a {@link #TiblEditMouseAdapter}. It is called by the {@link #init} method.
|
||||
* centered text. Adds a MouseListener that is a {@link DiacriticPanel.TiblEditMouseAdapter}. It is called by the {@link #init} method.
|
||||
*
|
||||
* @param ch - A string variable that is the character associated with this label/button.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -26,10 +26,10 @@ import java.awt.event.ActionEvent;
|
|||
* super constructor. The action performed takes the following action commands:
|
||||
* </p>
|
||||
* <ul>
|
||||
* <li>{@link TibConstants.TRANS_EDIT TRANS_EDIT} - calls {@link TiblEdit#editTranslation()}
|
||||
* <li>{@link TibConstants.NORM_EDIT NORM_EDIT} - calls {@link TiblEdit#enterTranslation()}
|
||||
* <li>{@link TibConstants.REMOVE_APP REMOVE_APP} - calls {@link TiblEdit#removeApp()}
|
||||
* <li>{@link TibConstants.REMOVE_TITLE REMOVE_TITLE} - calls {@link TiblEdit#removeTitle()}
|
||||
* <li>{@link TibConstants#TRANS_EDIT TRANS_EDIT} - calls {@link TiblEdit#editTranslation()}
|
||||
* <li>{@link TibConstants#NORM_EDIT NORM_EDIT} - calls {@link TiblEdit#enterTranslation()}
|
||||
* <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
|
||||
|
|
|
|||
|
|
@ -23,11 +23,11 @@ import org.jdom.*;
|
|||
|
||||
/**
|
||||
* <p>
|
||||
* 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
|
||||
* Element List is a list of elements and ranges. The ranges refer to the {@link TextPane} locations
|
||||
* where the text for that element is found. The {@link #getElementAt(int)} method takes an integer location
|
||||
* in the TextPane and returns the <code>org.jdom.Element</code> that is associated with that location
|
||||
* <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
|
||||
* that location. This is created by the TextPane 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.
|
||||
* </p>
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ package org.thdl.tib.bibl;
|
|||
import org.jdom.*;
|
||||
|
||||
/**
|
||||
* This wrapper class associates a String of text with a Style (as defined in {@link TibConstants}?) and a particular
|
||||
* This wrapper class associates a String of text with a Style (as defined in {@link TibConstants} [MAYBE]) 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.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -226,7 +226,7 @@ public class IDFactory extends GenericTibFactory implements TibConstants
|
|||
*
|
||||
* @param String - the master ID string
|
||||
*
|
||||
* @Return String - the new file name based on the master ID
|
||||
* @return String - the new file name based on the master ID
|
||||
*/
|
||||
public void setMasterID(String masterID)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -26,11 +26,11 @@ import java.awt.event.ActionEvent;
|
|||
* super constructor. The action performed takes the following action commands:
|
||||
* </p>
|
||||
* <ul>
|
||||
* <li>{@link TibConstants.ED_INFO ED_INFO} - calls {@link TiblEdit#insertNewEdition()}
|
||||
* <li>{@link TibConstants.CRIT_TITLE CRIT_TITLE} - calls {@link TiblEdit#insertCritTitle()}
|
||||
* <li>{@link TibConstants.ED_TITLE ED_TITLE} - calls {@link TiblEdit#insertEdTitle()}
|
||||
* <li>{@link TibConstants.TITLE_DISC TITLE_DISC} - calls {@link TiblEdit#insertDiscussion()}
|
||||
* <li>{@link TibConstants.INSERT_APP INSERT_APP} - calls {@link TiblEdit#insertApp()}
|
||||
* <li>{@link TibConstants#ED_INFO ED_INFO} - calls {@link TiblEdit#insertNewEdition()}
|
||||
* <li>{@link TibConstants#CRIT_TITLE CRIT_TITLE} - calls {@link TiblEdit#insertCritTitle()}
|
||||
* <li>{@link TibConstants#ED_TITLE ED_TITLE} - calls {@link TiblEdit#insertEdTitle()}
|
||||
* <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
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ public class TTFileView extends FileView implements TibConstants
|
|||
|
||||
/**
|
||||
* <p>
|
||||
* Overrides the ancestor's--{@link javax.swing.JFileChooser.FileView}--getName() function
|
||||
* Overrides the ancestor's--{@link FileView}--getName() function
|
||||
* so that it returns the text title as the name, if it is an XML file. This has the
|
||||
* effect of presenting a list of text names in the open dialog rather than their less
|
||||
* comprehensible file names.
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ public class TextPane extends JTextPane implements TibConstants
|
|||
|
||||
/**
|
||||
* <p>
|
||||
* This and the following are static, style constants, i.e. names of the styles
|
||||
* This and the following are static, style constants. I.e., they're names of the styles.
|
||||
*</p>
|
||||
*/
|
||||
public static String REG = "regular";
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ public class TibDoc extends XMLDoc
|
|||
private TitleFactory tf;
|
||||
/**
|
||||
* <p>
|
||||
* The {@link IDFactory} associated with this Tibbibl XML document
|
||||
* The {@link IDFactory} associated with this Tibbibl XML document.
|
||||
* </p>
|
||||
*/
|
||||
private IDFactory idf;
|
||||
|
|
@ -202,7 +202,7 @@ public class TibDoc extends XMLDoc
|
|||
|
||||
/**
|
||||
* <p>
|
||||
* This method returns an array of strings that contains 1. the opening string of the header, such as
|
||||
* This method returns an array of strings. The array contains 1. the opening string of the header, such as
|
||||
* "Bibliographic Record for", and 2. the text contain within each of its children elements, usually
|
||||
* there are two of these a lang="tib" and a lang="eng", each one entered separately. The strings
|
||||
* are stripped of extraneous paragraph markers and spaces using the {@link #cleanString} method.
|
||||
|
|
|
|||
|
|
@ -312,7 +312,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants
|
|||
|
||||
/**
|
||||
* <p>
|
||||
* This method sets the list of recent files in the file menu
|
||||
* This method sets the list of recent files in the file menu.
|
||||
* </p>
|
||||
*
|
||||
* @param recent - A Vector of the recent files from the controller.
|
||||
|
|
@ -442,7 +442,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants
|
|||
|
||||
/**
|
||||
* <p>
|
||||
* This method is called (maybe?) when the cursor is on a title. It enables the add
|
||||
* This method is called (maybe) when the cursor is on a title. It enables the add
|
||||
* critical title menu option. (May be deprecated?)
|
||||
* </p>
|
||||
*/
|
||||
|
|
@ -453,7 +453,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants
|
|||
|
||||
/**
|
||||
* <p>
|
||||
* This method is called (maybe?) when cursor is on something other than a title. It disnables the add
|
||||
* This method is called (maybe) when cursor is on something other than a title. It disables the add
|
||||
* critical title menu option. (May be deprecated?)
|
||||
* </p>
|
||||
*/
|
||||
|
|
@ -466,7 +466,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants
|
|||
* <p>
|
||||
* This method displays a {@link TibTable} as the bottom half of a split screen with the {@link TextPane}
|
||||
* This particular table displays the editions consulted for the formation of the master record
|
||||
* by displaying the information in the text's tibiddecl element. To do so it uses {@link TibTable(IDFactory) TibTable constructor}
|
||||
* by displaying the information in the text's tibiddecl element. To do so it uses {@link TibTable#TibTable(IDFactory) TibTable constructor}
|
||||
* that takes an {@link IDFactory} retrieved from the {@link TibDoc}. It then calls {@link #showTable(TibTable) TibTable}
|
||||
* method.
|
||||
* </p>
|
||||
|
|
@ -504,7 +504,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants
|
|||
|
||||
/**
|
||||
* <p>
|
||||
* This method creates a split screen with a {@link DiacriticPanel(TibFrame) DiacriticPanel}
|
||||
* This method creates a split screen with a {@link DiacriticPanel#DiacriticPanel(TibFrame) DiacriticPanel}
|
||||
* on the left and the main {@link TextPane} on the right.
|
||||
* </p>
|
||||
*/
|
||||
|
|
@ -741,7 +741,7 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants
|
|||
/**
|
||||
* <p>
|
||||
* This method is used by {@link #showTitles(TitleFactory)} to insert prompts for information
|
||||
* at the correct location. The showTitles method creates a vector of {@link ElementStyles}. Once
|
||||
* at the correct location. The showTitles method creates a vector of {@link ElementStyle}. Once
|
||||
* this is created, if the {@link TiblEdit#mode} is to insert a title or translation. This method
|
||||
* is called with the selected element. It searches the vector for that element and returns its
|
||||
* index in the vector.
|
||||
|
|
@ -850,15 +850,17 @@ public class TibFrame extends JFrame implements CaretListener, TibConstants
|
|||
/**
|
||||
* <p>
|
||||
* When the TibFrame is closed, the program ends. The window is disposed. The controller's
|
||||
* {@link TiblEdit#writePrefs() writePrefs()} method is called, and the system is exited.
|
||||
* {@link TiblEdit#exit() exit()} method is called, and the system is exited.
|
||||
* </p>
|
||||
*
|
||||
* @param WindowEvent - the required parameter for this abstract method.
|
||||
*/
|
||||
public class XWindowHandler extends WindowAdapter
|
||||
implements TibConstants
|
||||
{
|
||||
|
||||
/** See class comment.
|
||||
*
|
||||
* @param WindowEvent - the required parameter for this abstract method.
|
||||
*/
|
||||
public void windowClosing(WindowEvent e)
|
||||
{
|
||||
e.getWindow().dispose();
|
||||
|
|
|
|||
|
|
@ -112,7 +112,7 @@ public class TiblEdit implements MouseListener, KeyListener, Observer, TibConsta
|
|||
|
||||
/**
|
||||
* <p>
|
||||
* This is the name of the file which is changed when the master ID is changes
|
||||
* This is the name of the file which is changed when the master ID is changes.
|
||||
* </p>
|
||||
*/
|
||||
String fileName;
|
||||
|
|
@ -146,7 +146,7 @@ public class TiblEdit implements MouseListener, KeyListener, Observer, TibConsta
|
|||
private String todaysDate;
|
||||
/**
|
||||
* <p>
|
||||
* This is the file chooser object that will be modified in {@link #setFileChoose} so
|
||||
* This is the file chooser object that will be modified in {@link #setFileChooser} so
|
||||
* that it displays the text names instead of the file names when opening a file.
|
||||
* </p>
|
||||
*/
|
||||
|
|
@ -220,7 +220,7 @@ public class TiblEdit implements MouseListener, KeyListener, Observer, TibConsta
|
|||
|
||||
/**
|
||||
* <p>
|
||||
* This variable tells whether a text has been saved or not
|
||||
* This variable tells whether a text has been saved or not.
|
||||
* </p>
|
||||
*/
|
||||
boolean hasBeenSaved;
|
||||
|
|
@ -246,9 +246,9 @@ public class TiblEdit implements MouseListener, KeyListener, Observer, TibConsta
|
|||
/**
|
||||
* <p>
|
||||
* The init method sets the {@link #dataDirectory}, {@link #currentDirectory},
|
||||
* and the {@link tibFrame} variables. It reads in preferences from {@link #readPrefData},
|
||||
* and the {@link #tibFrame} variables. It reads in preferences from {@link #readPrefData},
|
||||
* performs {@link #setDate} and {@link #setFileChooser}, and sets the {@link #mode}
|
||||
* to {@link TibConstants@NORM}.
|
||||
* to {@link TibConstants#NORM}.
|
||||
* </p>
|
||||
*/
|
||||
public void init()
|
||||
|
|
@ -312,7 +312,7 @@ public class TiblEdit implements MouseListener, KeyListener, Observer, TibConsta
|
|||
* This reads in the preferences from the preference file that is located in
|
||||
* {@link TibConstants#DEFAULT_DIRECTORY} + {@link TibConstants#BIN} +
|
||||
* {@link TibConstants#PREFS}. The main preferences that are stored in this file
|
||||
* are: the {@link editorsInitials} and {@link editorsName}.
|
||||
* are: the {@link #editorsInitials} and {@link #editorsName}.
|
||||
* </p>
|
||||
*/
|
||||
public void readPrefData()
|
||||
|
|
@ -547,7 +547,7 @@ System.out.println("EdInits given: " + editorsInitials);
|
|||
*
|
||||
* @return int - the current display mode
|
||||
*
|
||||
* @see setMode
|
||||
* @see #setMode
|
||||
*/
|
||||
public int getMode()
|
||||
{
|
||||
|
|
@ -616,7 +616,7 @@ System.out.println("EdInits given: " + editorsInitials);
|
|||
|
||||
/**
|
||||
* <p>
|
||||
* Returns the editors name
|
||||
* Returns the editors name.
|
||||
* </p>
|
||||
*
|
||||
* @return String - the editor's name.
|
||||
|
|
@ -1046,7 +1046,7 @@ System.out.println("EdInits given: " + editorsInitials);
|
|||
* critically edited. They represent titles as they appear in particular editions.
|
||||
* One choses a particular edition title as the basis for a critical title which
|
||||
* then can have app elements collating the various readings. This method uses
|
||||
* a {@link TibDialog} with {@link TibConstants@NEW_ED_TITLE_INFO} and
|
||||
* a {@link TibDialog} with {@link TibConstants#NEW_ED_TITLE_INFO} and
|
||||
* {@link TibConstants#NEW_ED_TITLE_INFO_SPECS} to get the title and its pagination.
|
||||
* When the <code>TibDialog</code> is submitted, the {@link #insertNewEdTitle} method
|
||||
* is called with that <code>TibDialog</code>.
|
||||
|
|
@ -1122,7 +1122,7 @@ System.out.println("EdInits given: " + editorsInitials);
|
|||
* <p>
|
||||
* This method is called when one either double clicks on a title or chooses enter a translation
|
||||
* from the menu. It first determines if the selected element is the normalized title, in which case
|
||||
* it sets the {@link #mode} to {@link TibConstants.ENTER_NORMALIZED ENTER_NORMALIZED} and redisplays with the appropriate prompts.
|
||||
* it sets the {@link #mode} to {@link TibConstants#ENTER_NORMALIZED ENTER_NORMALIZED} and redisplays with the appropriate prompts.
|
||||
* Otherwise, it makes sure there is a Tibetan title there and not "No title given" or "Not specified" and
|
||||
* if it's a valid title, asks the user if they want to create a critical title with the selected title
|
||||
* as its base. If so, it redisplays with the appropriate prompts.
|
||||
|
|
@ -1202,7 +1202,7 @@ System.out.println("EdInits given: " + editorsInitials);
|
|||
* prompt to the next paragraph mark "/n", and then calls the {@link TibDoc#addTranslation}
|
||||
* method with this translation <code>String</code> and the {@link #selected_element}.
|
||||
* The display mode ({@link #mode}) is then set to {@link TibConstants#NORM} and
|
||||
* the text is redisplayed using {@link TibFrame@showTitles} which returns
|
||||
* the text is redisplayed using {@link TibFrame#showTitles} which returns
|
||||
* an {@link ElementList} that is assigned to {@link #elemList}.
|
||||
* </p>
|
||||
*/
|
||||
|
|
@ -1373,8 +1373,8 @@ System.out.println("EdInits given: " + editorsInitials);
|
|||
/**
|
||||
* <p>
|
||||
* This method inserts a particular type of discussion depending on the setting of the
|
||||
* type parameter. When type equals {@link TibConstants.TITLE TITLE}, a discussion will be inserted
|
||||
* for the title at the cursor position of the {@link TextPane}. When type equals {@link TibConstants.GEN GEN}
|
||||
* type parameter. When type equals {@link TibConstants#TITLE TITLE}, a discussion will be inserted
|
||||
* for the title at the cursor position of the {@link TextPane}. When type equals {@link TibConstants#GEN GEN}
|
||||
* the user will be prompted with a list of options to choose from.
|
||||
* </p>
|
||||
*
|
||||
|
|
@ -1435,7 +1435,7 @@ System.out.println("EdInits given: " + editorsInitials);
|
|||
* <li><b>Key: </b> {@link TibConstants#TABLE} -- the {@link TibTable.TibTableModel} that contains the data.
|
||||
* <li><b>Key:</b> {@link TibConstants#PAGIN} -- the hashtable of paginations keyed on edition sigla, used to create table
|
||||
* </ul>
|
||||
* First, it sets the information for the main reading found in the {@link TibConstants#LEM} or lemma element.
|
||||
* First, it sets the information for the main reading found in the {@link TibConstants#LM} or lemma element.
|
||||
* Then, it correlates the reading witnesses already in the app element with the siglas
|
||||
* for the lines of data in the table and replaces the information in existing reading elements
|
||||
* or adds new ones where necessary.
|
||||
|
|
@ -1846,7 +1846,7 @@ System.out.println("EdInits given: " + editorsInitials);
|
|||
* <p>
|
||||
* This method is invoked when the {@link DoxWindow} is submitted. It calls upon the
|
||||
* {@link TibDoc} to {@link TibDoc#setDoxography(String, String) setDoxography} and then
|
||||
* to {@link TibDox#setMasterID(String) setMasterID}.
|
||||
* to {@link TibDoc#setMasterID(String) setMasterID}.
|
||||
* </p>
|
||||
*
|
||||
* @param DoxWindow - the doxography selection window that supplies the users input.
|
||||
|
|
@ -2194,7 +2194,7 @@ System.out.println("EdInits given: " + editorsInitials);
|
|||
* and there is an {@link ElementList} defined to check. It checks the {@link #elemList}
|
||||
* for the selected element, if it is a {@link TibConstants#TITLE}, then it calls
|
||||
* {@link #enterTranslation}. If it is an {@link TibConstants#AP}, then it calls
|
||||
* {@link #showAp}.
|
||||
* {@link #showApp}.
|
||||
* </p>
|
||||
*
|
||||
* @param MouseEvent - the required parameter for this abstract method.
|
||||
|
|
@ -2251,8 +2251,8 @@ System.out.println("EdInits given: " + editorsInitials);
|
|||
* This implementation of the KeyListener interface is used when information
|
||||
* is being added directly to the {@link TextPane} being displayed. If the
|
||||
* Enter key is pressed, the it checks the {@link #mode}. If the mode is
|
||||
* {@link TibConstants#ENTER_TRANS}, then it calls {@link insertTranslation}.
|
||||
* If the mode is {@link NEW_TITLE}, it calls {@link insertNewTitleAndTranslation}.
|
||||
* {@link TibConstants#ENTER_TRANS}, then it calls {@link #insertTranslation}.
|
||||
* If the mode is {@link #NEW_TITLE}, it calls {@link #insertNewTitleAndTranslation}.
|
||||
* </p>
|
||||
*
|
||||
* @param KeyEvent - the required parameter for this abstract method.
|
||||
|
|
|
|||
|
|
@ -26,9 +26,9 @@ import java.awt.event.ActionEvent;
|
|||
* super constructor. The action performed takes the following action commands:
|
||||
* </p>
|
||||
* <ul>
|
||||
* <li>{@link TibConstants.MASTER_ID_VIEW MASTER_ID_VIEW} - calls {@link TiblEdit#showMasterDox()}
|
||||
* <li>{@link TibConstants.USER_ID_VIEW USER_ID_VIEW} - calls {@link TiblEdit#getEditorInfo()}
|
||||
* <li>{@link TibConstants.ABOUT ABOUT} - calls {@link TiblEdit#showSplash()}
|
||||
* <li>{@link TibConstants#MASTER_ID_VIEW MASTER_ID_VIEW} - calls {@link TiblEdit#showMasterDox()}
|
||||
* <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
|
||||
|
|
|
|||
24
source/org/thdl/tib/bibl/package.html
Normal file
24
source/org/thdl/tib/bibl/package.html
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
@(#)package.html
|
||||
|
||||
Copyright 2001-2003 Tibetan and Himalayan Digital Library
|
||||
|
||||
This software is the confidential and proprietary information of
|
||||
the Tibetan and Himalayan Digital Library. You shall use such
|
||||
information only in accordance with the terms of the license
|
||||
agreement you entered into with the THDL.
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
Provides classes and methods for the Tibbibl application.
|
||||
<p>
|
||||
Tibbibl is for editing scholarly bibliographies of Tibetan texts,
|
||||
where the bibliographies are stored as XML instances.
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Reference in a new issue