Ignore:
Timestamp:
2016-01-01T02:35:34+01:00 (8 years ago)
Author:
Don-vip
Message:

javadoc update

Location:
trunk/src/org/openstreetmap/josm/gui
Files:
21 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/org/openstreetmap/josm/gui/dialogs/properties/SearchBasedRowFilter.java

    r8985 r9231  
    1414/**
    1515 * A {@link RowFilter} implementation which matches tags w.r.t. the specified filter's
    16  * {@link SearchCompiler.Match#match(org.openstreetmap.josm.data.osm.Tagged)} method.
     16 * {@link org.openstreetmap.josm.actions.search.SearchCompiler.Match#match(org.openstreetmap.josm.data.osm.Tagged)} method.
    1717 *
    1818 * <p>An {@link javax.swing.RowFilter.Entry}'s column 0 is considered as key, and column 1 is considered as value.</p>

  • trunk/src/org/openstreetmap/josm/gui/layer/Layer.java

    r8958 r9231  
    408408    /**
    409409     * allows to check whether a projection is supported or not
     410     * @param proj projection
    410411     *
    411412     * @return True if projection is supported for this layer

  • trunk/src/org/openstreetmap/josm/gui/preferences/PreferenceSetting.java

    r8958 r9231  
    1010     * Add the GUI elements to the dialog. The elements should be initialized after
    1111     * the current preferences.
     12     * @param gui the preferences tab pane
    1213     */
    1314    void addGui(PreferenceTabbedPane gui);

  • trunk/src/org/openstreetmap/josm/gui/preferences/imagery/ImageryPreference.java

    r9224 r9231  
    808808        /**
    809809         * Constructs a new {@code OffsetBookmarksPanel}.
     810         * @param gui the preferences tab pane
    810811         */
    811812        OffsetBookmarksPanel(final PreferenceTabbedPane gui) {

  • trunk/src/org/openstreetmap/josm/gui/preferences/map/MapPaintPreference.java

    r9059 r9231  
    168168    }
    169169
     170    /**
     171     * Returns title from a source entry.
     172     * @param entry source entry
     173     * @return title
     174     * @see MapCSSStyleSource#title
     175     */
    170176    public static String getTitleFromSourceEntry(SourceEntry entry) {
    171177        try {
    … …  
    233239         * the new entries to the user-configured list. Remember the known URLs,
    234240         * so an item that was deleted explicitly is not added again.
     241         * @param list new defaults
     242         * @return {@code true} if a change occurred
    235243         */
    236244        private boolean insertNewDefaults(List<SourceEntry> list) {

  • trunk/src/org/openstreetmap/josm/gui/progress/PleaseWaitProgressMonitor.java

    r9078 r9231  
    108108    /**
    109109     * Constructs a new {@code PleaseWaitProgressMonitor}.
     110     * @param windowTitle window title
    110111     */
    111112    public PleaseWaitProgressMonitor(String windowTitle) {
    … …  
    116117    /**
    117118     * Constructs a new {@code PleaseWaitProgressMonitor}.
     119     * @param dialogParent component to get parent frame from
    118120     */
    119121    public PleaseWaitProgressMonitor(Component dialogParent) {
    … …  
    129131    /**
    130132     * Constructs a new {@code PleaseWaitProgressMonitor}.
     133     * @param dialogParent component to get parent frame from
     134     * @param windowTitle window title
    131135     */
    132136    public PleaseWaitProgressMonitor(Component dialogParent, String windowTitle) {

  • trunk/src/org/openstreetmap/josm/gui/tagging/TagEditorModel.java

    r9078 r9231  
    413413    /**
    414414     * applies the current state of the tag editor model to a map of tags
     415     * @param keepEmpty {@code true} to keep empty tags
    415416     *
    416417     * @return the map of key/value pairs

  • trunk/src/org/openstreetmap/josm/gui/tagging/TagEditorPanel.java

    r8863 r9231  
    5959    }
    6060
     61    /**
     62     * Sets the next component to request focus after navigation (with tab or enter).
     63     * @param nextFocusComponent next component to request focus after navigation (with tab or enter)
     64     * @see TagTable#setNextFocusComponent
     65     */
    6166    public void setNextFocusComponent(Component nextFocusComponent) {
    6267        tagTable.setNextFocusComponent(nextFocusComponent);
    … …  
    9196    }
    9297
     98    /**
     99     * Returns the paste action.
     100     * @return the paste action
     101     */
    93102    public AbstractAction getPasteAction() {
    94103        return tagTable.getPasteAction();
    … …  
    141150     * Creates a new tag editor panel. The editor model is created
    142151     * internally and can be retrieved with {@link #getModel()}.
     152     * @param presetHandler tagging preset handler
    143153     */
    144154    public TagEditorPanel(TaggingPresetHandler presetHandler) {
    … …  
    147157
    148158    /**
    149      * Creates a new tag editor panel with a supplied model. If
    150      * {@code model} is null, a new model is created.
     159     * Creates a new tag editor panel with a supplied model. If {@code model} is null, a new model is created.
    151160     *
    152161     * @param model the tag editor model
     162     * @param presetHandler tagging preset handler
    153163     * @param maxCharacters maximum number of characters allowed, 0 for unlimited
    154164     */

  • trunk/src/org/openstreetmap/josm/gui/tagging/TagTable.java

    r9078 r9231  
    504504    }
    505505
     506    /**
     507     * Sets the next component to request focus after navigation (with tab or enter).
     508     * @param nextFocusComponent next component to request focus after navigation (with tab or enter)
     509     */
    506510    public void setNextFocusComponent(Component nextFocusComponent) {
    507511        this.nextFocusComponent = nextFocusComponent;
    … …  
    512516    }
    513517
    514     public void  addOKAccelatorListener(KeyListener l) {
     518    public void addOKAccelatorListener(KeyListener l) {
    515519        addKeyListener(l);
    516520        if (editor != null) {

  • trunk/src/org/openstreetmap/josm/gui/tagging/ac/AutoCompletionItemPriority.java

    r8958 r9231  
    106106     * Merges two priorities.
    107107     * The resulting priority is always &gt;= the original ones.
     108     * @param other other priority
    108109     * @return the merged priority
    109110     */

  • trunk/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPreset.java

    r8959 r9231  
    204204    /**
    205205     * Called from the XML parser to set the types this preset affects.
     206     * @param types comma-separated primitive types ("node", "way", "relation" or "closedway")
    206207     * @throws SAXException if any SAX error occurs
     208     * @see TaggingPresetType#fromString
    207209     */
    208210    public void setType(String types) throws SAXException {

  • trunk/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetMenu.java

    r8870 r9231  
    108108    /**
    109109     * Sorts the menu items using the translated item text
     110     * @param menu menu to sort
    110111     */
    111112    public static void sortMenu(JMenu menu) {

  • trunk/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetSelector.java

    r8870 r9231  
    215215    /**
    216216     * Constructs a new {@code TaggingPresetSelector}.
     217     * @param displayOnlyApplicable if {@code true} display "Show only applicable to selection" checkbox
     218     * @param displaySearchInTags if {@code true} display "Search in tags" checkbox
    217219     */
    218220    public TaggingPresetSelector(boolean displayOnlyApplicable, boolean displaySearchInTags) {

  • trunk/src/org/openstreetmap/josm/gui/tagging/presets/items/ComboMultiSelect.java

    r9044 r9231  
    258258     *      must be escaped within one entry
    259259     * @param s the string
     260     * @return splitted items
    260261     */
    261262    public static String[] splitEscaped(char delimiter, String s) {

  • trunk/src/org/openstreetmap/josm/gui/tagging/presets/items/Roles.java

    r8863 r9231  
    6868        /**
    6969         * Return either argument, the highest possible value or the lowest allowed value
     70         * @param c count
     71         * @return the highest possible value or the lowest allowed value
     72         * @see #required
    7073         */
    7174        public long getValidCount(long c) {

  • trunk/src/org/openstreetmap/josm/gui/util/AdjustmentSynchronizer.java

    r8509 r9231  
    7272
    7373    /**
    74      * Sets whether adjustable participates in adjustment synchronization or not
     74     * Sets whether {@code adjustable} participates in adjustment synchronization or not
    7575     *
    7676     * @param adjustable the adjustable
     77     * @param isParticipating {@code true} if {@code adjustable} participates in adjustment synchronization
    7778     */
    7879    protected void setParticipatingInSynchronizedScrolling(Adjustable adjustable, boolean isParticipating) {

  • trunk/src/org/openstreetmap/josm/gui/util/GuiHelper.java

    r9223 r9231  
    6262    /**
    6363     * disable / enable a component and all its child components
     64     * @param root component
     65     * @param enabled enabled state
    6466     */
    6567    public static void setEnabledRec(Container root, boolean enabled) {

  • trunk/src/org/openstreetmap/josm/gui/util/TableHelper.java

    r8510 r9231  
    2020     * adjust the preferred width of column col to the maximum preferred width of the cells
    2121     * requires JTable.setAutoResizeMode(JTable.AUTO_RESIZE_OFF);
     22     * @param tbl table
     23     * @param col column index
     24     * @param maxColumnWidth maximum column width
    2225     */
    2326    public static void adjustColumnWidth(JTable tbl, int col, int maxColumnWidth) {

  • trunk/src/org/openstreetmap/josm/gui/widgets/AbstractTextComponentValidator.java

    r9059 r9231  
    9292     * Alternative constructor that allows to turn off the actionListener.
    9393     * This can be useful if the enter key stroke needs to be forwarded to the default button in a dialog.
     94     * @param tc text component
     95     * @param addActionListener {@code true} to add the action listener
    9496     */
    9597    public AbstractTextComponentValidator(JTextComponent tc, boolean addActionListener) {
    … …  
    9799    }
    98100
     101    /**
     102     * Constructs a new {@code AbstractTextComponentValidator}.
     103     * @param tc text component
     104     * @param addFocusListener {@code true} to add the focus listener
     105     * @param addDocumentListener {@code true} to add the document listener
     106     * @param addActionListener {@code true} to add the action listener
     107     */
    99108    public AbstractTextComponentValidator(JTextComponent tc, boolean addFocusListener, boolean addDocumentListener, boolean addActionListener) {
    100109        CheckParameterUtil.ensureParameterNotNull(tc, "tc");

  • trunk/src/org/openstreetmap/josm/gui/widgets/MultiSplitLayout.java

    r9074 r9231  
    9494     *
    9595     * #see setModel
     96     * @param model model
    9697     */
    9798    public MultiSplitLayout(Node model) {
    … …  
    196197     * Split and Leaf nodes.  Typically this property is set to false
    197198     * after the (MultiSplitPane) user has dragged a Divider.
     199     * @param floatingDividers boolean value
    198200     *
    199201     * @see #getFloatingDividers
    … …  
    690692        private final transient Node node;
    691693
     694        /**
     695         * Constructs a new {@code InvalidLayoutException}.
     696         * @param msg the detail message. The detail message is saved for later retrieval by the {@link #getMessage()} method.
     697         * @param node node
     698         */
    692699        public InvalidLayoutException(String msg, Node node) {
    693700            super(msg);
    … …  
    12341241
    12351242    /**
    1236      * A convenience method that converts a string to a
    1237      * MultiSplitLayout model (a tree of Nodes) using a
    1238      * a simple syntax.  Nodes are represented by
    1239      * parenthetical expressions whose first token
    1240      * is one of ROW/COLUMN/LEAF.  ROW and COLUMN specify
    1241      * horizontal and vertical Split nodes respectively,
    1242      * LEAF specifies a Leaf node.  A Leaf's name and
    1243      * weight can be specified with attributes,
     1243     * A convenience method that converts a string to a MultiSplitLayout model (a tree of Nodes) using a
     1244     * a simple syntax.  Nodes are represented by parenthetical expressions whose first token
     1245     * is one of ROW/COLUMN/LEAF.  ROW and COLUMN specify horizontal and vertical Split nodes respectively,
     1246     * LEAF specifies a Leaf node.  A Leaf's name and weight can be specified with attributes,
    12441247     * name=<i>myLeafName</i> weight=<i>myLeafWeight</i>.
    1245      * Similarly, a Split's weight can be specified with
    1246      * weight=<i>mySplitWeight</i>.
    1247      *
    1248      * <p> For example, the following expression generates
    1249      * a horizontal Split node with three children:
    1250      * the Leafs named left and right, and a Divider in
    1251      * between:
     1248     * Similarly, a Split's weight can be specified with weight=<i>mySplitWeight</i>.
     1249     *
     1250     * <p> For example, the following expression generates a horizontal Split node with three children:
     1251     * the Leafs named left and right, and a Divider in between:
    12521252     * <pre>
    12531253     * (ROW (LEAF name=left) (LEAF name=right weight=1.0))
    12541254     * </pre>
    12551255     *
    1256      * <p> Dividers should not be included in the string,
    1257      * they're added automatcially as needed.  Because
    1258      * Leaf nodes often only need to specify a name, one
    1259      * can specify a Leaf by just providing the name.
     1256     * <p> Dividers should not be included in the string, they're added automatcially as needed.  Because
     1257     * Leaf nodes often only need to specify a name, one can specify a Leaf by just providing the name.
    12601258     * The previous example can be written like this:
    12611259     * <pre>
    … …  
    12631261     * </pre>
    12641262     *
    1265      * <p>Here's a more complex example.  One row with
    1266      * three elements, the first and last of which are columns
     1263     * <p>Here's a more complex example.  One row with three elements, the first and last of which are columns
    12671264     * with two leaves each:
    12681265     * <pre>
    … …  
    12721269     * </pre>
    12731270     *
    1274      *
    1275      * <p> This syntax is not intended for archiving or
    1276      * configuration files .  It's just a convenience for
     1271     * <p> This syntax is not intended for archiving or configuration files .  It's just a convenience for
    12771272     * examples and tests.
     1273     * @param s model as string
    12781274     *
    12791275     * @return the Node root of a tree based on s.

  • trunk/src/org/openstreetmap/josm/gui/widgets/TextContextualPopupMenu.java

    r8840 r9231  
    8181     * A menu can only be attached to a single component.
    8282     * @param component The text component that will display the menu and handle its actions.
     83     * @param undoRedo {@code true} if undo/redo must be supported
    8384     * @return {@code this}
    8485     * @see #detach()
Note: See TracChangeset for help on using the changeset viewer.