ch.randelshofer.quaqua.QuaquaTextFieldBorder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of Quaqua Show documentation
A Mavenisation of the Quaqua Mac OSX Swing Look and Feel (Java library) Quaqua Look and Feel (C) 2003-2010, Werner Randelshofer. Mavenisation by Matt Gumbley, DevZendo.org - for problems with Mavenisation, see Matt; for issues with Quaqua, see the Quaqua home page. For full license details, see http://randelshofer.ch/quaqua/license.html
The newest version!
/*
 * @(#)QuaquaTextFieldBorder.java  4.2  2008-10-02
 *
 * Copyright (c) 2004-2010 Werner Randelshofer, Immensee, Switzerland.
 * All rights reserved.
 *
 * You may not use, copy or modify this file, except in compliance with the
 * license agreement you entered into with Werner Randelshofer.
 * For details see accompanying license terms.
 */

package ch.randelshofer.quaqua;

import ch.randelshofer.quaqua.util.*;
import ch.randelshofer.quaqua.border.BackgroundBorder;
import ch.randelshofer.quaqua.util.Debug;
import java.awt.*;
import java.io.Serializable;
import javax.swing.*;
import javax.swing.text.*;
import javax.swing.border.*;
import javax.swing.plaf.*;

/**
 * QuaquaTextFieldBorder.
 *
 * @author  Werner Randelshofer
 * @version 4.2 2008-10-02 Made imageInsets a parameter, instead of using
 * hardcoded values.
 * 
4.1 2008-01-04 Don't draw focus border when component is disabled. 
 * 
4.0 2007-07-26 Add support for client property "Quaqua.TextField.style"
 * "search", "plain".
 * 
3.1 2007-04-12 Honour margin of JTextComponent.
 * 
3.0.1 2006-01-04 Non-editable text field border must be same as
 * disabled text field border.
 * 
3.0 2005-12-08 Rewritten to create border images lazily and to not
 * hardcode the URL to the border images.
 * 
2.0 2005-10-01 Turned into a background border.
 * 
1.3 2005-06-20 1.2 Changed border insets to achieve baseline alignment with other
 * components.
 * 
1.2 2005-04-10 1.1.1 Alignemnt changed for small size text fields.
 * 
1.1 2005-03-27 1.1 Updated to take account of larger focus ring and of
 * margins.
 * 
1.0  July 4, 2004  Created.
 */
public class QuaquaTextFieldBorder extends VisualMargin implements BackgroundBorder {
    /** Location of the border images. */
    private String imagesLocation;
    private Insets imageInsets;
    private Insets searchImageInsets;
    private Insets smallSearchImageInsets;
    private String searchImagesLocation;
    private String smallSearchImagesLocation;
    /** Array with image bevel plainBorders.
     * This array is created lazily.
     **/
    private Border[] plainBorders;
    private Border[] searchBorders;
    private Border[] smallSearchBorders;
    
    private static class BgBorder implements Border, Serializable {
        QuaquaTextFieldBorder outer;
        public BgBorder(QuaquaTextFieldBorder outer) {
            this.outer=outer;
        }
        public Insets getBorderInsets(Component c) {
            return new Insets(0,0,0,0);
        }
        public boolean isBorderOpaque() {
            return false;
        }
        
        public void paintBorder(Component c, Graphics g, int x, int y, int width, int height) {
            if (c.isOpaque()) {
                g.setColor(UIManager.getColor("Panel.background"));
                g.fillRect(0, 0, width, height);
            }
            
            g.setColor(c.getBackground());
            Insets insets = outer.getVisualMargin(c, new Insets(0,0,0,0));
            if (isSearchField(c)) {
                int arc = Math.min(
                        width - insets.left - insets.right - 8,
                        height - insets.top - insets.bottom - 7);
                
                g.fillRoundRect(
                        insets.left + 4,
                        insets.bottom + 3,
                        width - insets.left - insets.right - 8,
                        height - insets.top - insets.bottom - 7,
                        arc, arc
                        );
            } else {
                g.fillRect(
                        insets.left + 3,
                        insets.bottom + 3,
                        width - insets.left - insets.right - 6,
                        height - insets.top - insets.bottom - 7
                        );
            }
        }
    };
    private BgBorder textFieldBackground = new BgBorder(this);
    
    
    /** Creates a new instance. */
    public QuaquaTextFieldBorder(String imagesLocation, Insets imageInsets,
            String searchImagesLocation, Insets searchImageInsets,
            String smallSearchImagesLocation, Insets smallSearchImageInsets) {
        super(3,3,2,3);
        this.imageInsets = imageInsets;
        this.searchImageInsets = searchImageInsets;
        this.smallSearchImageInsets = smallSearchImageInsets;
        this.imagesLocation = imagesLocation;
        this.searchImagesLocation = searchImagesLocation;
        this.smallSearchImagesLocation = smallSearchImagesLocation;
    }
    
