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.NameFormatter; 036import org.openstreetmap.josm.data.osm.OsmPrimitive; 037import org.openstreetmap.josm.data.osm.RelationToChildReference; 038import org.openstreetmap.josm.gui.DefaultNameFormatter; 039import org.openstreetmap.josm.gui.OsmPrimitivRenderer; 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.widgets.HtmlPanel; 044import org.openstreetmap.josm.tools.I18n; 045import org.openstreetmap.josm.tools.ImageProvider; 046import org.openstreetmap.josm.tools.WindowGeometry; 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 */ 187 public static class RelationMemberTableModel extends DefaultTableModel { 188 private static class RelationToChildReferenceComparator implements Comparator<RelationToChildReference>, Serializable { 189 @Override 190 public int compare(RelationToChildReference o1, RelationToChildReference o2) { 191 NameFormatter nf = DefaultNameFormatter.getInstance(); 192 int cmp = o1.getChild().getDisplayName(nf).compareTo(o2.getChild().getDisplayName(nf)); 193 if (cmp != 0) return cmp; 194 cmp = o1.getParent().getDisplayName(nf).compareTo(o2.getParent().getDisplayName(nf)); 195 if (cmp != 0) return cmp; 196 return Integer.compare(o1.getPosition(), o2.getPosition()); 197 } 198 } 199 200 private final transient List<RelationToChildReference> data; 201 202 /** 203 * Constructs a new {@code RelationMemberTableModel}. 204 */ 205 public RelationMemberTableModel() { 206 data = new ArrayList<>(); 207 } 208 209 @Override 210 public int getRowCount() { 211 if (data == null) return 0; 212 return data.size(); 213 } 214 215 public void populate(Collection<RelationToChildReference> references) { 216 data.clear(); 217 if (references != null) { 218 data.addAll(references); 219 } 220 data.sort(new RelationToChildReferenceComparator()); 221 fireTableDataChanged(); 222 } 223 224 public Set<OsmPrimitive> getObjectsToDelete() { 225 Set<OsmPrimitive> ret = new HashSet<>(); 226 for (RelationToChildReference ref: data) { 227 ret.add(ref.getChild()); 228 } 229 return ret; 230 } 231 232 public int getNumObjectsToDelete() { 233 return getObjectsToDelete().size(); 234 } 235 236 public Set<OsmPrimitive> getParentRelations() { 237 Set<OsmPrimitive> ret = new HashSet<>(); 238 for (RelationToChildReference ref: data) { 239 ret.add(ref.getParent()); 240 } 241 return ret; 242 } 243 244 public int getNumParentRelations() { 245 return getParentRelations().size(); 246 } 247 248 @Override 249 public Object getValueAt(int rowIndex, int columnIndex) { 250 if (data == null) return null; 251 RelationToChildReference ref = data.get(rowIndex); 252 switch(columnIndex) { 253 case 0: return ref.getChild(); 254 case 1: return ref.getParent(); 255 case 2: return ref.getPosition()+1; 256 case 3: return ref.getRole(); 257 default: 258 assert false : "Illegal column index"; 259 } 260 return null; 261 } 262 263 @Override 264 public boolean isCellEditable(int row, int column) { 265 return false; 266 } 267 } 268 269 private static class RelationMemberTableColumnModel extends DefaultTableColumnModel { 270 271 protected final void createColumns() { 272 273 // column 0 - To Delete 274 TableColumn col = new TableColumn(0); 275 col.setHeaderValue(tr("To delete")); 276 col.setResizable(true); 277 col.setWidth(100); 278 col.setPreferredWidth(100); 279 col.setCellRenderer(new OsmPrimitivRenderer()); 280 addColumn(col); 281 282 // column 0 - From Relation 283 col = new TableColumn(1); 284 col.setHeaderValue(tr("From Relation")); 285 col.setResizable(true); 286 col.setWidth(100); 287 col.setPreferredWidth(100); 288 col.setCellRenderer(new OsmPrimitivRenderer()); 289 addColumn(col); 290 291 // column 1 - Pos. 292 col = new TableColumn(2); 293 col.setHeaderValue(tr("Pos.")); 294 col.setResizable(true); 295 col.setWidth(30); 296 col.setPreferredWidth(30); 297 addColumn(col); 298 299 // column 2 - Role 300 col = new TableColumn(3); 301 col.setHeaderValue(tr("Role")); 302 col.setResizable(true); 303 col.setWidth(50); 304 col.setPreferredWidth(50); 305 addColumn(col); 306 } 307 308 RelationMemberTableColumnModel() { 309 createColumns(); 310 } 311 } 312 313 class OKAction extends AbstractAction { 314 OKAction() { 315 putValue(NAME, tr("OK")); 316 new ImageProvider("ok").getResource().attachImageIcon(this); 317 putValue(SHORT_DESCRIPTION, tr("Click to close the dialog and remove the object from the relations")); 318 } 319 320 @Override 321 public void actionPerformed(ActionEvent e) { 322 setCanceled(false); 323 setVisible(false); 324 } 325 } 326 327 class CancelAction extends AbstractAction { 328 CancelAction() { 329 putValue(NAME, tr("Cancel")); 330 new ImageProvider("cancel").getResource().attachImageIcon(this); 331 putValue(SHORT_DESCRIPTION, tr("Click to close the dialog and to abort deleting the objects")); 332 } 333 334 @Override 335 public void actionPerformed(ActionEvent e) { 336 setCanceled(true); 337 setVisible(false); 338 } 339 } 340 341 class WindowEventHandler extends WindowAdapter { 342 343 @Override 344 public void windowClosing(WindowEvent e) { 345 setCanceled(true); 346 } 347 348 @Override 349 public void windowOpened(WindowEvent e) { 350 btnOK.requestFocusInWindow(); 351 } 352 } 353}