1/*
2 * Copyright (c) 2002, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.swing.plaf.synth;
27
28import java.awt.*;
29import javax.swing.*;
30import javax.swing.text.*;
31import javax.swing.plaf.*;
32import javax.swing.plaf.basic.BasicEditorPaneUI;
33import java.beans.PropertyChangeEvent;
34
35/**
36 * Provides the Synth L&F UI delegate for
37 * {@link javax.swing.JEditorPane}.
38 *
39 * @author  Shannon Hickey
40 * @since 1.7
41 */
42public class SynthEditorPaneUI extends BasicEditorPaneUI implements SynthUI {
43    private SynthStyle style;
44    /*
45     * I would prefer to use UIResource instad of this.
46     * Unfortunately Boolean is a final class
47     */
48    private Boolean localTrue = Boolean.TRUE;
49
50    /**
51     * Creates a new UI object for the given component.
52     *
53     * @param c component to create UI object for
54     * @return the UI object
55     */
56    public static ComponentUI createUI(JComponent c) {
57        return new SynthEditorPaneUI();
58    }
59
60    /**
61     * {@inheritDoc}
62     */
63    @Override
64    protected void installDefaults() {
65        // Installs the text cursor on the component
66        super.installDefaults();
67        JComponent c = getComponent();
68        Object clientProperty =
69            c.getClientProperty(JEditorPane.HONOR_DISPLAY_PROPERTIES);
70        if (clientProperty == null) {
71            c.putClientProperty(JEditorPane.HONOR_DISPLAY_PROPERTIES, localTrue);
72        }
73        updateStyle(getComponent());
74    }
75
76    /**
77     * {@inheritDoc}
78     */
79    @Override
80    protected void uninstallDefaults() {
81        SynthContext context = getContext(getComponent(), ENABLED);
82        JComponent c = getComponent();
83        c.putClientProperty("caretAspectRatio", null);
84
85        style.uninstallDefaults(context);
86        style = null;
87
88        Object clientProperty =
89            c.getClientProperty(JEditorPane.HONOR_DISPLAY_PROPERTIES);
90        if (clientProperty == localTrue) {
91            c.putClientProperty(JEditorPane.HONOR_DISPLAY_PROPERTIES,
92                                             Boolean.FALSE);
93        }
94        super.uninstallDefaults();
95    }
96
97    /**
98     * This method gets called when a bound property is changed
99     * on the associated JTextComponent.  This is a hook
100     * which UI implementations may change to reflect how the
101     * UI displays bound properties of JTextComponent subclasses.
102     * This is implemented to rebuild the ActionMap based upon an
103     * EditorKit change.
104     *
105     * @param evt the property change event
106     */
107    @Override
108    protected void propertyChange(PropertyChangeEvent evt) {
109        if (SynthLookAndFeel.shouldUpdateStyle(evt)) {
110            updateStyle((JTextComponent)evt.getSource());
111        }
112        super.propertyChange(evt);
113    }
114
115    private void updateStyle(JTextComponent comp) {
116        SynthContext context = getContext(comp, ENABLED);
117        SynthStyle oldStyle = style;
118
119        style = SynthLookAndFeel.updateStyle(context, this);
120
121        if (style != oldStyle) {
122            SynthTextFieldUI.updateStyle(comp, context, getPropertyPrefix());
123
124            if (oldStyle != null) {
125                uninstallKeyboardActions();
126                installKeyboardActions();
127            }
128        }
129    }
130
131    /**
132     * {@inheritDoc}
133     */
134    @Override
135    public SynthContext getContext(JComponent c) {
136        return getContext(c, getComponentState(c));
137    }
138
139    private SynthContext getContext(JComponent c, int state) {
140        return SynthContext.getContext(c, style, state);
141    }
142
143    private int getComponentState(JComponent c) {
144        return SynthLookAndFeel.getComponentState(c);
145    }
146
147    /**
148     * Notifies this UI delegate to repaint the specified component.
149     * This method paints the component background, then calls
150     * the {@link #paint(SynthContext,Graphics)} method.
151     *
152     * <p>In general, this method does not need to be overridden by subclasses.
153     * All Look and Feel rendering code should reside in the {@code paint} method.
154     *
155     * @param g the {@code Graphics} object used for painting
156     * @param c the component being painted
157     * @see #paint(SynthContext,Graphics)
158     */
159    @Override
160    public void update(Graphics g, JComponent c) {
161        SynthContext context = getContext(c);
162
163        SynthLookAndFeel.update(context, g);
164        paintBackground(context, g, c);
165        paint(context, g);
166    }
167
168    /**
169     * Paints the specified component.
170     *
171     * @param context context for the component being painted
172     * @param g the {@code Graphics} object used for painting
173     * @see #update(Graphics,JComponent)
174     */
175    protected void paint(SynthContext context, Graphics g) {
176        super.paint(g, getComponent());
177    }
178
179    /**
180     * {@inheritDoc}
181     */
182    @Override
183    protected void paintBackground(Graphics g) {
184        // Overriden to do nothing, all our painting is done from update/paint.
185    }
186
187    void paintBackground(SynthContext context, Graphics g, JComponent c) {
188        context.getPainter().paintEditorPaneBackground(context, g, 0, 0,
189                                                  c.getWidth(), c.getHeight());
190    }
191
192    /**
193     * {@inheritDoc}
194     */
195    @Override
196    public void paintBorder(SynthContext context, Graphics g, int x,
197                            int y, int w, int h) {
198        context.getPainter().paintEditorPaneBorder(context, g, x, y, w, h);
199    }
200}
201