    private static boolean isSmall(Component c) {
            return QuaquaUtilities.isSmallSizeVariant((JComponent) c);
    }
    private static boolean isSearchField(Component c) {
        if (c instanceof JComponent) {
            JComponent jc = (JComponent) c;
            return jc.getClientProperty("Quaqua.TextField.style") != null &&
                    jc.getClientProperty("Quaqua.TextField.style").equals("search");
        }
        return false;
    }
    
    @Override
    public Insets getBorderInsets(Component c, Insets insets) {
        insets = getVisualMargin(c, insets);
        Insets inner = isSmall(c) ?
            (isSearchField(c) ? new Insets(6, 10, 5, 10) : new Insets(6, 7, 5, 7)) :
                (isSearchField(c) ? new Insets(6, 9, 6, 9) : new Insets(6, 7, 6, 7));
        InsetsUtil.addTo(inner, insets);
        
        if (c instanceof JTextComponent) {
            Insets margin = ((JTextComponent) c).getMargin();
            if (margin != null) {
                InsetsUtil.addTo(margin, insets);
            }
        }
        
        return insets;
    }
    
    @Override
    public boolean isBorderOpaque() {
        return false;
    }
    
    @Override
    public void paintBorder(Component c, Graphics g, int x, int y, int width, int height) {
        Insets margin = getVisualMargin(c, new Insets(0,0,0,0));
        Border border = getBorder(c);
        border.paintBorder(c, g,
                x + margin.left, y + margin.top,
                width - margin.left - margin.right,
                height - margin.top - margin.bottom
                );
        
        if (c instanceof JTextComponent) {
            Debug.paint(g, (JTextComponent) c, ((JTextComponent) c).getUI());
        }
    }
    
    public Border getBackgroundBorder() {
        return textFieldBackground;
    }
    
    private Border getBorder(Component c) {
        Border[] borders;
        if (isSearchField(c)) {
            if (isSmall(c)) {
                if (smallSearchBorders == null) {
                    smallSearchBorders = (Border[]) QuaquaBorderFactory.create(smallSearchImagesLocation, smallSearchImageInsets, 3, true);
                }
                borders = smallSearchBorders;
            } else {
                if (searchBorders == null) {
                    searchBorders = (Border[]) QuaquaBorderFactory.create(searchImagesLocation, searchImageInsets, 3, true);
                }
                borders = searchBorders;
            }
        } else {
            if (plainBorders == null) {
                plainBorders = (Border[]) QuaquaBorderFactory.create(imagesLocation, imageInsets, 3, true);
            }
            borders = plainBorders;
        }
        
        boolean isEditable;
        if (c instanceof JTextComponent) {
            isEditable = ((JTextComponent) c).isEditable();
        } else {
            isEditable = true;
        }

        if (QuaquaUtilities.isFocused(c) && c.isEnabled()) {
            return borders[2];
        } else if (c.isEnabled() && isEditable) {
            return borders[0];
        } else {
            return borders[1];
        }
    }
    
    
    public static class UIResource extends QuaquaTextFieldBorder implements javax.swing.plaf.UIResource {
        public UIResource(String imagesLocation, 
                String searchImagesLocation,
                String smallSearchImagesLocation) {
            this(imagesLocation, new Insets(6,6,5,6), 
                    searchImagesLocation, new Insets(13,13,13,13),
                    smallSearchImagesLocation, new Insets(11,13,11,13));
        }
        public UIResource(String imagesLocation, Insets imageInsets,
                String searchImagesLocation, Insets searchImageInsets,
                String smallSearchImagesLocation, Insets smallSearchImageInsets) {
            super(imagesLocation, imageInsets,
                    searchImagesLocation, searchImageInsets,
                    smallSearchImagesLocation, smallSearchImageInsets);
        }
    }
}