Index: /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/AdvancedPreference.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/AdvancedPreference.java (revision 6766) +++ /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/AdvancedPreference.java (revision 6767) @@ -48,4 +48,7 @@ import org.openstreetmap.josm.tools.GBC; +/** + * Advanced preferences, allowing to set preference entries directly. + */ public final class AdvancedPreference extends DefaultTabPreferenceSetting { Index: /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/ExportProfileAction.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/ExportProfileAction.java (revision 6766) +++ /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/ExportProfileAction.java (revision 6767) @@ -29,4 +29,7 @@ private final Preferences prefs; + /** + * Constructs a new {@code ExportProfileAction}. + */ public ExportProfileAction(Preferences prefs, String schemaKey, String prefPattern) { super(tr("Save {0} profile", tr(schemaKey))); @@ -35,5 +38,5 @@ this.schemaKey = schemaKey; } - + @Override public void actionPerformed(ActionEvent ae) { @@ -54,8 +57,8 @@ CustomConfigurator.exportPreferencesKeysToFile(f.getAbsolutePath(), false, keys); } - + private File askUserForCustomSettingsFile() { String title = tr("Choose profile file"); - + FileFilter filter = new FileFilter() { @Override @@ -76,5 +79,5 @@ } return sel; - } + } return null; } Index: /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/ListEditor.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/ListEditor.java (revision 6766) +++ /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/ListEditor.java (revision 6767) @@ -25,4 +25,7 @@ import org.openstreetmap.josm.tools.WindowGeometry; +/** + * Editor for List preference entries. + */ public class ListEditor extends ExtendedDialog { @@ -32,4 +35,5 @@ /** * Constructs a new {@code ListEditor}. + * @param gui The parent component */ public ListEditor(final JComponent gui, PrefEntry entry, ListSetting setting) { Index: /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/ListListEditor.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/ListListEditor.java (revision 6766) +++ /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/ListListEditor.java (revision 6767) @@ -33,4 +33,7 @@ import org.openstreetmap.josm.tools.WindowGeometry; +/** + * Editor for List of Lists preference entries. + */ public class ListListEditor extends ExtendedDialog { @@ -45,4 +48,8 @@ ListTableModel tableModel; + /** + * Constructs a new {@code ListListEditor}. + * @param gui The parent component + */ public ListListEditor(final JComponent gui, PrefEntry entry, ListListSetting setting) { super(gui, tr("Change list of lists setting"), new String[] {tr("OK"), tr("Cancel")}); @@ -60,4 +67,8 @@ } + /** + * Returns the data. + * @return the preference data + */ public List> getData() { return data; @@ -220,4 +231,3 @@ } } - } Index: /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/MapListEditor.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/MapListEditor.java (revision 6766) +++ /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/MapListEditor.java (revision 6767) @@ -37,4 +37,7 @@ import org.openstreetmap.josm.tools.WindowGeometry; +/** + * Editor for List of Maps preference entries. + */ public class MapListEditor extends ExtendedDialog { @@ -74,4 +77,8 @@ } + /** + * Returns the data. + * @return the preference data + */ public List> getData() { List> data = new ArrayList>(); Index: /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/PrefEntry.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/PrefEntry.java (revision 6766) +++ /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/PrefEntry.java (revision 6767) @@ -6,6 +6,6 @@ /** - * Class to store single preference line for the table - * @since 6021 : extracted from AdvancedPreference class + * Class to store single preference line for the table. + * @since 6021 */ public class PrefEntry implements Comparable { @@ -16,4 +16,11 @@ private boolean changed; + /** + * Constructs a new {@code PrefEntry}. + * @param key The preference key + * @param value The preference value + * @param defaultValue The preference default value + * @param isDefault determines if the current value is the default value + */ public PrefEntry(String key, Preferences.Setting value, Preferences.Setting defaultValue, boolean isDefault) { CheckParameterUtil.ensureParameterNotNull(key); @@ -26,16 +33,32 @@ } + /** + * Returns the preference key. + * @return the preference key + */ public String getKey() { return key; } + /** + * Returns the preference value. + * @return the preference value + */ public Preferences.Setting getValue() { return value; } + /** + * Returns the preference default value. + * @return the preference default value + */ public Preferences.Setting getDefaultValue() { return defaultValue; } + /** + * Sets the preference value. + * @param value the preference value + */ public void setValue(Preferences.Setting value) { this.value = value; @@ -44,16 +67,30 @@ } + /** + * Determines if the current value is the default value. + * @return {@code true} if the current value is the default value, {@code false} otherwise + */ public boolean isDefault() { return isDefault; } + /** + * Determines if this preference entry has been modified. + * @return {@code true} if this preference entry has been modified, {@code false} otherwise + */ public boolean isChanged() { return changed; } + /** + * Marks this preference entry as modified. + */ public void markAsChanged() { changed = true; } + /** + * Resets this preference entry to default state. + */ public void reset() { value = defaultValue; Index: /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/PreferencesTable.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/PreferencesTable.java (revision 6766) +++ /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/PreferencesTable.java (revision 6767) @@ -34,6 +34,6 @@ /** - * Component for editing list of preferences as a table - * @since 6021 : extracted from AdvancedPreference class + * Component for editing list of preferences as a table. + * @since 6021 */ public class PreferencesTable extends JTable { @@ -41,4 +41,8 @@ private final List displayData; + /** + * Constructs a new {@code PreferencesTable}. + * @param displayData The list of preferences entries to display + */ public PreferencesTable(List displayData) { this.displayData = displayData; @@ -48,6 +52,6 @@ getColumnModel().getColumn(1).setCellRenderer(new SettingCellRenderer()); getColumnModel().getColumn(1).setCellEditor(new SettingCellEditor()); - - addMouseListener(new MouseAdapter(){ + + addMouseListener(new MouseAdapter() { @Override public void mouseClicked(MouseEvent e) { if (e.getClickCount() == 2) { @@ -57,5 +61,5 @@ }); } - + /** * This method should be called when displayed data was changed form external code @@ -64,6 +68,5 @@ model.fireTableDataChanged(); } - - + /** * The list of currently selected rows @@ -78,5 +81,5 @@ return entries; } - + /** * Call this to edit selected row in preferences table @@ -138,5 +141,5 @@ return false; } - + /** * Add new preference to the table @@ -228,7 +231,7 @@ } } - if (ok) - return pe; - else + if (ok) + return pe; + else return null; } @@ -254,5 +257,5 @@ fireDataChanged(); } - + private class AllSettingsTableModel extends DefaultTableModel { @@ -299,5 +302,5 @@ marktr("Advanced Background: NonDefault"), new Color(255,255,200)); - + @Override public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) { @@ -308,5 +311,5 @@ Object val = setting.getValue(); String display = val != null ? val.toString() : "<"+tr("unset")+">"; - + JLabel label = (JLabel)super.getTableCellRendererComponent(table, display, isSelected, hasFocus, row, column); Index: /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/StringEditor.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/StringEditor.java (revision 6766) +++ /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/StringEditor.java (revision 6767) @@ -5,6 +5,6 @@ import java.awt.GridBagLayout; + import javax.swing.JComponent; - import javax.swing.JLabel; import javax.swing.JPanel; @@ -15,4 +15,7 @@ import org.openstreetmap.josm.tools.GBC; +/** + * Editor for String preference entries. + */ public class StringEditor extends ExtendedDialog { @@ -20,4 +23,8 @@ JosmTextField tvalue; + /** + * Constructs a new {@code StringEditor}. + * @param gui The parent component + */ public StringEditor(final JComponent gui, PrefEntry entry, StringSetting setting) { super(gui, tr("Change string setting"), new String[] {tr("OK"), tr("Cancel")}); @@ -27,4 +34,8 @@ } + /** + * Returns the data. + * @return the preference data + */ public String getData() { return tvalue.getText(); Index: /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/package-info.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/package-info.java (revision 6767) +++ /trunk/src/org/openstreetmap/josm/gui/preferences/advanced/package-info.java (revision 6767) @@ -0,0 +1,6 @@ +// License: GPL. For details, see LICENSE file. + +/** + * Provides classes for handling advanced preferences. + */ +package org.openstreetmap.josm.gui.preferences.advanced;