Ignore:
Timestamp:
2012-06-09T20:03:41+02:00 (12 years ago)
Author:
bastiK
Message:

doc improvements

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/org/openstreetmap/josm/gui/ExtendedDialog.java

    r5266 r5275  
    4242 * General configurable dialog window.
    4343 *
    44  * If dialog is modal, you can use getValue() to retrieve the
     44 * If dialog is modal, you can use {@link #getValue()} to retrieve the
    4545 * button index. Note that the user can close the dialog
    4646 * by other means. This is usually equivalent to cancel action.
    4747 *
    48  * For non-modal dialogs, buttonAction(int) can be overridden.
     48 * For non-modal dialogs, {@link #buttonAction(int, ActionEvent)} can be overridden.
    4949 *
    5050 * There are various options, see below.
    5151 *
    5252 * Note: The button indices are counted from 1 and upwards.
    53  * So for getValue(), setDefaultButton(int) and setCancelButton(int) the
    54  * first button has index 1.
     53 * So for {@link #getValue()}, {@link #setDefaultButton(int)} and
     54 * {@link #setCancelButton} the first button has index 1.
    5555 *
    5656 * Simple example:
    57  * <code>
     57 * <pre>
    5858 *  ExtendedDialog ed = new ExtendedDialog(
    5959 *          Main.parent, tr("Dialog Title"),
    … …  
    6666 *      // proceed...
    6767 *  }
    68  * </code>
     68 * </pre>
    6969 */
    7070public class ExtendedDialog extends JDialog {
    … …  
    171171
    172172    /**
    173      * Allows decorating the buttons with tooltips. Expects an String[] with translated
    174      * tooltip texts.
     173     * Allows decorating the buttons with tooltips. Expects a String array with
     174     * translated tooltip texts.
    175175     *
    176176     * @param toolTipTexts the tool tip texts. Ignored, if null.
    … …  
    224224    /**
    225225     * Decorate the dialog with an icon that is shown on the left part of
    226      * the window area. (Similar to how it is done in JOptionPane)
     226     * the window area. (Similar to how it is done in {@link JOptionPane})
    227227     */
    228228    public ExtendedDialog setIcon(Icon icon) {
    … …  
    232232
    233233    /**
    234      * Convenience method to allow values that would be accepted by JOptionPane as messageType.
     234     * Convenience method to allow values that would be accepted by {@link JOptionPane} as messageType.
    235235     */
    236236    public ExtendedDialog setIcon(int messageType) {
    … …  
    253253    /**
    254254     * Show the dialog to the user. Call this after you have set all options
    255      * for the dialog. You can retrieve the result using <code>getValue</code>
     255     * for the dialog. You can retrieve the result using {@link #getValue()}.
    256256     */
    257257    public ExtendedDialog showDialog() {
    … …  
    273273
    274274    /**
    275      * @return int * The selected button. The count starts with 1.
    276      *             * A return value of ExtendedDialog.DialogClosedOtherwise means the dialog has been closed otherwise.
     275     * Retrieve the user choice after the dialog has been closed.
     276     *
     277     * @return <ul> <li>The selected button. The count starts with 1.</li>
     278     *              <li>A return value of {@link #DialogClosedOtherwise} means the dialog has been closed otherwise.</li>
     279     *         </ul>
    277280     */
    278281    public int getValue() {
    … …  
    283286
    284287    /**
    285      * This is called by showDialog().
     288     * This is called by {@link #showDialog()}.
    286289     * Only invoke from outside if you need to modify the contentPane
    287290     */
    … …  
    402405    /**
    403406     * This gets performed whenever a button is clicked or activated
     407     * @param buttonIndex the button index (first index is 0)
    404408     * @param evt the button event
    405409     */
    … …  
    574578    /**
    575579     * This function checks the state of the "Do not show again" checkbox and
    576      * writes the corresponding pref
     580     * writes the corresponding pref.
    577581     */
    578582    private void toggleSaveState() {
Note: See TracChangeset for help on using the changeset viewer.