001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.gui.dialogs; 003 004import static org.openstreetmap.josm.gui.help.HelpUtil.ht; 005import static org.openstreetmap.josm.tools.I18n.tr; 006import static org.openstreetmap.josm.tools.I18n.trn; 007 008import java.awt.BorderLayout; 009import java.awt.Dimension; 010import java.awt.FlowLayout; 011import java.awt.event.ActionEvent; 012import java.awt.event.WindowAdapter; 013import java.awt.event.WindowEvent; 014import java.io.Serializable; 015import java.util.ArrayList; 016import java.util.Collection; 017import java.util.Comparator; 018import java.util.HashSet; 019import java.util.List; 020import java.util.Set; 021 022import javax.swing.AbstractAction; 023import javax.swing.JButton; 024import javax.swing.JDialog; 025import javax.swing.JPanel; 026import javax.swing.JScrollPane; 027import javax.swing.JTable; 028import javax.swing.event.TableModelEvent; 029import javax.swing.event.TableModelListener; 030import javax.swing.table.DefaultTableColumnModel; 031import javax.swing.table.DefaultTableModel; 032import javax.swing.table.TableColumn; 033 034import org.openstreetmap.josm.Main; 035import org.openstreetmap.josm.data.osm.DefaultNameFormatter; 036import org.openstreetmap.josm.data.osm.NameFormatter; 037import org.openstreetmap.josm.data.osm.OsmPrimitive; 038import org.openstreetmap.josm.data.osm.RelationToChildReference; 039import org.openstreetmap.josm.gui.PrimitiveRenderer; 040import org.openstreetmap.josm.gui.help.ContextSensitiveHelpAction; 041import org.openstreetmap.josm.gui.help.HelpUtil; 042import org.openstreetmap.josm.gui.util.GuiHelper; 043import org.openstreetmap.josm.gui.util.WindowGeometry; 044import org.openstreetmap.josm.gui.widgets.HtmlPanel; 045import org.openstreetmap.josm.tools.I18n; 046import org.openstreetmap.josm.tools.ImageProvider; 047 048/** 049 * This dialog is used to get a user confirmation that a collection of primitives can be removed 050 * from their parent relations. 051 * @since 2308 052 */ 053public class DeleteFromRelationConfirmationDialog extends JDialog implements TableModelListener { 054 /** the unique instance of this dialog */ 055 private static DeleteFromRelationConfirmationDialog instance; 056 057 /** 058 * Replies the unique instance of this dialog 059 * 060 * @return The unique instance of this dialog 061 */ 062 public static synchronized DeleteFromRelationConfirmationDialog getInstance() { 063 if (instance == null) { 064 instance = new DeleteFromRelationConfirmationDialog(); 065 } 066 return instance; 067 } 068 069 /** the data model */ 070 private RelationMemberTableModel model; 071 private final HtmlPanel htmlPanel = new HtmlPanel(); 072 private boolean canceled; 073 private final JButton btnOK = new JButton(new OKAction()); 074 075 protected JPanel buildRelationMemberTablePanel() { 076 JTable table = new JTable(model, new RelationMemberTableColumnModel()); 077 JPanel pnl = new JPanel(new BorderLayout()); 078 pnl.add(new JScrollPane(table)); 079 return pnl; 080 } 081 082 protected JPanel buildButtonPanel() { 083 JPanel pnl = new JPanel(new FlowLayout()); 084 pnl.add(btnOK); 085 btnOK.setFocusable(true); 086 pnl.add(new JButton(new CancelAction())); 087 pnl.add(new JButton(new ContextSensitiveHelpAction(ht("/Action/Delete#DeleteFromRelations")))); 088 return pnl; 089 } 090 091 protected final void build() { 092 model = new RelationMemberTableModel(); 093 model.addTableModelListener(this); 094 getContentPane().setLayout(new BorderLayout()); 095 getContentPane().add(htmlPanel, BorderLayout.NORTH); 096 getContentPane().add(buildRelationMemberTablePanel(), BorderLayout.CENTER); 097 getContentPane().add(buildButtonPanel(), BorderLayout.SOUTH); 098 099 HelpUtil.setHelpContext(this.getRootPane(), ht("/Action/Delete#DeleteFromRelations")); 100 101 addWindowListener(new WindowEventHandler()); 102 } 103 104 protected void updateMessage() { 105 int numObjectsToDelete = model.getNumObjectsToDelete(); 106 int numParentRelations = model.getNumParentRelations(); 107 final String msg1 = trn( 108 "Please confirm to remove <strong>{0} object</strong>.", 109 "Please confirm to remove <strong>{0} objects</strong>.", 110 numObjectsToDelete, numObjectsToDelete); 111 final String msg2 = trn( 112 "{0} relation is affected.", 113 "{0} relations are affected.", 114 numParentRelations, numParentRelations); 115 @I18n.QuirkyPluralString 116 final String msg = "<html>" + msg1 + ' ' + msg2 + "</html>"; 117 htmlPanel.getEditorPane().setText(msg); 118 invalidate(); 119 } 120 121 protected void updateTitle() { 122 int numObjectsToDelete = model.getNumObjectsToDelete(); 123 if (numObjectsToDelete > 0) { 124 setTitle(trn("Deleting {0} object", "Deleting {0} objects", numObjectsToDelete, numObjectsToDelete)); 125 } else { 126 setTitle(tr("Delete objects")); 127 } 128 } 129 130 /** 131 * Constructs a new {@code DeleteFromRelationConfirmationDialog}. 132 */ 133 public DeleteFromRelationConfirmationDialog() { 134 super(GuiHelper.getFrameForComponent(Main.parent), "", ModalityType.DOCUMENT_MODAL); 135 build(); 136 } 137 138 /** 139 * Replies the data model used in this dialog 140 * 141 * @return the data model 142 */ 143 public RelationMemberTableModel getModel() { 144 return model; 145 } 146 147 /** 148 * Replies true if the dialog was canceled 149 * 150 * @return true if the dialog was canceled 151 */ 152 public boolean isCanceled() { 153 return canceled; 154 } 155 156 protected void setCanceled(boolean canceled) { 157 this.canceled = canceled; 158 } 159 160 @Override 161 public void setVisible(boolean visible) { 162 if (visible) { 163 new WindowGeometry( 164 getClass().getName() + ".geometry", 165 WindowGeometry.centerInWindow( 166 Main.parent, 167 new Dimension(400, 200) 168 ) 169 ).applySafe(this); 170 setCanceled(false); 171 } else if (isShowing()) { // Avoid IllegalComponentStateException like in #8775 172 new WindowGeometry(this).remember(getClass().getName() + ".geometry"); 173 } 174 super.setVisible(visible); 175 } 176 177 @Override 178 public void tableChanged(TableModelEvent e) { 179 updateMessage(); 180 updateTitle(); 181 } 182 183 /** 184 * The table model which manages the list of relation-to-child references 185 */ 186 public static class RelationMemberTableModel extends DefaultTableModel { 187 private static class RelationToChildReferenceComparator implements Comparator<RelationToChildReference>, Serializable { 188 @Override 189 public int compare(RelationToChildReference o1, RelationToChildReference o2) { 190 NameFormatter nf = DefaultNameFormatter.getInstance(); 191 int cmp = o1.getChild().getDisplayName(nf).compareTo(o2.getChild().getDisplayName(nf)); 192 if (cmp != 0) return cmp; 193 cmp = o1.getParent().getDisplayName(nf).compareTo(o2.getParent().getDisplayName(nf)); 194 if (cmp != 0) return cmp; 195 return Integer.compare(o1.getPosition(), o2.getPosition()); 196 } 197 } 198 199 private final transient List<RelationToChildReference> data; 200 201 /** 202 * Constructs a new {@code RelationMemberTableModel}. 203 */ 204 public RelationMemberTableModel() { 205 data = new ArrayList<>(); 206 } 207 208 @Override 209 public int getRowCount() { 210 if (data == null) return 0; 211 return data.size(); 212 } 213 214 /** 215 * Sets the data that should be displayed in the list. 216 * @param references A list of references to display 217 */ 218 public void populate(Collection<RelationToChildReference> references) { 219 data.clear(); 220 if (references != null) { 221 data.addAll(references); 222 } 223 data.sort(new RelationToChildReferenceComparator()); 224 fireTableDataChanged(); 225 } 226 227 /** 228 * Gets the list of children that are currently displayed. 229 * @return The children. 230 */ 231 public Set<OsmPrimitive> getObjectsToDelete() { 232 Set<OsmPrimitive> ret = new HashSet<>(); 233 for (RelationToChildReference ref: data) { 234 ret.add(ref.getChild()); 235 } 236 return ret; 237 } 238 239 /** 240 * Gets the number of elements {@link #getObjectsToDelete()} would return. 241 * @return That number. 242 */ 243 public int getNumObjectsToDelete() { 244 return getObjectsToDelete().size(); 245 } 246 247 /** 248 * Gets the set of parent relations 249 * @return All parent relations of the references 250 */ 251 public Set<OsmPrimitive> getParentRelations() { 252 Set<OsmPrimitive> ret = new HashSet<>(); 253 for (RelationToChildReference ref: data) { 254 ret.add(ref.getParent()); 255 } 256 return ret; 257 } 258 259 /** 260 * Gets the number of elements {@link #getParentRelations()} would return. 261 * @return That number. 262 */ 263 public int getNumParentRelations() { 264 return getParentRelations().size(); 265 } 266 267 @Override 268 public Object getValueAt(int rowIndex, int columnIndex) { 269 if (data == null) return null; 270 RelationToChildReference ref = data.get(rowIndex); 271 switch(columnIndex) { 272 case 0: return ref.getChild(); 273 case 1: return ref.getParent(); 274 case 2: return ref.getPosition()+1; 275 case 3: return ref.getRole(); 276 default: 277 assert false : "Illegal column index"; 278 } 279 return null; 280 } 281 282 @Override 283 public boolean isCellEditable(int row, int column) { 284 return false; 285 } 286 } 287 288 private static class RelationMemberTableColumnModel extends DefaultTableColumnModel { 289 290 protected final void createColumns() { 291 292 // column 0 - To Delete 293 TableColumn col = new TableColumn(0); 294 col.setHeaderValue(tr("To delete")); 295 col.setResizable(true); 296 col.setWidth(100); 297 col.setPreferredWidth(100); 298 col.setCellRenderer(new PrimitiveRenderer()); 299 addColumn(col); 300 301 // column 0 - From Relation 302 col = new TableColumn(1); 303 col.setHeaderValue(tr("From Relation")); 304 col.setResizable(true); 305 col.setWidth(100); 306 col.setPreferredWidth(100); 307 col.setCellRenderer(new PrimitiveRenderer()); 308 addColumn(col); 309 310 // column 1 - Pos. 311 col = new TableColumn(2); 312 col.setHeaderValue(tr("Pos.")); 313 col.setResizable(true); 314 col.setWidth(30); 315 col.setPreferredWidth(30); 316 addColumn(col); 317 318 // column 2 - Role 319 col = new TableColumn(3); 320 col.setHeaderValue(tr("Role")); 321 col.setResizable(true); 322 col.setWidth(50); 323 col.setPreferredWidth(50); 324 addColumn(col); 325 } 326 327 RelationMemberTableColumnModel() { 328 createColumns(); 329 } 330 } 331 332 class OKAction extends AbstractAction { 333 OKAction() { 334 putValue(NAME, tr("OK")); 335 new ImageProvider("ok").getResource().attachImageIcon(this); 336 putValue(SHORT_DESCRIPTION, tr("Click to close the dialog and remove the object from the relations")); 337 } 338 339 @Override 340 public void actionPerformed(ActionEvent e) { 341 setCanceled(false); 342 setVisible(false); 343 } 344 } 345 346 class CancelAction extends AbstractAction { 347 CancelAction() { 348 putValue(NAME, tr("Cancel")); 349 new ImageProvider("cancel").getResource().attachImageIcon(this); 350 putValue(SHORT_DESCRIPTION, tr("Click to close the dialog and to abort deleting the objects")); 351 } 352 353 @Override 354 public void actionPerformed(ActionEvent e) { 355 setCanceled(true); 356 setVisible(false); 357 } 358 } 359 360 class WindowEventHandler extends WindowAdapter { 361 362 @Override 363 public void windowClosing(WindowEvent e) { 364 setCanceled(true); 365 } 366 367 @Override 368 public void windowOpened(WindowEvent e) { 369 btnOK.requestFocusInWindow(); 370 } 371 } 372}