1 /*******************************************************************************
\r
2 * Copyright (c) 2007- VTT Technical Research Centre of Finland.
\r
3 * All rights reserved. This program and the accompanying materials
\r
4 * are made available under the terms of the Eclipse Public License v1.0
\r
5 * which accompanies this distribution, and is available at
\r
6 * http://www.eclipse.org/legal/epl-v10.html
\r
9 * VTT Technical Research Centre of Finland - initial API and implementation
\r
10 *******************************************************************************/
\r
11 package org.simantics.modeling.ui.diagram;
\r
13 import java.awt.BasicStroke;
\r
14 import java.awt.Color;
\r
15 import java.awt.Font;
\r
16 import java.awt.FontMetrics;
\r
17 import java.awt.Graphics2D;
\r
18 import java.awt.Rectangle;
\r
19 import java.awt.Shape;
\r
20 import java.awt.geom.AffineTransform;
\r
21 import java.awt.geom.Path2D;
\r
22 import java.awt.geom.Point2D;
\r
23 import java.awt.geom.Rectangle2D;
\r
24 import java.util.Collection;
\r
25 import java.util.EnumSet;
\r
26 import java.util.Map;
\r
28 import javax.swing.table.TableModel;
\r
30 import org.simantics.g2d.diagram.IDiagram;
\r
31 import org.simantics.g2d.element.ElementClass;
\r
32 import org.simantics.g2d.element.ElementHints;
\r
33 import org.simantics.g2d.element.ElementUtils;
\r
34 import org.simantics.g2d.element.IElement;
\r
35 import org.simantics.g2d.element.SceneGraphNodeKey;
\r
36 import org.simantics.g2d.element.handler.ElementHandler;
\r
37 import org.simantics.g2d.element.handler.FillColor;
\r
38 import org.simantics.g2d.element.handler.InternalSize;
\r
39 import org.simantics.g2d.element.handler.LifeCycle;
\r
40 import org.simantics.g2d.element.handler.Move;
\r
41 import org.simantics.g2d.element.handler.Outline;
\r
42 import org.simantics.g2d.element.handler.Rotate;
\r
43 import org.simantics.g2d.element.handler.Scale;
\r
44 import org.simantics.g2d.element.handler.SceneGraph;
\r
45 import org.simantics.g2d.element.handler.StaticSymbol;
\r
46 import org.simantics.g2d.element.handler.Text;
\r
47 import org.simantics.g2d.element.handler.Transform;
\r
48 import org.simantics.g2d.element.handler.impl.BorderColorImpl;
\r
49 import org.simantics.g2d.element.handler.impl.FillColorImpl;
\r
50 import org.simantics.g2d.element.handler.impl.SimpleElementLayers;
\r
51 import org.simantics.g2d.element.handler.impl.StaticSymbolImpl;
\r
52 import org.simantics.g2d.element.handler.impl.TextEditorImpl;
\r
53 import org.simantics.g2d.element.handler.impl.TextImpl;
\r
54 import org.simantics.g2d.elementclass.MonitorHandler;
\r
55 import org.simantics.g2d.image.Image;
\r
56 import org.simantics.g2d.image.ProviderUtils;
\r
57 import org.simantics.g2d.image.impl.AbstractImage;
\r
58 import org.simantics.g2d.utils.Alignment;
\r
59 import org.simantics.scenegraph.Node;
\r
60 import org.simantics.scenegraph.g2d.G2DParentNode;
\r
61 import org.simantics.spreadsheet.Model;
\r
62 import org.simantics.utils.datastructures.cache.IFactory;
\r
63 import org.simantics.utils.datastructures.cache.IProvider;
\r
64 import org.simantics.utils.datastructures.cache.ProvisionException;
\r
65 import org.simantics.utils.datastructures.hints.IHintContext.Key;
\r
66 import org.simantics.utils.datastructures.hints.IHintContext.KeyOf;
\r
69 * @author Tuukka Lehtonen
\r
71 public class SheetClass {
\r
73 static final Font FONT = Font.decode("Helvetica 10");
\r
75 public static final Key KEY_MODEL = new KeyOf(Model.class, "MODEL");
\r
76 public static final Key KEY_TABLE_MODEL = new KeyOf(TableModel.class, "TABLE_MODEL");
\r
78 public static final Key KEY_MONITOR_RESOURCE_PATH = new KeyOf(Collection.class, "MONITOR_RESOURCE_PATH");
\r
79 public static final Key KEY_MONITOR_SUBSTITUTIONS = new KeyOf(Map.class, "MONITOR_SUBSTITUTIONS");
\r
80 public static final Key KEY_MONITOR_GC = new KeyOf(Graphics2D.class, "MONITOR_GC");
\r
81 public static final Key KEY_MONITOR_HEIGHT = new KeyOf(Double.class, "MONITOR_HEIGHT");
\r
82 public static final Key KEY_MONITOR_FONT_METRICS = new KeyOf(FontMetrics.class, "MONITOR_FONT_METRICS");
\r
83 public static final Key KEY_NUMBER_FORMAT = new KeyOf(String.class, "NUMBER_FORMAT");
\r
86 * If this hint is defined, the monitor will force its x-axis to match this
\r
87 * angle. If this hint doesn't exist, the monitor will not force x-axis
\r
90 public static final Key KEY_DIRECTION = new KeyOf(Double.class, "MONITOR_DIRECTION");
\r
92 public static final Key KEY_SG_NODE = new SceneGraphNodeKey(Node.class, "MONITOR_SG_NODE");
\r
94 final static BasicStroke STROKE = new BasicStroke(1.0f);
\r
96 public final static Alignment DEFAULT_HORIZONTAL_ALIGN = Alignment.CENTER;
\r
97 public final static Alignment DEFAULT_VERTICAL_ALIGN = Alignment.CENTER;
\r
98 public final static String DEFAULT_NUMBER_FORMAT = "0.0###";
\r
100 public final static Color DEFAULT_FILL_COLOR = new Color(224, 224, 224);
\r
101 public final static Color DEFAULT_BORDER_COLOR = Color.BLACK;
\r
103 public final static double DEFAULT_HORIZONTAL_MARGIN = 5.0;
\r
104 public final static double DEFAULT_VERTICAL_MARGIN = 2.5;
\r
106 static Alignment getHorizontalAlignment(IElement e) {
\r
107 return ElementUtils.getHintOrDefault(e, ElementHints.KEY_HORIZONTAL_ALIGN, DEFAULT_HORIZONTAL_ALIGN);
\r
110 static Alignment getVerticalAlignment(IElement e) {
\r
111 return ElementUtils.getHintOrDefault(e, ElementHints.KEY_VERTICAL_ALIGN, DEFAULT_VERTICAL_ALIGN);
\r
114 static String getNumberFormat(IElement e) {
\r
115 return ElementUtils.getHintOrDefault(e, KEY_NUMBER_FORMAT, DEFAULT_NUMBER_FORMAT);
\r
118 static void setNumberFormat(IElement e, String format) {
\r
119 ElementUtils.setOrRemoveHint(e, KEY_NUMBER_FORMAT, DEFAULT_NUMBER_FORMAT);
\r
122 static double getHorizontalMargin(IElement e) {
\r
123 return DEFAULT_HORIZONTAL_MARGIN;
\r
126 static double getVerticalMargin(IElement e) {
\r
127 return DEFAULT_VERTICAL_MARGIN;
\r
130 static Font getFont(IElement e) {
\r
131 return ElementUtils.getHintOrDefault(e, ElementHints.KEY_FONT, FONT);
\r
134 public static class MonitorHandlerImpl implements MonitorHandler {
\r
135 private static final long serialVersionUID = -4258875745321808416L;
\r
136 public static final MonitorHandler INSTANCE = new MonitorHandlerImpl();
\r
139 static class Initializer implements LifeCycle {
\r
140 private static final long serialVersionUID = 4404942036933073584L;
\r
142 IElement parentElement;
\r
143 Map<String, String> substitutions;
\r
144 Collection<Object> path;
\r
147 Initializer(IElement parentElement, Map<String, String> substitutions, Collection<Object> path, boolean hack) {
\r
148 this.parentElement = parentElement;
\r
149 this.substitutions = substitutions;
\r
155 public void onElementActivated(IDiagram d, IElement e) {
\r
161 Point2D parentPos = ElementUtils.getPos(parentElement);
\r
162 Point2D thisPos = ElementUtils.getPos(e);
\r
164 Move move = e.getElementClass().getSingleItem(Move.class);
\r
165 move.moveTo(e, thisPos.getX() - parentPos.getX(), thisPos.getY() - parentPos.getY());
\r
171 public void onElementCreated(IElement e) {
\r
172 if(parentElement != null) e.setHint(ElementHints.KEY_PARENT_ELEMENT, parentElement);
\r
173 if(substitutions != null) e.setHint(KEY_MONITOR_SUBSTITUTIONS, substitutions);
\r
174 if(path != null) e.setHint(KEY_MONITOR_RESOURCE_PATH, path);
\r
176 e.setHint(KEY_DIRECTION, 0.0);
\r
177 e.setHint(KEY_NUMBER_FORMAT, DEFAULT_NUMBER_FORMAT);
\r
178 //e.setHint(KEY_HORIZONTAL_ALIGN, Alignment.LEADING);
\r
179 //e.setHint(KEY_VERTICAL_ALIGN, Alignment.LEADING);
\r
182 public void onElementDeactivated(IDiagram d, IElement e) {
\r
185 public void onElementDestroyed(IElement e) {
\r
189 static String finalText(IElement e) {
\r
191 Text t = e.getElementClass().getAtMostOneItemOfClass(Text.class);
\r
193 String text = t.getText(e);
\r
194 if(text == null) return null;
\r
195 Map<String, String> substitutions = e.getHint(KEY_MONITOR_SUBSTITUTIONS);
\r
196 if(substitutions != null) {
\r
197 // TODO: slow as hell
\r
198 for(Map.Entry<String, String> entry : substitutions.entrySet()) {
\r
199 if (entry.getValue() != null) {
\r
200 text = text.replace(entry.getKey(), entry.getValue());
\r
202 text = text.replace(entry.getKey(), "<null>");
\r
210 public static void update(IElement e) {
\r
211 SheetSGNode node = e.getElementClass().getAtMostOneItemOfClass(SheetSGNode.class);
\r
215 public static void cleanup(IElement e) {
\r
216 SheetSGNode node = e.getElementClass().getAtMostOneItemOfClass(SheetSGNode.class);
\r
220 public static String editText(IElement e) {
\r
222 Text t = e.getElementClass().getAtMostOneItemOfClass(Text.class);
\r
224 String text = "#v1";
\r
225 if(text == null) return null;
\r
226 Map<String, String> substitutions = e.getHint(KEY_MONITOR_SUBSTITUTIONS);
\r
227 if(substitutions != null) {
\r
228 // TODO: slow as hell
\r
229 for(Map.Entry<String, String> entry : substitutions.entrySet()) {
\r
230 if (entry.getValue() != null) {
\r
231 text = text.replace(entry.getKey(), entry.getValue());
\r
233 text = text.replace(entry.getKey(), "<null>");
\r
241 static final Rectangle2D DEFAULT_BOX = new Rectangle2D.Double(0, 0, 0, 0);
\r
243 static Shape createMonitor(IElement e) {
\r
244 Alignment hAlign = getHorizontalAlignment(e);
\r
245 Alignment vAlign = getVerticalAlignment(e);
\r
246 double hMargin = getHorizontalMargin(e);
\r
247 double vMargin = getVerticalMargin(e);
\r
249 String text = finalText(e);
\r
251 return align(hMargin, vMargin, hAlign, vAlign, DEFAULT_BOX);
\r
254 Graphics2D g = e.getHint(KEY_MONITOR_GC);
\r
256 return align(hMargin, vMargin, hAlign, vAlign, DEFAULT_BOX);
\r
259 Font f = getFont(e);
\r
260 FontMetrics fm = g.getFontMetrics(f);
\r
261 Rectangle2D rect = fm.getStringBounds(text, g);
\r
263 return align(hMargin, vMargin, hAlign, vAlign, rect);
\r
266 static Shape align(double hMargin, double vMargin, Alignment hAlign, Alignment vAlign, Rectangle2D rect) {
\r
267 //System.out.println("align: " + hMargin + ", " + vMargin + ", " + hAlign + ", " + vAlign + ": " + rect);
\r
268 double tx = align(hMargin, hAlign, rect.getMinX(), rect.getMaxX());
\r
269 double ty = align(vMargin, vAlign, rect.getMinY(), rect.getMaxY());
\r
270 //System.out.println(" translate: " + tx + " " + ty);
\r
271 double nw = rect.getWidth() + 2*hMargin;
\r
272 double nh = rect.getHeight() + 2*vMargin;
\r
273 return makePath(tx + rect.getMinX(), ty + rect.getMinY(), nw, nh);
\r
276 static double align(double margin, Alignment align, double min, double max) {
\r
277 double s = max - min;
\r
282 return -s - 2 * margin - min;
\r
284 return -0.5 * s - margin - min;
\r
290 static Path2D makePath(double x, double y, double w, double h) {
\r
291 Path2D path = new Path2D.Double();
\r
293 path.lineTo(x+w, y);
\r
294 path.lineTo(x+w, y+h);
\r
295 path.lineTo(x, y+h);
\r
300 public static final Shape BOX_SHAPE = new Rectangle(-1, -1, 2, 2);
\r
302 public static class SheetSGNode implements SceneGraph, InternalSize, Outline {
\r
304 private static final long serialVersionUID = -5823585015844593347L;
\r
306 static final SheetSGNode INSTANCE = new SheetSGNode();
\r
309 public void init(final IElement e, final G2DParentNode parent) {
\r
310 // Create node if it doesn't exist yet
\r
311 SheetNode node = (SheetNode)e.getHint(KEY_SG_NODE);
\r
312 if(node == null || node.getBounds() == null || node.getParent() != parent) {
\r
313 node = parent.addNode(ElementUtils.generateNodeId(e), SheetNode.class);
\r
314 e.setHint(KEY_SG_NODE, node);
\r
315 Model model = e.getHint(KEY_MODEL);
\r
316 TableModel tableModel = e.getHint(KEY_TABLE_MODEL);
\r
317 node.init(model, tableModel);
\r
318 System.out.println(parent);
\r
319 node.setSize(500, 220);
\r
324 public void update(IElement e) {
\r
326 // String value = null;
\r
328 final Text t = e.getElementClass().getAtMostOneItemOfClass(Text.class);
\r
330 String text = finalText(e);
\r
332 // System.out.println("monitorclass text = " + text);
\r
334 // if(text != null) {
\r
335 // Map<String, String> substitutions = e.getHint(KEY_MONITOR_SUBSTITUTIONS);
\r
336 // for(Map.Entry<String, String> entry : substitutions.entrySet()) {
\r
337 // System.out.println("substitute " + entry.getKey() + " -> " + entry.getValue());
\r
338 // text.replace(entry.getKey(), entry.getValue());
\r
342 // if(substitutions != null) {
\r
343 // value = substitutions.get("#v1");
\r
344 // if(substitutions.containsKey("#u1")) {
\r
345 // value += substitutions.get("#u1");
\r
349 // SheetNode node = (SheetNode) e.getHint(KEY_SG_NODE);
\r
350 // if (node != null && text != null) {
\r
351 // node.setText(text);
\r
352 // Collection<?> path = e.getHint(KEY_MONITOR_RESOURCE_PATH);
\r
353 // if (path != null && !path.isEmpty()) {
\r
354 // node.setEditable(true);
\r
356 // node.setEditable(false);
\r
363 public void cleanup(IElement e) {
\r
364 SheetNode node = (SheetNode)e.removeHint(KEY_SG_NODE);
\r
370 public Rectangle2D getBounds(IElement e, Rectangle2D size) {
\r
371 Rectangle2D shape = new Rectangle2D.Double(0, 0, 0, 0);
\r
373 SheetNode node = (SheetNode)e.getHint(KEY_SG_NODE);
\r
374 if(node != null && node.getBounds() != null) {
\r
375 shape = node.getBounds().getBounds2D();
\r
378 if(size != null) size.setRect(shape);
\r
383 public Shape getElementShape(IElement e) {
\r
384 Shape shape = new Rectangle2D.Double(0, 0, 0, 0);
\r
386 SheetNode node = (SheetNode)e.getHint(KEY_SG_NODE);
\r
387 if(node != null && node.getBounds() != null) {
\r
388 shape = node.getBounds();
\r
396 public static class Transformer implements Transform, Move, Rotate, Scale {
\r
398 private static final long serialVersionUID = -3704887325602085677L;
\r
400 public static final Transformer INSTANCE = new Transformer(null);
\r
402 Double aspectRatio;
\r
404 public Transformer() {
\r
408 public Transformer(Double aspectRatio) {
\r
409 this.aspectRatio = aspectRatio;
\r
413 public Double getFixedAspectRatio(IElement e) {
\r
414 return aspectRatio;
\r
418 public Point2D getScale(IElement e) {
\r
419 AffineTransform at = e.getHint(ElementHints.KEY_TRANSFORM);
\r
420 return _getScale(at);
\r
424 public void setScale(IElement e, Point2D newScale) {
\r
425 // Doesn't work for monitors.
\r
426 Point2D oldScale = getScale(e);
\r
427 double sx = newScale.getX() / oldScale.getX();
\r
428 double sy = newScale.getY() / oldScale.getY();
\r
429 AffineTransform at = e.getHint(ElementHints.KEY_TRANSFORM);
\r
430 at = new AffineTransform(at);
\r
432 e.setHint(ElementHints.KEY_TRANSFORM, at);
\r
436 public Point2D getMaximumScale(IElement e) {
\r
441 public Point2D getMinimumScale(IElement e) {
\r
445 private static Point2D _getScale(AffineTransform at) {
\r
446 double m00 = at.getScaleX();
\r
447 double m11 = at.getScaleY();
\r
448 double m10 = at.getShearY();
\r
449 double m01 = at.getShearX();
\r
450 // Project unit vector to canvas
\r
451 double sx = Math.sqrt(m00 * m00 + m10 * m10);
\r
452 double sy = Math.sqrt(m01 * m01 + m11 * m11);
\r
453 return new Point2D.Double(sx, sy);
\r
457 public void rotate(IElement e, double theta, Point2D origin) {
\r
458 if (Double.isNaN(theta)) return;
\r
459 theta = Math.toDegrees(theta);
\r
460 Double angle = e.getHint(KEY_DIRECTION);
\r
461 double newAngle = angle != null ? angle+theta : theta;
\r
462 newAngle = Math.IEEEremainder(newAngle, 360.0);
\r
463 e.setHint(KEY_DIRECTION, newAngle);
\r
467 public double getAngle(IElement e) {
\r
468 Double angle = e.getHint(KEY_DIRECTION);
\r
469 return angle != null ? Math.toRadians(angle) : 0;
\r
473 public Point2D getPosition(IElement e) {
\r
474 AffineTransform at = e.getHint(ElementHints.KEY_TRANSFORM);
\r
475 Point2D p = new Point2D.Double(at.getTranslateX(), at.getTranslateY());
\r
480 public void moveTo(IElement e, double x, double y) {
\r
481 AffineTransform origAt = e.getHint(ElementHints.KEY_TRANSFORM);
\r
482 double oldX = origAt.getTranslateX();
\r
483 double oldY = origAt.getTranslateY();
\r
484 AffineTransform move = AffineTransform.getTranslateInstance(x-oldX, y-oldY);
\r
485 AffineTransform at2 = new AffineTransform(origAt);
\r
486 at2.preConcatenate(move);
\r
487 e.setHint(ElementHints.KEY_TRANSFORM, at2);
\r
491 public AffineTransform getTransform(IElement e) {
\r
492 AffineTransform at = e.getHint(ElementHints.KEY_TRANSFORM);
\r
494 IElement parentElement = e.getHint(ElementHints.KEY_PARENT_ELEMENT);
\r
495 if (parentElement == null)
\r
498 Transform parentTransform = parentElement.getElementClass().getSingleItem(Transform.class);
\r
499 assert(parentTransform!=null);
\r
501 AffineTransform result = (AffineTransform)at.clone();
\r
502 result.preConcatenate(parentTransform.getTransform(parentElement));
\r
508 public void setTransform(IElement e, AffineTransform at) {
\r
509 e.setHint(ElementHints.KEY_TRANSFORM, at.clone());
\r
513 // public void onElementActivated(IDiagram d, IElement e) {
\r
517 // public void onElementCreated(IElement e) {
\r
518 // e.setHint(ElementHints.KEY_TRANSFORM, new AffineTransform());
\r
522 // public void onElementDeactivated(IDiagram d, IElement e) {
\r
526 // public void onElementDestroyed(IElement e) {
\r
527 // List<SceneGraph> nodeHandlers = e.getElementClass().getItemsByClass(SceneGraph.class);
\r
528 // for(SceneGraph n : nodeHandlers) {
\r
529 // System.out.println("element gone:"+e);
\r
535 static class MonitorImageFactory implements IFactory<Image> {
\r
538 public Image get() throws ProvisionException {
\r
539 return new AbstractImage() {
\r
540 Shape path = align(DEFAULT_HORIZONTAL_MARGIN, DEFAULT_VERTICAL_MARGIN, DEFAULT_HORIZONTAL_ALIGN, DEFAULT_VERTICAL_ALIGN,
\r
541 new Rectangle2D.Double(0, 0, 50, 22));
\r
544 public Rectangle2D getBounds() {
\r
545 return path.getBounds2D();
\r
549 public EnumSet<Feature> getFeatures() {
\r
550 return EnumSet.of(Feature.Vector);
\r
554 public Shape getOutline() {
\r
559 public Node init(G2DParentNode parent) {
\r
560 SheetNode node = parent.getOrCreateNode(""+hashCode(), SheetNode.class);
\r
561 // node.setText("");
\r
562 // node.setSize(50, 22);
\r
563 node.setTransform(new AffineTransform());
\r
570 static final IProvider<Image> MONITOR_IMAGE =
\r
571 ProviderUtils.reference(
\r
572 ProviderUtils.cache(
\r
573 ProviderUtils.rasterize(
\r
574 new MonitorImageFactory()
\r
577 static final StaticSymbol MONITOR_SYMBOL = new StaticSymbolImpl( MONITOR_IMAGE.get() );
\r
579 static final FillColor FILL_COLOR = new FillColorImpl(DEFAULT_FILL_COLOR);
\r
581 public static final ElementClass MONITOR_CLASS =
\r
582 ElementClass.compile(
\r
583 MonitorHandlerImpl.INSTANCE,
\r
584 Transformer.INSTANCE,
\r
585 BorderColorImpl.BLACK,
\r
587 SheetSGNode.INSTANCE,
\r
589 TextEditorImpl.INSTANCE,
\r
590 SimpleElementLayers.INSTANCE,
\r
594 // staticScale{X,Y} define the scale of the static monitor image
\r
595 public static ElementClass create(IElement parentElement, Map<String, String> substitutions, Collection<Object> path, double staticScaleX, double staticScaleY, ElementHandler... extraHandlers) {
\r
596 // Bit of a hack to be able to define the scale
\r
597 IProvider<Image> staticMonitorSymbolProvider = ProviderUtils.reference(
\r
598 ProviderUtils.cache(
\r
601 new MonitorImageFactory())));
\r
602 StaticSymbol staticMonitorSymbol = new StaticSymbolImpl( staticMonitorSymbolProvider.get() );
\r
603 return ElementClass.compile(
\r
604 new Initializer(parentElement, substitutions, path, parentElement != null ? false : true),
\r
605 MonitorHandlerImpl.INSTANCE,
\r
606 Transformer.INSTANCE,
\r
607 BorderColorImpl.BLACK,
\r
609 SheetSGNode.INSTANCE,
\r
611 TextEditorImpl.INSTANCE,
\r
612 SimpleElementLayers.INSTANCE,
\r
613 staticMonitorSymbol
\r
614 ).newClassWith(extraHandlers);
\r