- /*
- * @(#)SynthSpinnerUI.java 1.8 03/01/23
- *
- * Copyright 2003 Sun Microsystems, Inc. All rights reserved.
- * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
- */
- package com.sun.java.swing.plaf.gtk;
-
- import java.awt.*;
- import java.awt.event.*;
- import java.text.ParseException;
-
- import javax.swing.*;
- import javax.swing.event.*;
- import javax.swing.plaf.*;
- import javax.swing.text.*;
-
- import java.beans.*;
- import java.text.*;
- import java.util.*;
-
-
-
- /**
- * The default Spinner UI delegate.
- *
- * @version 1.8, 01/23/03 (based on BasicSpinnerUI v 1.12)
- * @author Hans Muller
- */
- class SynthSpinnerUI extends SpinnerUI implements SynthUI {
- private SynthStyle style;
-
- /**
- * The spinner that we're a UI delegate for. Initialized by
- * the <code>installUI</code> method, and reset to null
- * by <code>uninstallUI</code>.
- *
- * @see #installUI
- * @see #uninstallUI
- */
- protected JSpinner spinner;
-
-
- /**
- * The <code>PropertyChangeListener</code> that's added to the
- * <code>JSpinner</code> itself. This listener is created by the
- * <code>createPropertyChangeListener</code> method, added by the
- * <code>installListeners</code> method, and removed by the
- * <code>uninstallListeners</code> method.
- * <p>
- * One instance of this listener is shared by all JSpinners.
- *
- * @see #createPropertyChangeListener
- * @see #installListeners
- * @see #uninstallListeners
- */
- private static final PropertyChangeListener propertyChangeListener = new PropertyChangeHandler();
-
-
- /**
- * The mouse/action listeners that are added to the spinner's
- * arrow buttons. These listeners are shared by all
- * spinner arrow buttons.
- *
- * @see #createNextButton
- * @see #createPreviousButton
- */
- private static final ArrowButtonHandler nextButtonHandler = new ArrowButtonHandler("increment", true);
- private static final ArrowButtonHandler previousButtonHandler = new ArrowButtonHandler("decrement", false);
-
-
- /**
- * Returns a new instance of SynthSpinnerUI.
- *
- * @param c the JSpinner (not used)
- * @see ComponentUI#createUI
- * @return a new SynthSpinnerUI object
- */
- public static ComponentUI createUI(JComponent c) {
- return new SynthSpinnerUI();
- }
-
- public static void loadActionMap(ActionMap map) {
- // NOTE: this needs to remain static. If you have a need to
- // have Actions that reference the UI in the ActionMap,
- // then you'll also need to change the registeration of the
- // ActionMap.
- map.put("increment", nextButtonHandler);
- map.put("decrement", previousButtonHandler);
- }
-
-
-
- /**
- * Calls <code>installDefaults</code>, <code>installListeners</code>,
- * and then adds the components returned by <code>createNextButton</code>,
- * <code>createPreviousButton</code>, and <code>createEditor</code>.
- *
- * @param c the JSpinner
- * @see #installDefaults
- * @see #installListeners
- * @see #createNextButton
- * @see #createPreviousButton
- * @see #createEditor
- */
- public void installUI(JComponent c) {
- this.spinner = (JSpinner)c;
- installDefaults();
- installListeners();
- Component next = createNextButton();
- if (next != null) {
- next.setName("Spinner.nextButton");
- if (next instanceof JComponent) {
- ((JComponent)next).updateUI();
- }
- spinner.add(next, "Next");
- }
- Component previous = createPreviousButton();
- if (previous != null) {
- previous.setName("Spinner.previousButton");
- if (previous instanceof JComponent) {
- ((JComponent)previous).updateUI();
- }
- spinner.add(previous, "Previous");
- }
- Component editor = createEditor();
- if (editor != null) {
- editor.setName("Spinner.editor");
- if (editor instanceof JComponent) {
- ((JComponent)editor).updateUI();
- }
- spinner.add(editor, "Editor");
- }
- updateEnabledState();
- installKeyboardActions();
- }
-
-
- /**
- * Calls <code>uninstallDefaults</code>, <code>uninstallListeners</code>,
- * and then removes all of the spinners children.
- *
- * @param c the JSpinner (not used)
- */
- public void uninstallUI(JComponent c) {
- uninstallDefaults();
- uninstallListeners();
- this.spinner = null;
- c.removeAll();
- }
-
-
- /**
- * Initializes <code>propertyChangeListener</code> with
- * a shared object that delegates interesting PropertyChangeEvents
- * to protected methods.
- * <p>
- * This method is called by <code>installUI</code>.
- *
- * @see #replaceEditor
- * @see #uninstallListeners
- */
- protected void installListeners() {
- spinner.addPropertyChangeListener(propertyChangeListener);
- }
-
-
- /**
- * Removes the <code>propertyChangeListener</code> added
- * by installListeners.
- * <p>
- * This method is called by <code>uninstallUI</code>.
- *
- * @see #installListeners
- */
- protected void uninstallListeners() {
- spinner.removePropertyChangeListener(propertyChangeListener);
- }
-
-
- /**
- * Initialize the <code>JSpinner</code> <code>border</code>,
- * <code>foreground</code>, and <code>background</code>, properties
- * based on the corresponding "Spinner.*" properties from defaults table.
- * The <code>JSpinners</code> layout is set to the value returned by
- * <code>createLayout</code>. This method is called by <code>installUI</code>.
- *
- * @see #uninstallDefaults
- * @see #installUI
- * @see #createLayout
- * @see LookAndFeel#installBorder
- * @see LookAndFeel#installColors
- */
- protected void installDefaults() {
- LayoutManager layout = spinner.getLayout();
-
- if (layout == null || layout instanceof UIResource) {
- spinner.setLayout(createLayout());
- }
-
- // Dig the formatted text field out of the editor and set its name.
- JComponent editor = spinner.getEditor();
- if (editor instanceof JSpinner.DefaultEditor) {
- JFormattedTextField ftf =
- ((JSpinner.DefaultEditor)editor).getTextField();
- ftf.setName("Spinner.formattedTextField");
- }
- fetchStyle(spinner);
- }
-
-
- private void fetchStyle(JSpinner c) {
- SynthContext context = getContext(c, ENABLED);
-
- style = SynthLookAndFeel.updateStyle(context, this);
- context.dispose();
- }
-
-
- /**
- * Sets the <code>JSpinner's</code> layout manager to null. This
- * method is called by <code>uninstallUI</code>.
- *
- * @see #installDefaults
- * @see #uninstallUI
- */
- protected void uninstallDefaults() {
- if (spinner.getLayout() instanceof UIResource) {
- spinner.setLayout(null);
- }
-
- SynthContext context = getContext(spinner, ENABLED);
-
- style.uninstallDefaults(context);
- context.dispose();
- style = null;
- }
-
-
- /**
- * Create a <code>LayoutManager</code> that manages the <code>editor</code>,
- * <code>nextButton</code>, and <code>previousButton</code>
- * children of the JSpinner. These three children must be
- * added with a constraint that identifies their role:
- * "Editor", "Next", and "Previous". The default layout manager
- * can handle the absence of any of these children.
- *
- * @return a LayoutManager for the editor, next button, and previous button.
- * @see #createNextButton
- * @see #createPreviousButton
- * @see #createEditor
- */
- protected LayoutManager createLayout() {
- return new SpinnerLayout();
- }
-
-
- /**
- * Create a <code>PropertyChangeListener</code> that can be
- * added to the JSpinner itself. Typically, this listener
- * will call replaceEditor when the "editor" property changes,
- * since it's the <code>SpinnerUI's</code> responsibility to
- * add the editor to the JSpinner (and remove the old one).
- * This method is called by <code>installListeners</code>.
- *
- * @return A PropertyChangeListener for the JSpinner itself
- * @see #installListeners
- */
- protected PropertyChangeListener createPropertyChangeListener() {
- return propertyChangeListener;
- }
-
-
- /**
- * Create a component that will replace the spinner models value
- * with the object returned by <code>spinner.getPreviousValue</code>.
- * By default the <code>previousButton</code> is a JButton
- * who's <code>ActionListener</code> updates it's <code>JSpinner</code>
- * ancestors model. If a previousButton isn't needed (in a subclass)
- * then override this method to return null.
- *
- * @return a component that will replace the spinners model with the
- * next value in the sequence, or null
- * @see #installUI
- * @see #createNextButton
- */
- protected Component createPreviousButton() {
- JButton b = new SynthArrowButton(SwingConstants.SOUTH);
- b.addActionListener(previousButtonHandler);
- b.addMouseListener(previousButtonHandler);
- return b;
- }
-
-
- /**
- * Create a component that will replace the spinner models value
- * with the object returned by <code>spinner.getNextValue</code>.
- * By default the <code>nextButton</code> is a JButton
- * who's <code>ActionListener</code> updates it's <code>JSpinner</code>
- * ancestors model. If a nextButton isn't needed (in a subclass)
- * then override this method to return null.
- *
- * @return a component that will replace the spinners model with the
- * next value in the sequence, or null
- * @see #installUI
- * @see #createPreviousButton
- */
- protected Component createNextButton() {
- JButton b = new SynthArrowButton(SwingConstants.NORTH);
- b.addActionListener(nextButtonHandler);
- b.addMouseListener(nextButtonHandler);
- return b;
- }
-
-
- /**
- * This method is called by installUI to get the editor component
- * of the <code>JSpinner</code>. By default it just returns
- * <code>JSpinner.getEditor()</code>. Subclasses can override
- * <code>createEditor</code> to return a component that contains
- * the spinner's editor or null, if they're going to handle adding
- * the editor to the <code>JSpinner</code> in an
- * <code>installUI</code> override.
- * <p>
- * Typically this method would be overridden to wrap the editor
- * with a container with a custom border, since one can't assume
- * that the editors border can be set directly.
- * <p>
- * The <code>replaceEditor</code> method is called when the spinners
- * editor is changed with <code>JSpinner.setEditor</code>. If you've
- * overriden this method, then you'll probably want to override
- * <code>replaceEditor</code> as well.
- *
- * @return the JSpinners editor JComponent, spinner.getEditor() by default
- * @see #installUI
- * @see #replaceEditor
- * @see JSpinner#getEditor
- */
- protected JComponent createEditor() {
- return spinner.getEditor();
- }
-
-
- /**
- * Called by the <code>PropertyChangeListener</code> when the
- * <code>JSpinner</code> editor property changes. It's the responsibility
- * of this method to remove the old editor and add the new one. By
- * default this operation is just:
- * <pre>
- * spinner.remove(oldEditor);
- * spinner.add(newEditor, "Editor");
- * </pre>
- * The implementation of <code>replaceEditor</code> should be coordinated
- * with the <code>createEditor</code> method.
- *
- * @see #createEditor
- * @see #createPropertyChangeListener
- */
- protected void replaceEditor(JComponent oldEditor, JComponent newEditor) {
- spinner.remove(oldEditor);
- spinner.add(newEditor, "Editor");
-
- // Dig the formatted text field out of the editor and set its name.
- JComponent editor = spinner.getEditor();
- if (editor instanceof JSpinner.DefaultEditor) {
- JFormattedTextField ftf =
- ((JSpinner.DefaultEditor)editor).getTextField();
- ftf.setName("Spinner.formattedTextField");
- }
- }
-
-
- /**
- * Updates the enabled state of the children Components based on the
- * enabled state of the <code>JSpinner</code>.
- */
- private void updateEnabledState() {
- updateEnabledState(spinner, spinner.isEnabled());
- }
-
-
- /**
- * Recursively updates the enabled state of the child
- * <code>Component</code>s of <code>c</code>.
- */
- private void updateEnabledState(Container c, boolean enabled) {
- for (int counter = c.getComponentCount() - 1; counter >= 0;counter--) {
- Component child = c.getComponent(counter);
-
- child.setEnabled(enabled);
- if (child instanceof Container) {
- updateEnabledState((Container)child, enabled);
- }
- }
- }
-
-
- /**
- * Installs the KeyboardActions onto the JSpinner.
- */
- private void installKeyboardActions() {
- InputMap iMap = getInputMap(JComponent.
- WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
-
- SwingUtilities.replaceUIInputMap(spinner, JComponent.
- WHEN_ANCESTOR_OF_FOCUSED_COMPONENT,
- iMap);
-
- LazyActionMap.installLazyActionMap(spinner, SynthSpinnerUI.class,
- "Spinner.actionMap");
- }
-
- /**
- * Returns the InputMap to install for <code>condition</code>.
- */
- private InputMap getInputMap(int condition) {
- if (condition == JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT) {
- SynthContext context = getContext(spinner, ENABLED);
- InputMap map = (InputMap)context.getStyle().get(context,
- "Spinner.ancestorInputMap");
-
- context.dispose();
- return map;
- }
- return null;
- }
-
-
- public SynthContext getContext(JComponent c) {
- return getContext(c, getComponentState(c));
- }
-
- private SynthContext getContext(JComponent c, int state) {
- return SynthContext.getContext(SynthContext.class, c,
- SynthLookAndFeel.getRegion(c), style, state);
- }
-
-
- private Region getRegion(JComponent c) {
- return SynthLookAndFeel.getRegion(c);
- }
-
-
- private int getComponentState(JComponent c) {
- return SynthLookAndFeel.getComponentState(c);
- }
-
-
- public void update(Graphics g, JComponent c) {
- SynthContext context = getContext(c);
-
- SynthLookAndFeel.update(context, g);
- paint(context, g);
- context.dispose();
- }
-
-
- public void paint(Graphics g, JComponent c) {
- SynthContext context = getContext(c);
-
- paint(context, g);
- context.dispose();
- }
-
-
- protected void paint(SynthContext context, Graphics g) {
- }
-
- /**
- * A handler for spinner arrow button mouse and action events. When
- * a left mouse pressed event occurs we look up the (enabled) spinner
- * that's the source of the event and start the autorepeat timer. The
- * timer fires action events until any button is released at which
- * point the timer is stopped and the reference to the spinner cleared.
- * The timer doesn't start until after a 300ms delay, so often the
- * source of the initial (and final) action event is just the button
- * logic for mouse released - which means that we're relying on the fact
- * that our mouse listener runs after the buttons mouse listener.
- * <p>
- * Note that one instance of this handler is shared by all slider previous
- * arrow buttons and likewise for all of the next buttons,
- * so it doesn't have any state that persists beyond the limits
- * of a single button pressed/released gesture.
- */
- private static class ArrowButtonHandler extends AbstractAction implements MouseListener
- {
- final javax.swing.Timer autoRepeatTimer;
- final boolean isNext;
- JSpinner spinner = null;
-
- ArrowButtonHandler(String name, boolean isNext) {
- super(name);
- this.isNext = isNext;
- autoRepeatTimer = new javax.swing.Timer(60, this);
- autoRepeatTimer.setInitialDelay(300);
- }
-
- private JSpinner eventToSpinner(AWTEvent e) {
- Object src = e.getSource();
- while ((src instanceof Component) && !(src instanceof JSpinner)) {
- src = ((Component)src).getParent();
- }
- return (src instanceof JSpinner) ? (JSpinner)src : null;
- }
-
- public void actionPerformed(ActionEvent e) {
- JSpinner spinner = this.spinner;
-
- if (!(e.getSource() instanceof javax.swing.Timer)) {
- // Most likely resulting from being in ActionMap.
- spinner = eventToSpinner(e);
- }
- if (spinner != null) {
- try {
- int calendarField = getCalendarField(spinner);
- spinner.commitEdit();
- if (calendarField != -1) {
- ((SpinnerDateModel)spinner.getModel()).
- setCalendarField(calendarField);
- }
- Object value = (isNext) ? spinner.getNextValue() :
- spinner.getPreviousValue();
- if (value != null) {
- spinner.setValue(value);
- select(spinner);
- }
- } catch (IllegalArgumentException iae) {
- UIManager.getLookAndFeel().provideErrorFeedback(spinner);
- } catch (ParseException pe) {
- UIManager.getLookAndFeel().provideErrorFeedback(spinner);
- }
- }
- }
-
- /**
- * If the spinner's editor is a DateEditor, this selects the field
- * associated with the value that is being incremented.
- */
- private void select(JSpinner spinner) {
- JComponent editor = spinner.getEditor();
-
- if (editor instanceof JSpinner.DateEditor) {
- JSpinner.DateEditor dateEditor = (JSpinner.DateEditor)editor;
- JFormattedTextField ftf = dateEditor.getTextField();
- Format format = dateEditor.getFormat();
- Object value;
-
- if (format != null && (value = spinner.getValue()) != null) {
- SpinnerDateModel model = dateEditor.getModel();
- DateFormat.Field field = DateFormat.Field.ofCalendarField(
- model.getCalendarField());
-
- if (field != null) {
- try {
- AttributedCharacterIterator iterator = format.
- formatToCharacterIterator(value);
- if (!select(ftf, iterator, field) &&
- field == DateFormat.Field.HOUR0) {
- select(ftf, iterator, DateFormat.Field.HOUR1);
- }
- }
- catch (IllegalArgumentException iae) {}
- }
- }
- }
- }
-
- /**
- * Selects the passed in field, returning true if it is found,
- * false otherwise.
- */
- private boolean select(JFormattedTextField ftf,
- AttributedCharacterIterator iterator,
- DateFormat.Field field) {
- int max = ftf.getDocument().getLength();
-
- iterator.first();
- do {
- Map attrs = iterator.getAttributes();
-
- if (attrs != null && attrs.containsKey(field)){
- int start = iterator.getRunStart(field);
- int end = iterator.getRunLimit(field);
-
- if (start != -1 && end != -1 && start <= max &&
- end <= max) {
- ftf.select(start, end);
- }
- return true;
- }
- } while (iterator.next() != CharacterIterator.DONE);
- return false;
- }
-
- /**
- * Returns the calendarField under the start of the selection, or
- * -1 if there is no valid calendar field under the selection (or
- * the spinner isn't editing dates.
- */
- private int getCalendarField(JSpinner spinner) {
- JComponent editor = spinner.getEditor();
-
- if (editor instanceof JSpinner.DateEditor) {
- JSpinner.DateEditor dateEditor = (JSpinner.DateEditor)editor;
- JFormattedTextField ftf = dateEditor.getTextField();
- int start = ftf.getSelectionStart();
- JFormattedTextField.AbstractFormatter formatter =
- ftf.getFormatter();
-
- if (formatter instanceof InternationalFormatter) {
- Format.Field[] fields = ((InternationalFormatter)
- formatter).getFields(start);
-
- for (int counter = 0; counter < fields.length; counter++) {
- if (fields[counter] instanceof DateFormat.Field) {
- int calendarField;
-
- if (fields[counter] == DateFormat.Field.HOUR1) {
- calendarField = Calendar.HOUR;
- }
- else {
- calendarField = ((DateFormat.Field)
- fields[counter]).getCalendarField();
- }
- if (calendarField != -1) {
- return calendarField;
- }
- }
- }
- }
- }
- return -1;
- }
-
- public void mousePressed(MouseEvent e) {
- if (SwingUtilities.isLeftMouseButton(e) && e.getComponent().isEnabled()) {
- spinner = eventToSpinner(e);
- autoRepeatTimer.start();
-
- focusSpinnerIfNecessary();
- }
- }
-
- public void mouseReleased(MouseEvent e) {
- autoRepeatTimer.stop();
- spinner = null;
- }
-
- public void mouseClicked(MouseEvent e) {
- }
-
- public void mouseEntered(MouseEvent e) {
- }
-
- public void mouseExited(MouseEvent e) {
- }
-
- /**
- * Requests focus on a child of the spinner if the spinner doesn't
- * have focus.
- */
- private void focusSpinnerIfNecessary() {
- Component fo = KeyboardFocusManager.
- getCurrentKeyboardFocusManager().getFocusOwner();
- if (spinner.isRequestFocusEnabled() && (
- fo == null ||
- !SwingUtilities.isDescendingFrom(fo, spinner))) {
- Container root = spinner;
-
- if (!root.isFocusCycleRoot()) {
- root = root.getFocusCycleRootAncestor();
- }
- if (root != null) {
- FocusTraversalPolicy ftp = root.getFocusTraversalPolicy();
- Component child = ftp.getComponentAfter(root, spinner);
-
- if (child != null && SwingUtilities.isDescendingFrom(
- child, spinner)) {
- child.requestFocus();
- }
- }
- }
- }
- }
-
-
- /**
- * A simple layout manager for the editor and the next/previous buttons.
- * See the SynthSpinnerUI javadoc for more information about exactly
- * how the components are arranged.
- */
- private static class SpinnerLayout implements LayoutManager, UIResource
- {
- private Component nextButton = null;
- private Component previousButton = null;
- private Component editor = null;
-
- public void addLayoutComponent(String name, Component c) {
- if ("Next".equals(name)) {
- nextButton = c;
- }
- else if ("Previous".equals(name)) {
- previousButton = c;
- }
- else if ("Editor".equals(name)) {
- editor = c;
- }
- }
-
- public void removeLayoutComponent(Component c) {
- if (c == nextButton) {
- c = null;
- }
- else if (c == previousButton) {
- previousButton = null;
- }
- else if (c == editor) {
- editor = null;
- }
- }
-
- private Dimension preferredSize(Component c) {
- return (c == null) ? new Dimension(0, 0) : c.getPreferredSize();
- }
-
- public Dimension preferredLayoutSize(Container parent) {
- Dimension nextD = preferredSize(nextButton);
- Dimension previousD = preferredSize(previousButton);
- Dimension editorD = preferredSize(editor);
-
- /* Force the editors height to be a multiple of 2
- */
- editorD.height = ((editorD.height + 1) / 2) * 2;
-
- Dimension size = new Dimension(editorD.width, editorD.height);
- size.width += Math.max(nextD.width, previousD.width);
- Insets insets = parent.getInsets();
- size.width += insets.left + insets.right;
- size.height += insets.top + insets.bottom;
- return size;
- }
-
- public Dimension minimumLayoutSize(Container parent) {
- return preferredLayoutSize(parent);
- }
-
- private void setBounds(Component c, int x, int y, int width, int height) {
- if (c != null) {
- c.setBounds(x, y, width, height);
- }
- }
-
- public void layoutContainer(Container parent) {
- Insets insets = parent.getInsets();
- int availWidth = parent.getWidth() - (insets.left + insets.right);
- int availHeight = parent.getHeight() - (insets.top + insets.bottom);
- Dimension nextD = preferredSize(nextButton);
- Dimension previousD = preferredSize(previousButton);
- int nextHeight = availHeight / 2;
- int previousHeight = availHeight - nextHeight;
- int buttonsWidth = Math.max(nextD.width, previousD.width);
- int editorWidth = availWidth - buttonsWidth;
-
- /* Deal with the spinners componentOrientation property.
- */
- int editorX, buttonsX;
- if (parent.getComponentOrientation().isLeftToRight()) {
- editorX = insets.left;
- buttonsX = editorX + editorWidth;
- }
- else {
- buttonsX = insets.left;
- editorX = buttonsX + buttonsWidth;
- }
-
- int previousY = insets.top + nextHeight;
- setBounds(editor, editorX, insets.top, editorWidth, availHeight);
- setBounds(nextButton, buttonsX, insets.top, buttonsWidth, nextHeight);
- setBounds(previousButton, buttonsX, previousY, buttonsWidth, previousHeight);
- }
- }
-
-
- /**
- * Detect JSpinner property changes we're interested in and delegate. Subclasses
- * shouldn't need to replace the default propertyChangeListener (although they
- * can by overriding createPropertyChangeListener) since all of the interesting
- * property changes are delegated to protected methods.
- */
- private static class PropertyChangeHandler implements PropertyChangeListener
- {
- public void propertyChange(PropertyChangeEvent e)
- {
- String propertyName = e.getPropertyName();
- JSpinner spinner = (JSpinner)(e.getSource());
- SpinnerUI spinnerUI = spinner.getUI();
-
- // PENDING:
- if (spinnerUI instanceof SynthSpinnerUI) {
- SynthSpinnerUI ui = (SynthSpinnerUI)spinnerUI;
-
- if (SynthLookAndFeel.shouldUpdateStyle(e)) {
- ui.fetchStyle(spinner);
- }
- if ("editor".equals(propertyName)) {
- JComponent oldEditor = (JComponent)e.getOldValue();
- JComponent newEditor = (JComponent)e.getNewValue();
- ui.replaceEditor(oldEditor, newEditor);
- ui.updateEnabledState();
- }
- else if ("enabled".equals(propertyName)) {
- ui.updateEnabledState();
- }
- }
- }
- }
- }