some methods annotated by MagicConstant annotations
[idea/community.git] / plugins / ui-designer / src / com / intellij / uiDesigner / designSurface / Painter.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 package com.intellij.uiDesigner.designSurface;
17
18 import com.intellij.ui.LightColors;
19 import com.intellij.uiDesigner.FormEditingUtil;
20 import com.intellij.uiDesigner.SwingProperties;
21 import com.intellij.uiDesigner.core.GridLayoutManager;
22 import com.intellij.uiDesigner.lw.IProperty;
23 import com.intellij.uiDesigner.lw.StringDescriptor;
24 import com.intellij.uiDesigner.radComponents.*;
25 import com.intellij.uiDesigner.shared.BorderType;
26 import org.intellij.lang.annotations.JdkConstants;
27 import org.jetbrains.annotations.NotNull;
28
29 import javax.swing.*;
30 import java.awt.*;
31 import java.awt.geom.Rectangle2D;
32 import java.util.ArrayList;
33 import java.util.List;
34
35 /**
36  * @author Anton Katilin
37  * @author Vladimir Kondratyev
38  */
39 public final class Painter {
40   /**
41    * This color is used to paint decoration of non selected components
42    */
43   private static final Color NON_SELECTED_BOUNDARY_COLOR = new Color(114, 126, 143);
44   /**
45    * This color is used to paint decoration of selected components
46    */
47   private static final Color SELECTED_BOUNDARY_COLOR = new Color(8, 8, 108);
48
49   private static final Color HIGHLIGHTED_BOUNDARY_COLOR = Color.RED;
50
51   /**
52    * This color is used to paint grid cell for selected container
53    */
54   static final Color SELECTED_GRID_COLOR = new Color(47, 67, 96);
55   /**
56    * This color is used to paint grid cell for non selected container
57    */
58   static final Color NON_SELECTED_GRID_COLOR = new Color(130, 140, 155);
59
60   public final static int WEST_MASK = 1;
61   public final static int EAST_MASK = 2;
62   public final static int NORTH_MASK = 4;
63   public final static int SOUTH_MASK = 8;
64   private final static int R = 2;
65   private final static int GAP = R;
66   private static final int NW = 0;
67   private static final int N = 1;
68   private static final int NE = 2;
69   private static final int E = 3;
70   private static final int SE = 4;
71   private static final int S = 5;
72   private static final int SW = 6;
73   private static final int W = 7;
74
75   private Painter() {
76   }
77
78   public static void paintComponentDecoration(final GuiEditor editor, final RadComponent component, final Graphics g){
79     // Collect selected components and paint decoration for non selected components
80     final ArrayList<RadComponent> selection = new ArrayList<RadComponent>();
81     final Rectangle layeredPaneRect = editor.getLayeredPane().getVisibleRect();
82     FormEditingUtil.iterate(
83       component,
84       new FormEditingUtil.ComponentVisitor<RadComponent>() {
85         public boolean visit(final RadComponent component) {
86           if(!component.getDelegee().isShowing()){ // Skip invisible components
87             return true;
88           }
89           final Shape oldClip = g.getClip();
90           final RadContainer parent = component.getParent();
91           if(parent != null){
92             final Point p = SwingUtilities.convertPoint(component.getDelegee(), 0, 0, editor.getLayeredPane());
93             final Rectangle visibleRect = layeredPaneRect.intersection(new Rectangle(p.x, p.y, parent.getWidth(), parent.getHeight()));
94             g.setClip(visibleRect);
95           }
96           if(component.isSelected()){ // we will paint selection later
97             selection.add(component);
98           }
99           else{
100             paintComponentBoundsImpl(editor, component, g);
101           }
102           paintGridOutline(editor, component, g);
103           if(parent != null){
104             g.setClip(oldClip);
105           }
106           return true;
107         }
108       }
109     );
110
111     // Let's paint decoration for selected components
112     for(int i = selection.size() - 1; i >= 0; i--){
113       final Shape oldClip = g.getClip();
114       final RadComponent c = selection.get(i);
115       final RadContainer parent = c.getParent();
116       if(parent != null){
117         final Point p = SwingUtilities.convertPoint(c.getDelegee(), 0, 0, editor.getLayeredPane());
118         final Rectangle visibleRect = layeredPaneRect.intersection(new Rectangle(p.x, p.y, parent.getWidth(), parent.getHeight()));
119         g.setClip(visibleRect);
120       }
121       paintComponentBoundsImpl(editor, c, g);
122       if(parent != null){
123         g.setClip(oldClip);
124       }
125     }
126   }
127
128   /**
129    * Paints container border. For grids the method also paints vertical and
130    * horizontal lines that indicate bounds of the rows and columns.
131    * Method does nothing if the <code>component</code> is not an instance
132    * of <code>RadContainer</code>.
133    */
134   private static void paintComponentBoundsImpl(final GuiEditor editor, @NotNull final RadComponent component, final Graphics g){
135     if (!(component instanceof RadContainer) && !(component instanceof RadNestedForm) && !component.isDragBorder()){
136       return;
137     }
138
139     boolean highlightBoundaries = (getDesignTimeInsets(component) > 2);
140
141     if (component instanceof RadContainer && !component.isDragBorder()) {
142       RadContainer container = (RadContainer) component;
143       if (!highlightBoundaries && (container.getBorderTitle() != null || container.getBorderType() != BorderType.NONE)) {
144         return;
145       }
146     }
147     final Point point = SwingUtilities.convertPoint(
148       component.getDelegee(),
149       0,
150       0,
151       editor.getRootContainer().getDelegee()
152     );
153     g.translate(point.x, point.y);
154     try{
155       if (component.isDragBorder()) {
156         Graphics2D g2d = (Graphics2D) g;
157         g2d.setColor(LightColors.YELLOW);
158         g2d.setStroke(new BasicStroke(2.0f));
159         g2d.translate(1, 1);
160       }
161       else if (highlightBoundaries) {
162         g.setColor(HIGHLIGHTED_BOUNDARY_COLOR);
163       }
164       else if (component.isSelected()) {
165         g.setColor(SELECTED_BOUNDARY_COLOR);
166       }
167       else {
168         g.setColor(NON_SELECTED_BOUNDARY_COLOR);
169       }
170       g.drawRect(0, 0, component.getWidth() - 1, component.getHeight() - 1);
171       if (component.isDragBorder()) {
172         g.translate(-1, -1);
173       }
174     }finally{
175       g.translate(-point.x, -point.y);
176     }
177   }
178
179   private static int getDesignTimeInsets(RadComponent component) {
180     while(component != null) {
181       Integer designTimeInsets = (Integer)component.getDelegee().getClientProperty(GridLayoutManager.DESIGN_TIME_INSETS);
182       if (designTimeInsets != null) {
183         return designTimeInsets.intValue();
184       }
185       component = component.getParent();
186     }
187     return 0;
188   }
189
190   /**
191    * This method paints grid bounds for "grid" containers
192    */
193   public static void paintGridOutline(final GuiEditor editor, @NotNull final RadComponent component, final Graphics g){
194     if (!editor.isShowGrid()) {
195       return;
196     }
197     if (!(component instanceof RadContainer)){
198       return;
199     }
200     final RadContainer container = (RadContainer)component;
201     if(!container.getLayoutManager().isGrid()){
202       return;
203     }
204
205     // performance: don't paint grid outline in drag layer
206     Container parent = component.getDelegee().getParent();
207     while (parent != null) {
208       if (parent == editor.getDragLayer()) {
209         return;
210       }
211       parent = parent.getParent();
212     }
213
214     final Point point = SwingUtilities.convertPoint(
215       component.getDelegee(),
216       0,
217       0,
218       editor.getRootContainer().getDelegee()
219     );
220     g.translate(point.x, point.y);
221     try{
222       // Paint grid
223       if (container.getWidth() > 0 && container.getHeight() > 0) {
224         Image gridImage = CachedGridImage.getGridImage(container);
225         g.drawImage(gridImage, 0, 0, null);
226       }
227     }finally{
228       g.translate(-point.x, -point.y);
229     }
230   }
231
232   /**
233    * Paints selection for the specified <code>component</code>.
234    */
235   public static void paintSelectionDecoration(@NotNull RadComponent component, Graphics g,
236                                               boolean focused){
237     if (component.isSelected()) {
238       if (focused) {
239         g.setColor(Color.BLUE);
240       }
241       else {
242         g.setColor(Color.GRAY);
243       }
244       final Point[] points = getPoints(component.getWidth(), component.getHeight());
245       for (final Point point : points) {
246         g.fillRect(point.x - R, point.y - R, 2 * R + 1, 2 * R + 1);
247       }
248     }
249   }
250
251   /**
252    * @param x in component's coord system
253    * @param y in component's coord system
254    */
255   public static int getResizeMask(@NotNull final RadComponent component, final int x, final int y) {
256     if (component.getParent() == null || !component.isSelected()) {
257       return 0;
258     }
259
260     // only components in XY can be resized...
261     /*
262     if (!component.getParent().isXY()) {
263       return 0;
264     }
265     */
266
267     final int width=component.getWidth();
268     final int height=component.getHeight();
269
270     final Point[] points = getPoints(width, height);
271
272     if (isInside(x, y, points[SE])) {
273       return EAST_MASK | SOUTH_MASK;
274     }
275     else if (isInside(x,y,points[NW])) {
276       return WEST_MASK | NORTH_MASK;
277     }
278     else if(isInside(x,y,points[N])){
279       return NORTH_MASK;
280     }
281     else if(isInside(x,y,points[NE])){
282       return EAST_MASK | NORTH_MASK;
283     }
284     else if (isInside(x, y, points[W])){
285       return WEST_MASK;
286     }
287     else if (isInside(x, y, points[E])){
288       return EAST_MASK;
289     }
290     else if (isInside(x, y, points[SW])){
291       return WEST_MASK | SOUTH_MASK;
292     }
293     else if (isInside(x, y, points[S])){
294       return SOUTH_MASK;
295     }
296     else{
297       return 0;
298     }
299   }
300
301   private static boolean isInside(final int x, final int y, final Point r) {
302     return x >= r.x - R && x <= r.x + R && y >= r.y - R && y <= r.y + R;
303   }
304
305   @JdkConstants.CursorType
306   public static int getResizeCursor(final int resizeMask){
307     if (resizeMask == (WEST_MASK | NORTH_MASK)) {
308       return Cursor.NW_RESIZE_CURSOR;
309     }
310     else if (resizeMask == NORTH_MASK) {
311       return Cursor.N_RESIZE_CURSOR;
312     }
313     else if (resizeMask == (EAST_MASK | NORTH_MASK)) {
314       return Cursor.NE_RESIZE_CURSOR;
315     }
316     else if (resizeMask == WEST_MASK) {
317       return Cursor.W_RESIZE_CURSOR;
318     }
319     else if (resizeMask == EAST_MASK) {
320       return Cursor.E_RESIZE_CURSOR;
321     }
322     else if (resizeMask == (WEST_MASK | SOUTH_MASK)) {
323       return Cursor.SW_RESIZE_CURSOR;
324     }
325     else if (resizeMask == SOUTH_MASK) {
326       return Cursor.S_RESIZE_CURSOR;
327     }
328     else if (resizeMask == (EAST_MASK | SOUTH_MASK)) {
329       return Cursor.SE_RESIZE_CURSOR;
330     }
331     else {
332       throw new IllegalArgumentException("unknown resizeMask: " + resizeMask);
333     }
334   }
335
336   public static Point[] getPoints(final int width, final int height) {
337     final Point[] points = new Point[8];
338
339     points[NW] = new Point(GAP, GAP); // NW
340     points[N] = new Point(width / 2, GAP); // N
341     points[NE] = new Point(width - GAP - 1, GAP); // NE
342     points[E] = new Point(width - GAP - 1, height / 2); // E
343     points[SE] = new Point(width - GAP - 1, height - GAP - 1); // SE
344     points[S] = new Point(width / 2, height - GAP - 1); // S
345     points[SW] = new Point(GAP, height - GAP - 1); // SW
346     points[W] = new Point(GAP, height / 2); // W
347
348     return points;
349   }
350
351   public static void paintButtonGroupLines(RadRootContainer rootContainer, RadButtonGroup group, Graphics g) {
352     List<RadComponent> components = rootContainer.getGroupContents(group);
353     if (components.size() < 2) return;
354     Rectangle[] allBounds = new Rectangle[components.size()];
355     int lastTop = -1;
356     int minLeft = Integer.MAX_VALUE;
357     for(int i=0; i<components.size(); i++) {
358       final Rectangle rc = SwingUtilities.convertRectangle(
359         components.get(i).getParent().getDelegee(),
360         components.get(i).getBounds(),
361         rootContainer.getDelegee()
362       );
363       allBounds [i] = rc;
364
365       minLeft = Math.min(minLeft, rc.x);
366       if (i == 0) {
367         lastTop = rc.y;
368       }
369       else if (lastTop != rc.y) {
370         lastTop = Integer.MIN_VALUE;
371       }
372     }
373
374     Graphics2D g2d = (Graphics2D) g;
375     Stroke oldStroke = g2d.getStroke();
376     g2d.setStroke(new BasicStroke(2.0f));
377     g2d.setColor(new Color(104, 107, 130));
378     if (lastTop != Integer.MIN_VALUE) {
379       // all items in group have same Y
380       int left = Integer.MAX_VALUE;
381       int right = Integer.MIN_VALUE;
382       for(Rectangle rc: allBounds) {
383         final int midX = (int)rc.getCenterX();
384         left = Math.min(left, midX);
385         right = Math.max(right, midX);
386         g2d.drawLine(midX, lastTop-8, midX, lastTop);
387       }
388       g2d.drawLine(left, lastTop-8, right, lastTop-8);
389     }
390     else {
391       int top = Integer.MAX_VALUE;
392       int bottom = Integer.MIN_VALUE;
393       for(Rectangle rc: allBounds) {
394         final int midY = (int)rc.getCenterY();
395         top = Math.min(top, midY);
396         bottom = Math.max(bottom, midY);
397         g2d.drawLine(minLeft-8, midY, rc.x, midY);
398       }
399       g2d.drawLine(minLeft-8, top, minLeft-8, bottom);
400     }
401     g2d.setStroke(oldStroke);
402   }
403
404   public static void paintComponentTag(final RadComponent component, final Graphics g) {
405     if (component instanceof RadContainer) return;
406     for(IProperty prop: component.getModifiedProperties()) {
407       if (prop.getName().equals(SwingProperties.TEXT)) {
408         final Object desc = prop.getPropertyValue(component);
409         if (!(desc instanceof StringDescriptor) || ((StringDescriptor) desc).getValue() == null ||
410             ((StringDescriptor) desc).getValue().length() > 0) {
411           return;
412         }
413       }
414       else if (prop.getName().equals(SwingProperties.MODEL)) {
415         // don't paint tags on non-empty lists
416         final Object value = prop.getPropertyValue(component);
417         if (value instanceof String[] && ((String[]) value).length > 0) {
418           return;
419         }
420       }
421     }
422
423     Rectangle bounds = component.getDelegee().getBounds();
424     if (bounds.width > 100 && bounds.height > 40) {
425       StringBuilder tagBuilder = new StringBuilder();
426       if (component.getBinding() != null) {
427         tagBuilder.append(component.getBinding()).append(':');
428       }
429       String className = component.getComponentClassName();
430       int pos = className.lastIndexOf('.');
431       if (pos >= 0) {
432         tagBuilder.append(className.substring(pos+1));
433       }
434       else {
435         tagBuilder.append(className);
436       }
437       final Rectangle2D stringBounds = g.getFontMetrics().getStringBounds(tagBuilder.toString(), g);
438       Graphics2D g2d = (Graphics2D) g;
439       g2d.setColor(Color.BLUE);
440       g2d.fillRect(0, 0, (int) stringBounds.getWidth(), (int) stringBounds.getHeight());
441       g2d.setColor(Color.WHITE);
442       g.drawString(tagBuilder.toString(), 0, g.getFontMetrics().getAscent());
443     }
444   }
445 }