ccc7b57141966b3b4fab855c0c47fcfa7539ff06
[idea/community.git] / plugins / ui-designer / src / com / intellij / uiDesigner / radComponents / RadAbstractGridLayoutManager.java
1 /*
2  * Copyright 2000-2009 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package com.intellij.uiDesigner.radComponents;
18
19 import com.intellij.openapi.actionSystem.ActionGroup;
20 import com.intellij.uiDesigner.GridChangeUtil;
21 import com.intellij.uiDesigner.UIFormXmlConstants;
22 import com.intellij.uiDesigner.XmlWriter;
23 import com.intellij.uiDesigner.FormEditingUtil;
24 import com.intellij.uiDesigner.core.GridConstraints;
25 import com.intellij.uiDesigner.designSurface.*;
26 import com.intellij.util.IncorrectOperationException;
27 import org.jetbrains.annotations.NotNull;
28 import org.jetbrains.annotations.Nullable;
29
30 import java.awt.*;
31 import java.beans.PropertyChangeEvent;
32 import java.beans.PropertyChangeListener;
33 import java.util.ArrayList;
34 import java.util.HashMap;
35 import java.util.List;
36 import java.util.Map;
37
38 /**
39  * @author yole
40  */
41 public abstract class RadAbstractGridLayoutManager extends RadLayoutManager {
42   protected final Map<RadComponent, MyPropertyChangeListener> myListenerMap = new HashMap<RadComponent, MyPropertyChangeListener>();
43
44   @Override
45   public boolean isGrid() {
46     return true;
47   }
48
49   public abstract int getGridRowCount(RadContainer container);
50   public abstract int getGridColumnCount(RadContainer container);
51
52   public int getGridCellCount(RadContainer container, boolean isRow) {
53     return isRow ? getGridRowCount(container) : getGridColumnCount(container);
54   }
55
56   public int getGridRowAt(RadContainer container, int y) {
57     return getGridCellAt(container, y, true);
58   }
59
60   public int getGridColumnAt(RadContainer container, int x) {
61     return getGridCellAt(container, x, false);
62   }
63
64   private int getGridCellAt(final RadContainer container, final int coord, final boolean isRow) {
65     int[] coords = getGridCellCoords(container, isRow);
66     int[] sizes = getGridCellSizes(container, isRow);
67     for (int i = 0; i < coords.length; i++) {
68       if (coords[i] <= coord && coord <= coords[i] + sizes[i]) {
69         return i;
70       }
71     }
72     return -1;
73   }
74
75   public abstract int[] getHorizontalGridLines(RadContainer container);
76   public abstract int[] getVerticalGridLines(RadContainer container);
77   public abstract int[] getGridCellCoords(RadContainer container, boolean isRow);
78   public abstract int[] getGridCellSizes(RadContainer container, boolean isRow);
79
80   @Nullable
81   public CustomPropertiesPanel getRowColumnPropertiesPanel(RadContainer container, boolean isRow, int[] selectedIndices) {
82     return null;
83   }
84
85   @Nullable
86   public static RadComponent getComponentAtGrid(RadContainer container, final int row, final int column) {
87     // If the target cell is not empty does not allow drop.
88     for(int i=0; i<container.getComponentCount(); i++){
89       final RadComponent component = container.getComponent(i);
90       if (component.isDragging()) {
91         continue;
92       }
93       final GridConstraints constraints=component.getConstraints();
94       if(
95         constraints.getRow() <= row && row < constraints.getRow()+constraints.getRowSpan() &&
96         constraints.getColumn() <= column && column < constraints.getColumn()+constraints.getColSpan()
97       ){
98         return component;
99       }
100     }
101     return null;
102   }
103
104   public int getGridLineNear(RadContainer container, boolean isRow, Point pnt, int epsilon) {
105     int coord = isRow ? pnt.y : pnt.x;
106     int[] gridLines = isRow ? getHorizontalGridLines(container) : getVerticalGridLines(container);
107     for(int col = 1; col <gridLines.length; col++) {
108       if (coord < gridLines [col]) {
109         if (coord - gridLines [col-1] < epsilon) {
110           return col-1;
111         }
112         if (gridLines [col] - coord < epsilon) {
113           return col;
114         }
115         return -1;
116       }
117     }
118     if (coord - gridLines [gridLines.length-1] < epsilon) {
119       return gridLines.length-1;
120     }
121     return -1;
122   }
123
124   public Rectangle getGridCellRangeRect(RadContainer container, int startRow, int startCol, int endRow, int endCol) {
125     int[] xs = getGridCellCoords(container, false);
126     int[] ys = getGridCellCoords(container, true);
127     int[] widths = getGridCellSizes(container, false);
128     int[] heights = getGridCellSizes(container, true);
129     return new Rectangle(xs[startCol],
130                          ys[startRow],
131                          xs[endCol] + widths[endCol] - xs[startCol],
132                          ys[endRow] + heights[endRow] - ys[startRow]);
133   }
134
135   public boolean canCellGrow(RadContainer container, boolean isRow, int i) {
136     return false;
137   }
138
139   @Nullable
140   public ActionGroup getCaptionActions() {
141     return null;
142   }
143
144   public void paintCaptionDecoration(final RadContainer container, final boolean isRow, final int i, final Graphics2D g,
145                                      final Rectangle rc) {
146     if (canCellGrow(container, isRow, i)) {
147       drawGrowMarker(isRow, g, rc);
148     }
149   }
150
151   /**
152    * @return the number of inserted rows or columns
153    */
154   public int insertGridCells(final RadContainer grid, final int cellIndex, final boolean isRow, final boolean isBefore, final boolean grow) {
155     GridChangeUtil.insertRowOrColumn(grid, cellIndex, isRow, isBefore);
156     return 1;
157   }
158
159   public void copyGridCells(RadContainer source, final RadContainer destination, final boolean isRow, int cellIndex, int cellCount, int targetIndex) {
160     for(int i=0; i< cellCount; i++) {
161       insertGridCells(destination, cellIndex, isRow, false, false);
162     }
163   }
164
165   /**
166    * @return the number of deleted rows or columns
167    */
168   public int deleteGridCells(final RadContainer grid, final int cellIndex, final boolean isRow) {
169     GridChangeUtil.deleteCell(grid, cellIndex, isRow);
170     return 1;
171   }
172
173   public void processCellsMoved(final RadContainer container, final boolean isRow, final int[] cells, final int targetCell) {
174     GridChangeUtil.moveCells(container, isRow, cells, targetCell);
175   }
176
177   public int getGapCellCount() {
178     return 0;
179   }
180
181   public int getGapCellSize(final RadContainer container, boolean isRow) {
182     return 0;
183   }
184
185   public boolean isGapCell(RadContainer grid, boolean isRow, int cellIndex) {
186     return false;
187   }
188
189   public int getCellIndexBase() {
190     return 0;
191   }
192
193   public boolean canResizeCells() {
194     return true;
195   }
196
197   @Nullable
198   public String getCellResizeTooltip(RadContainer container, boolean isRow, int cell, int newSize) {
199     return null;
200   }
201   public void processCellResized(RadContainer container, final boolean isRow, final int cell, final int newSize) {
202   }
203
204   public abstract void copyGridSection(final RadContainer source, final RadContainer destination, final Rectangle rc);
205
206   public LayoutManager copyLayout(LayoutManager layout, int rowDelta, int columnDelta) {
207     return layout;
208   }
209
210   /**
211    * Returns true if the dimensions of the grid in the container are defined by the coordinates of the components
212    * in the grid (and therefore it must not be validated that an inserted component fits the grid bounds).
213    */
214   public boolean isGridDefinedByComponents() {
215     return false;
216   }
217
218   protected static void writeGridConstraints(final XmlWriter writer, final RadComponent child) {
219     // Constraints in Grid layout
220     writer.startElement("grid");
221     try {
222       final GridConstraints constraints = child.getConstraints();
223       writer.addAttribute("row",constraints.getRow());
224       writer.addAttribute("column",constraints.getColumn());
225       writer.addAttribute("row-span",constraints.getRowSpan());
226       writer.addAttribute("col-span",constraints.getColSpan());
227       writer.addAttribute("vsize-policy",constraints.getVSizePolicy());
228       writer.addAttribute("hsize-policy",constraints.getHSizePolicy());
229       writer.addAttribute("anchor",constraints.getAnchor());
230       writer.addAttribute("fill",constraints.getFill());
231       writer.addAttribute(UIFormXmlConstants.ATTRIBUTE_INDENT, constraints.getIndent());
232       writer.addAttribute(UIFormXmlConstants.ATTRIBUTE_USE_PARENT_LAYOUT, constraints.isUseParentLayout());
233
234       // preferred size
235       writer.writeDimension(constraints.myMinimumSize,"minimum-size");
236       writer.writeDimension(constraints.myPreferredSize,"preferred-size");
237       writer.writeDimension(constraints.myMaximumSize,"maximum-size");
238     } finally {
239       writer.endElement(); // grid
240     }
241   }
242
243
244   @Override @NotNull
245   public ComponentDropLocation getDropLocation(RadContainer container, @Nullable final Point location) {
246     if (container.getGridRowCount() == 1 && container.getGridColumnCount() == 1 &&
247         getComponentAtGrid(container, 0, 0) == null) {
248       final Rectangle rc = getGridCellRangeRect(container, 0, 0, 0, 0);
249       if (location == null) {
250         return new FirstComponentInsertLocation(container, rc, 0, 0);
251       }
252       return new FirstComponentInsertLocation(container, location, rc);
253     }
254
255     if (location == null) {
256       if (getComponentAtGrid(container, 0, 0) == null) {
257         return new GridDropLocation(container, 0, 0);
258       }
259       return new GridInsertLocation(container, getLastNonSpacerRow(container), 0, GridInsertMode.RowAfter);
260     }
261
262     int[] xs = getGridCellCoords(container, false);
263     int[] ys = getGridCellCoords(container, true);
264     int[] widths = getGridCellSizes(container, false);
265     int[] heights = getGridCellSizes(container, true);
266
267     int[] horzGridLines = getHorizontalGridLines(container);
268     int[] vertGridLines = getVerticalGridLines(container);
269
270     int row=ys.length-1;
271     int col=xs.length-1;
272     for(int i=0; i<xs.length; i++) {
273       if (location.x < xs[i] + widths[i]) {
274         col=i;
275         break;
276       }
277     }
278     for(int i=0; i<ys.length; i++) {
279       if (location.getY() < ys [i]+heights [i]) {
280         row=i;
281         break;
282       }
283     }
284
285     GridInsertMode mode = null;
286
287     int EPSILON = 4;
288     int dy = (int)(location.getY() - ys [row]);
289     if (dy < EPSILON) {
290       mode = GridInsertMode.RowBefore;
291     }
292     else if (heights [row] - dy < EPSILON) {
293       mode = GridInsertMode.RowAfter;
294     }
295
296     int dx = location.x - xs[col];
297     if (dx < EPSILON) {
298       mode = GridInsertMode.ColumnBefore;
299     }
300     else if (widths [col] - dx < EPSILON) {
301       mode = GridInsertMode.ColumnAfter;
302     }
303
304     final int cellWidth = vertGridLines[col + 1] - vertGridLines[col];
305     final int cellHeight = horzGridLines[row + 1] - horzGridLines[row];
306     if (mode == null) {
307       RadComponent component = getComponentAtGrid(container, row, col);
308       if (component != null) {
309         Rectangle rc = component.getBounds();
310         rc.translate(-xs [col], -ys [row]);
311
312         int right = rc.x + rc.width + GridInsertLocation.INSERT_RECT_MIN_SIZE;
313         int bottom = rc.y + rc.height + GridInsertLocation.INSERT_RECT_MIN_SIZE;
314
315         if (dy < rc.y - GridInsertLocation.INSERT_RECT_MIN_SIZE) {
316           mode = GridInsertMode.RowBefore;
317         }
318         else if (dy > bottom && dy < cellHeight) {
319           mode = GridInsertMode.RowAfter;
320         }
321         if (dx < rc.x - GridInsertLocation.INSERT_RECT_MIN_SIZE) {
322           mode = GridInsertMode.ColumnBefore;
323         }
324         else if (dx > right && dx < cellWidth) {
325           mode = GridInsertMode.ColumnAfter;
326         }
327       }
328     }
329
330     if (mode != null) {
331       return new GridInsertLocation(container, row, col, mode).normalize();
332     }
333     if (getComponentAtGrid(container, row, col) instanceof RadVSpacer ||
334         getComponentAtGrid(container, row, col) instanceof RadHSpacer) {
335       return new GridReplaceDropLocation(container, row, col);
336     }
337     return new GridDropLocation(container, row, col);
338   }
339
340   private int getLastNonSpacerRow(final RadContainer container) {
341     int lastRow = getGridRowCount(container)-1;
342     for(int col=0; col<getGridColumnCount(container); col++) {
343       RadComponent c = getComponentAtGrid(container, lastRow, col);
344       if (c != null && !(c instanceof RadHSpacer) && !(c instanceof RadVSpacer)) {
345         return lastRow;
346       }
347     }
348     return lastRow-1;
349   }
350
351   protected static void drawGrowMarker(final boolean isRow, final Graphics2D g2d, final Rectangle rc) {
352     g2d.setColor(Color.BLACK);
353     if (!isRow) {
354       int maxX = (int) rc.getMaxX();
355       int midY = (int) rc.getCenterY()+3;
356       final int xStart = Math.max(maxX - 10, rc.x + 2);
357       final int xEnd = maxX - 2;
358       g2d.drawLine(xStart, midY, xEnd, midY);
359       g2d.drawLine(xStart, midY, xStart+2, midY-2);
360       g2d.drawLine(xStart, midY, xStart+2, midY+2);
361       g2d.drawLine(xEnd, midY, xEnd-2, midY-2);
362       g2d.drawLine(xEnd, midY, xEnd-2, midY+2);
363     }
364     else {
365       int maxY = (int) rc.getMaxY();
366       int midX = (int) rc.getCenterX()+3;
367       final int yStart = Math.max(maxY - 10, rc.y + 2);
368       final int yEnd = maxY - 2;
369       g2d.drawLine(midX, yStart, midX, yEnd);
370       g2d.drawLine(midX, yStart, midX-2, yStart+2);
371       g2d.drawLine(midX, yStart, midX+2, yStart+2);
372       g2d.drawLine(midX, yEnd, midX-2, yEnd-2);
373       g2d.drawLine(midX, yEnd, midX+2, yEnd-2);
374     }
375   }
376
377   @Override
378   public void changeContainerLayout(RadContainer container) throws IncorrectOperationException {
379     if (container.getLayoutManager().isGrid()) {
380       RadAbstractGridLayoutManager grid = container.getGridLayoutManager();
381       List<Boolean> canRowsGrow = collectCanCellsGrow(grid, container, true);
382       List<Boolean> canColumnsGrow = collectCanCellsGrow(grid, container, false);
383       List<RadComponent> contents = collectComponents(container);
384
385       changeLayoutFromGrid(container, contents, canRowsGrow, canColumnsGrow);
386
387       int oldGapMultiplier = grid.getGapCellCount()+1;
388       int gapMultiplier = getGapCellCount()+1;
389       for(RadComponent c: contents) {
390         GridConstraints gc = c.getConstraints();
391         gc.setRow(gc.getRow() * gapMultiplier / oldGapMultiplier);
392         gc.setColumn(gc.getColumn() * gapMultiplier / oldGapMultiplier);
393         container.addComponent(c);
394       }
395     }
396     else if (container.getLayoutManager().isIndexed()) {
397       List<RadComponent> components = collectComponents(container);
398       changeLayoutFromIndexed(container, components);
399
400       int gapMultiplier = getGapCellCount()+1;
401       for(int i=0; i<components.size(); i++) {
402         GridConstraints gc = components.get(i).getConstraints();
403         gc.setRow(0);
404         gc.setColumn(i*gapMultiplier);
405         gc.setRowSpan(1);
406         gc.setColSpan(1);
407         container.addComponent(components.get(i));
408       }
409     }
410     else if (container.getComponentCount() == 0) {
411       container.setLayoutManager(this);
412     }
413     else {
414       throw new IncorrectOperationException("Cannot change from " + container.getLayout() + " to grid layout");
415     }
416   }
417
418   protected void changeLayoutFromGrid(final RadContainer container, final List<RadComponent> contents, final List<Boolean> canRowsGrow,
419                                     final List<Boolean> canColumnsGrow) {
420     container.setLayoutManager(this);
421   }
422
423   protected void changeLayoutFromIndexed(final RadContainer container, final List<RadComponent> components) {
424     container.setLayoutManager(this);
425   }
426
427   private static List<Boolean> collectCanCellsGrow(final RadAbstractGridLayoutManager grid, final RadContainer container, final boolean isRow) {
428     List<Boolean> result = new ArrayList<Boolean>();
429     for(int i=0; i<grid.getGridCellCount(container, isRow); i++) {
430       if (!grid.isGapCell(container, isRow, i)) {
431         result.add(grid.canCellGrow(container, isRow, i));
432       }
433     }
434     return result;
435   }
436
437   private static List<RadComponent> collectComponents(final RadContainer container) {
438     List<RadComponent> contents = new ArrayList<RadComponent>();
439     for(int i=container.getComponentCount()-1; i >= 0; i--) {
440       final RadComponent component = container.getComponent(i);
441       if (!(component instanceof RadHSpacer) && !(component instanceof RadVSpacer)) {
442         contents.add(0, component);
443       }
444       container.removeComponent(component);
445     }
446     return contents;
447   }
448
449   public boolean canMoveComponent(RadComponent c, int rowDelta, int colDelta, final int rowSpanDelta, final int colSpanDelta) {
450     final int newRow = getNewRow(c, rowDelta);
451     final int newCol = getNewColumn(c, colDelta);
452     final int newRowSpan = getNewRowSpan(c, rowSpanDelta);
453     final int newColSpan = getNewColSpan(c, colSpanDelta);
454     if (newRow < 0 || newCol < 0 || newRowSpan < 1 || newColSpan < 1 ||
455         newRow + newRowSpan > c.getParent().getGridRowCount() ||
456         newCol + newColSpan > c.getParent().getGridColumnCount()) {
457       return false;
458     }
459     c.setDragging(true);
460     final RadComponent overlap = c.getParent().findComponentInRect(newRow, newCol, newRowSpan, newColSpan);
461     c.setDragging(false);
462     if (overlap != null) {
463       return false;
464     }
465     return true;
466   }
467
468   private static int getNewRow(final RadComponent c, final int rowDelta) {
469     return FormEditingUtil.adjustForGap(c.getParent(), c.getConstraints().getRow() + rowDelta, true, rowDelta);
470   }
471
472   private static int getNewColumn(final RadComponent c, final int colDelta) {
473     return FormEditingUtil.adjustForGap(c.getParent(), c.getConstraints().getColumn() + colDelta, false, colDelta);
474   }
475
476   private static int getNewRowSpan(final RadComponent c, final int rowSpanDelta) {
477     int gapCount = c.getParent().getGridLayoutManager().getGapCellCount();
478     return c.getConstraints().getRowSpan() + rowSpanDelta * (gapCount+1);
479   }
480
481   private static int getNewColSpan(final RadComponent c, final int colSpanDelta) {
482     int gapCount = c.getParent().getGridLayoutManager().getGapCellCount();
483     return c.getConstraints().getColSpan() + colSpanDelta * (gapCount+1);
484   }
485
486   @Override
487   public void moveComponent(RadComponent c, int rowDelta, int colDelta, final int rowSpanDelta, final int colSpanDelta) {
488     GridConstraints constraints = c.getConstraints();
489     GridConstraints oldConstraints = (GridConstraints)constraints.clone();
490     constraints.setRow(getNewRow(c, rowDelta));
491     constraints.setColumn(getNewColumn(c, colDelta));
492     constraints.setRowSpan(getNewRowSpan(c, rowSpanDelta));
493     constraints.setColSpan(getNewColSpan(c, colSpanDelta));
494     c.fireConstraintsChanged(oldConstraints);
495   }
496
497   public int getMinCellCount() {
498     return 1;
499   }
500
501   @Override
502   public void addComponentToContainer(RadContainer container, RadComponent component, int index) {
503     MyPropertyChangeListener listener = new MyPropertyChangeListener(component);
504     myListenerMap.put(component, listener);
505     component.addPropertyChangeListener(listener);
506   }
507
508   @Override
509   public void removeComponentFromContainer(final RadContainer container, final RadComponent component) {
510     final MyPropertyChangeListener listener = myListenerMap.get(component);
511     if (listener != null) {
512       component.removePropertyChangeListener(listener);
513       myListenerMap.remove(component);
514     }
515     super.removeComponentFromContainer(container, component);
516   }
517
518   protected void updateConstraints(RadComponent component) {
519     component.getParent().revalidate();
520   }
521
522   private class MyPropertyChangeListener implements PropertyChangeListener {
523     private final RadComponent myComponent;
524
525     public MyPropertyChangeListener(final RadComponent component) {
526       myComponent = component;
527     }
528
529     public void propertyChange(PropertyChangeEvent evt) {
530       if (evt.getPropertyName().equals(RadComponent.PROP_CONSTRAINTS)) {
531         updateConstraints(myComponent);
532       }
533     }
534   }
535 }