8fddb49c53e5488bc4e7bf267c65b8d91a2ceabc
[scilab.git] / scilab / modules / gui / src / java / org / scilab / modules / gui / bridge / label / SwingScilabLabel.java
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2007 - INRIA - Vincent COUVERT
4  * Copyright (C) 2007 - INRIA - Marouane BEN JELLOUL
5  * Copyright (C) 2010-2011 - DIGITEO - Vincent COUVERT
6  *
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at
11  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
12  *
13  */
14 package org.scilab.modules.gui.bridge.label;
15
16 import static org.scilab.modules.graphic_objects.graphicObject.GraphicObjectProperties.__GO_UI_ICON__;
17
18 import java.awt.Color;
19 import java.awt.Dimension;
20 import java.awt.Font;
21 import java.awt.GridBagConstraints;
22 import java.awt.GridBagLayout;
23 import java.io.File;
24 import java.io.IOException;
25
26 import javax.imageio.ImageIO;
27 import javax.swing.BorderFactory;
28 import javax.swing.ImageIcon;
29 import javax.swing.JComponent;
30 import javax.swing.JEditorPane;
31 import javax.swing.JLabel;
32 import javax.swing.JPanel;
33 import javax.swing.JScrollPane;
34 import javax.swing.JTextPane;
35 import javax.swing.SwingConstants;
36 import javax.swing.UIManager;
37 import javax.swing.border.Border;
38 import javax.swing.event.HyperlinkEvent;
39 import javax.swing.event.HyperlinkListener;
40 import javax.swing.text.html.HTMLDocument;
41 import javax.swing.text.html.StyleSheet;
42
43 import org.scilab.modules.commons.gui.FindIconHelper;
44 import org.scilab.modules.console.utils.ScilabSpecialTextUtilities;
45 import org.scilab.modules.graphic_objects.graphicController.GraphicController;
46 import org.scilab.modules.gui.SwingViewObject;
47 import org.scilab.modules.gui.SwingViewWidget;
48 import org.scilab.modules.gui.events.callback.CommonCallBack;
49 import org.scilab.modules.gui.label.SimpleLabel;
50 import org.scilab.modules.gui.menubar.MenuBar;
51 import org.scilab.modules.gui.textbox.TextBox;
52 import org.scilab.modules.gui.toolbar.ToolBar;
53 import org.scilab.modules.gui.utils.Position;
54 import org.scilab.modules.gui.utils.PositionConverter;
55 import org.scilab.modules.gui.utils.ScilabAlignment;
56 import org.scilab.modules.gui.utils.ScilabRelief;
57 import org.scilab.modules.gui.utils.ScilabSwingUtilities;
58 import org.scilab.modules.gui.utils.Size;
59 import org.scilab.modules.gui.utils.WebBrowser;
60
61 /**
62  * Swing implementation for Scilab Labels in GUIs
63  * @author Vincent COUVERT
64  * @author Marouane BEN JELLOUL
65  */
66 public class SwingScilabLabel extends JScrollPane implements SwingViewObject, SimpleLabel {
67
68     private static final long serialVersionUID = 7177323379068859441L;
69
70     private Integer uid;
71
72     private JComponent label = new JLabel();
73
74     private Border defaultBorder = null;
75
76     private boolean isJLabel = true;
77
78     private String horizontalAlignment = "left"; /* Horizontal alignment property */
79
80     private String verticalAlignment = "middle"; /* Vertical alignment property */
81
82     private final JPanel alignmentPanel = new JPanel(); /* Used for alignment */
83
84     private final GridBagLayout alignmentLayout = new GridBagLayout();
85
86     private String labelText = ""; /* Used to save user given text */
87
88     private static HyperlinkListener urlOpener = new HyperlinkListener() {
89         public void hyperlinkUpdate(HyperlinkEvent event) {
90             if (event.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
91                 WebBrowser.openUrl(event.getURL(), event.getDescription());
92             }
93         }
94     };
95
96     /**
97      * Constructor
98      */
99     public SwingScilabLabel() {
100         super();
101         alignmentPanel.setLayout(alignmentLayout);
102         //alignmentPanel.add(label);
103         //getViewport().add(label);
104         setViewportView(label);
105         setBorder(BorderFactory.createEmptyBorder());
106         setViewportBorder(BorderFactory.createEmptyBorder());
107         setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
108         // Initialize display
109         setAlignment();
110     }
111
112     /**
113      * Apply a new font for the label.
114      * @param font new font to use.
115      */
116     public void setFont(Font font) {
117         super.setFont(font);
118         if (label != null) {
119             label.setFont(font);
120             if (!isJLabel) {
121                 StyleSheet styleSheet = ((HTMLDocument) ((JTextPane) label).getDocument()).getStyleSheet();
122                 styleSheet.addRule("body {font-family:" + font.getName() + ";}");
123                 styleSheet.addRule("body {font-size:" + font.getSize() + "pt;}");
124                 if (font.isBold()) {
125                     styleSheet.addRule("body {font-weight:bold;}");
126                 } else {
127                     styleSheet.addRule("body {font-weight:normal;}");
128                 }
129                 if (font.isItalic()) {
130                     styleSheet.addRule("body {font-style:italic;}");
131                 } else {
132                     styleSheet.addRule("body {font-style:normal;}");
133                 }
134             }
135         }
136     }
137
138     /**
139      * To set the Foreground color of the element.
140      * @param color the Color
141      */
142     public void setForeground(Color color) {
143         super.setForeground(color);
144         if (label != null) {
145             label.setForeground(color);
146         }
147     }
148
149     /**
150      * To set the Background color of the element.
151      * @param color the Color
152      */
153     public void setBackground(Color color) {
154         super.setBackground(color);
155         if (alignmentPanel != null) {
156             alignmentPanel.setBackground(color);
157         }
158         if (label != null) {
159             label.setBackground(color);
160         }
161     }
162
163     /**
164      * Draws a swing Scilab PushButton
165      * @see org.scilab.modules.gui.uielement.UIElement#draw()
166      */
167     public void draw() {
168         this.setVisible(true);
169         this.doLayout();
170     }
171
172     /**
173      * Gets the dimensions (width and height) of a swing Scilab element
174      * @return the dimensions of the element
175      * @see org.scilab.modules.gui.uielement.UIElement#getDims()
176      */
177     public Size getDims() {
178         return new Size(getWidth(), getHeight());
179     }
180
181     /**
182      * Gets the position (X-coordinate and Y-coordinate) of a swing Scilab
183      * element
184      * @return the position of the element
185      * @see org.scilab.modules.gui.uielement.UIElement#getPosition()
186      */
187     public Position getPosition() {
188         return PositionConverter.javaToScilab(getLocation(), getSize(), getParent());
189     }
190
191     /**
192      * Sets the dimensions (width and height) of a swing Scilab element
193      * @param newSize the dimensions to set to the element
194      * @see org.scilab.modules.gui.uielement.UIElement#setDims(org.scilab.modules.gui.utils.Size)
195      */
196     public void setDims(Size newSize) {
197         setSize(newSize.getWidth(), newSize.getHeight());
198         // Need validate to force alignement to be applyed
199         setMinimumSize(new Dimension(
200                            Math.max((int)label.getMinimumSize().getWidth(), newSize.getWidth()),
201                            (int)label.getMinimumSize().getHeight()));
202         validate();
203     }
204
205     /**
206      * Sets the position (X-coordinate and Y-coordinate) of a swing Scilab
207      * element
208      * @param newPosition the position to set to the element
209      * @see org.scilab.modules.gui.uielement.UIElement#setPosition(org.scilab.modules.gui.utils.Position)
210      */
211     public void setPosition(Position newPosition) {
212         Position javaPosition = PositionConverter.scilabToJava(newPosition, getDims(), getParent());
213         setLocation(javaPosition.getX(), javaPosition.getY());
214     }
215
216     /**
217      * Add a callback to the Label
218      * @param callback the callback to set.
219      */
220     public void setCallback(CommonCallBack callback) {
221         // Nothing to do...
222     }
223
224     /**
225      * Setter for MenuBar
226      * @param menuBarToAdd the MenuBar associated to the Label.
227      */
228     public void addMenuBar(MenuBar menuBarToAdd) {
229         /* Unimplemented for Labels */
230         throw new UnsupportedOperationException();
231     }
232
233     /**
234      * Setter for ToolBar
235      * @param toolBarToAdd the ToolBar associated to the Label.
236      */
237     public void addToolBar(ToolBar toolBarToAdd) {
238         /* Unimplemented for Labels */
239         throw new UnsupportedOperationException();
240     }
241
242     /**
243      * Getter for MenuBar
244      * @return MenuBar: the MenuBar associated to the Label.
245      */
246     public MenuBar getMenuBar() {
247         /* Unimplemented for Labels */
248         throw new UnsupportedOperationException();
249     }
250
251     /**
252      * Getter for ToolBar
253      * @return ToolBar: the ToolBar associated to the Label.
254      */
255     public ToolBar getToolBar() {
256         /* Unimplemented for Labels */
257         throw new UnsupportedOperationException();
258     }
259
260     /**
261      * Set the horizontal alignment for the Label text
262      * @param alignment the value for the alignment (See ScilabAlignment.java)
263      */
264     public void setHorizontalAlignment(String alignment) {
265         horizontalAlignment = alignment;
266         setAlignment();
267     }
268
269     /**
270      * Set the vertical alignment for the Label text
271      * @param alignment the value for the alignment (See ScilabAlignment.java)
272      */
273     public void setVerticalAlignment(String alignment) {
274         verticalAlignment = alignment;
275         setAlignment();
276
277     }
278
279     /**
280      * Set the Relief of the Label
281      * @param reliefType the type of the relief to set (See ScilabRelief.java)
282      */
283     public void setRelief(String reliefType) {
284         if (defaultBorder == null) {
285             defaultBorder = getBorder();
286         }
287         setBorder(ScilabRelief.getBorderFromRelief(reliefType, defaultBorder));
288     }
289
290     /**
291      * Destroy the Label
292      */
293     public void destroy() {
294         ScilabSwingUtilities.removeFromParent(this);
295     }
296
297     /**
298      * Setter for InfoBar
299      * @param infoBarToAdd the InfoBar associated to the Label.
300      */
301     public void addInfoBar(TextBox infoBarToAdd) {
302         /* Unimplemented for Labels */
303         throw new UnsupportedOperationException();
304     }
305
306     /**
307      * Getter for InfoBar
308      * @return the InfoBar associated to the Label.
309      */
310     public TextBox getInfoBar() {
311         /* Unimplemented for Labels */
312         throw new UnsupportedOperationException();
313     }
314
315     /**
316      * get the text displayed in the label
317      * @return the label
318      * @see org.scilab.modules.gui.text.SimpleText#getText()
319      */
320     public String getText() {
321         return labelText;
322     }
323
324     /**
325      * Set the text displayed in the label
326      * @param newText the text
327      * @see org.scilab.modules.gui.text.SimpleText#setText(java.lang.String)
328      */
329     public void setText(String newText) {
330         // Save the data given by the user so that it can be retrieved
331         // (Java adds HTML tags in the getlabel().getText() returned value)
332         labelText = newText;
333         if (labelText.startsWith("<")) {
334             // Try if we are in MathML
335             if (isJLabel && ScilabSpecialTextUtilities.setText(label, newText)) {
336                 // MathML in JLabel : OK
337                 // Rendering will be done using Icon
338                 ((JLabel) label).setText(null);
339             } else if (!isJLabel) {
340                 // Try rendering in a new JLabel
341                 if (ScilabSpecialTextUtilities.setText(new JLabel(), newText)) {
342                     // MathML in JEditorPane : Change component
343                     changeLabelType(!isJLabel);
344                     ScilabSpecialTextUtilities.setText(label, newText);
345                     // Rendering will be done using Icon
346                     ((JLabel) label).setText(null);
347                 } else {
348                     // HTML in JEditorPane : OK
349                     ((JEditorPane) label).setText(newText);
350                 }
351             } else {
352                 // HTML in JLabel :
353                 changeLabelType(!isJLabel);
354                 ((JEditorPane) label).setText(newText);
355             }
356         } else {
357             if (!isJLabel) {
358                 changeLabelType(!isJLabel);
359             }
360
361             if (!ScilabSpecialTextUtilities.setText(label, newText)) {
362                 // Normal Text
363                 ((JLabel) label).setText(newText);
364                 ((JLabel) label).invalidate();
365                 invalidate();
366
367             } else {
368                 // Latex or MathML : Rendering will be done using Icon
369                 ((JLabel) label).setText(null);
370             }
371         }
372
373     }
374
375     /**
376      * Change Label type to switch between JLabel abd JEditorPane JLabel is
377      * quicker on simple text JEditorPane can enable HyperLinks
378      * @param isHtmlLabel
379      */
380     private void changeLabelType(boolean isJLabel) {
381         this.isJLabel = isJLabel;
382         Color bgColor = label.getBackground();
383         Color fgColor = label.getForeground();
384         Font font = label.getFont();
385         Dimension dims = label.getSize();
386         label.setVisible(false);
387
388         if (!isJLabel) {
389             JTextPane newLabel = new JTextPane();
390             newLabel.addHyperlinkListener(urlOpener);
391             newLabel.setContentType("text/html");
392             newLabel.setEditable(false);
393             StyleSheet styleSheet = ((HTMLDocument) newLabel.getDocument()).getStyleSheet();
394             styleSheet.addRule("body {font-family:" + font.getName() + ";}");
395             styleSheet.addRule("body {font-size:" + font.getSize() + "pt;}");
396             if (font.isBold()) {
397                 styleSheet.addRule("body {font-weight:bold;}");
398             } else {
399                 styleSheet.addRule("body {font-weight:normal;}");
400             }
401             if (font.isItalic()) {
402                 styleSheet.addRule("body {font-style:italic;}");
403             } else {
404                 styleSheet.addRule("body {font-style:normal;}");
405             }
406
407             label = newLabel;
408             alignmentPanel.add(label);
409             alignmentPanel.revalidate();
410             setViewportView(alignmentPanel);
411         } else {
412             alignmentPanel.remove(label);
413             label = new JLabel();
414             setViewportView(label);
415             //refresh icon
416             update(__GO_UI_ICON__, GraphicController.getController().getProperty(getId(), __GO_UI_ICON__));
417             setAlignment();
418         }
419
420         label.setBackground(bgColor);
421         label.setForeground(fgColor);
422         label.setFont(font);
423         label.setSize(dims);
424         label.setVisible(true);
425     }
426
427     /**
428      * Set alignment of the text component
429      */
430     private void setAlignment() {
431
432         if (isJLabel) {
433             ((JLabel)label).setVerticalAlignment(ScilabAlignment.toSwingAlignment(verticalAlignment));
434             ((JLabel)label).setHorizontalAlignment(ScilabAlignment.toSwingAlignment(horizontalAlignment));
435             return;
436         }
437         GridBagConstraints gbc = new GridBagConstraints();
438
439         gbc.gridx = 0;
440         gbc.gridy = 0;
441         gbc.weightx = 1;
442         gbc.weighty = 1;
443         gbc.gridwidth = 1;
444         gbc.gridheight = 1;
445
446         switch (ScilabAlignment.toSwingAlignment(horizontalAlignment)) {
447             case SwingConstants.LEFT:
448                 switch (ScilabAlignment.toSwingAlignment(verticalAlignment)) {
449                     case SwingConstants.TOP:
450                         gbc.anchor = GridBagConstraints.NORTHWEST;
451                         break;
452                     case SwingConstants.CENTER:
453                         gbc.anchor = GridBagConstraints.WEST;
454                         break;
455                     default: // SwingConstants.BOTTOM
456                         gbc.anchor = GridBagConstraints.SOUTHWEST;
457                         break;
458                 }
459                 break;
460             case SwingConstants.CENTER:
461                 switch (ScilabAlignment.toSwingAlignment(verticalAlignment)) {
462                     case SwingConstants.TOP:
463                         gbc.anchor = GridBagConstraints.NORTH;
464                         break;
465                     case SwingConstants.CENTER:
466                         gbc.anchor = GridBagConstraints.CENTER;
467                         break;
468                     default: // SwingConstants.BOTTOM
469                         gbc.anchor = GridBagConstraints.SOUTH;
470                         break;
471                 }
472                 break;
473             default: // SwingConstants.RIGHT
474                 switch (ScilabAlignment.toSwingAlignment(verticalAlignment)) {
475                     case SwingConstants.TOP:
476                         gbc.anchor = GridBagConstraints.NORTHEAST;
477                         break;
478                     case SwingConstants.CENTER:
479                         gbc.anchor = GridBagConstraints.EAST;
480                         break;
481                     default: // SwingConstants.BOTTOM
482                         gbc.anchor = GridBagConstraints.SOUTHEAST;
483                         break;
484                 }
485                 break;
486         }
487
488         alignmentLayout.setConstraints(label, gbc);
489         alignmentPanel.revalidate();
490     }
491
492     /**
493      * Set the UID
494      * @param id the UID
495      */
496     public void setId(Integer id) {
497         uid = id;
498     }
499
500     /**
501      * Get the UID
502      * @return the UID
503      */
504     public Integer getId() {
505         return uid;
506     }
507
508     /**
509      * Generic update method
510      * @param property property name
511      * @param value property value
512      */
513     public void update(int property, Object value) {
514         switch (property) {
515             case __GO_UI_ICON__: {
516                 if (isJLabel) {
517                     File file = new File((String) value);
518                     if (file.exists() == false) {
519                         String filename = FindIconHelper.findImage((String) value);
520                         file = new File(filename);
521                     }
522
523                     try {
524                         ((JLabel) label).setIcon(new ImageIcon(ImageIO.read(file)));
525                     } catch (IOException e) {
526                     }
527                 } else {
528                     //Icon in JEditorPane ?
529                 }
530                 break;
531             }
532             default: {
533                 SwingViewWidget.update(this, property, value);
534             }
535         }
536     }
537
538     public void resetBackground() {
539         Color color = (Color) UIManager.getLookAndFeelDefaults().get("Label.background");
540         if (color != null) {
541             setBackground(color);
542         }
543     }
544 }