/* * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */package javax.swing.border; import java.awt.Color;import java.awt.Component;import java.awt.Dimension;import java.awt.Font;import java.awt.Graphics;import java.awt.Graphics2D;import java.awt.Insets;import java.awt.Rectangle;import java.awt.geom.Path2D;import java.beans.ConstructorProperties;import javax.swing.JComponent;import javax.swing.JLabel;import javax.swing.UIManager;import javax.swing.plaf.basic.BasicHTML; /** * A class which implements an arbitrary border * with the addition of a String title in a * specified position and justification. * <p> * If the border, font, or color property values are not * specified in the constuctor or by invoking the appropriate * set methods, the property values will be defined by the current * look and feel, using the following property names in the * Defaults Table: * <ul> * <li>"TitledBorder.border" * <li>"TitledBorder.font" * <li>"TitledBorder.titleColor" * </ul> * <p> * <strong>Warning:</strong> * Serialized objects of this class will not be compatible with * future Swing releases. The current serialization support is * appropriate for short term storage or RMI between applications running * the same version of Swing. As of 1.4, support for long term storage * of all JavaBeans<sup><font size="-2">TM</font></sup> * has been added to the <code>java.beans</code> package. * Please see {@link java.beans.XMLEncoder}. * * @author David Kloba * @author Amy Fowler */public class TitledBorder extends AbstractBorder{ protected String title; protected Border border; protected int titlePosition; protected int titleJustification; protected Font titleFont; protected Color titleColor; private final JLabel label; /** * Use the default vertical orientation for the title text. */ static public final int DEFAULT_POSITION = 0; /** Position the title above the border's top line. */ static public final int ABOVE_TOP = 1; /** Position the title in the middle of the border's top line. */ static public final int TOP = 2; /** Position the title below the border's top line. */ static public final int BELOW_TOP = 3; /** Position the title above the border's bottom line. */ static public final int ABOVE_BOTTOM = 4; /** Position the title in the middle of the border's bottom line. */ static public final int BOTTOM = 5; /** Position the title below the border's bottom line. */ static public final int BELOW_BOTTOM = 6; /** * Use the default justification for the title text. */ static public final int DEFAULT_JUSTIFICATION = 0; /** Position title text at the left side of the border line. */ static public final int LEFT = 1; /** Position title text in the center of the border line. */ static public final int CENTER = 2; /** Position title text at the right side of the border line. */ static public final int RIGHT = 3; /** Position title text at the left side of the border line * for left to right orientation, at the right side of the * border line for right to left orientation. */ static public final int LEADING = 4; /** Position title text at the right side of the border line * for left to right orientation, at the left side of the * border line for right to left orientation. */ static public final int TRAILING = 5; // Space between the border and the component's edge static protected final int EDGE_SPACING = 2; // Space between the border and text static protected final int TEXT_SPACING = 2; // Horizontal inset of text that is left or right justified static protected final int TEXT_INSET_H = 5; /** * Creates a TitledBorder instance. * * @param title the title the border should display */ public TitledBorder(String title) { this(null, title, LEADING, DEFAULT_POSITION, null, null); } /** * Creates a TitledBorder instance with the specified border * and an empty title. * * @param border the border */ public TitledBorder(Border border) { this(border, "", LEADING, DEFAULT_POSITION, null, null); } /** * Creates a TitledBorder instance with the specified border * and title. * * @param border the border * @param title the title the border should display */ public TitledBorder(Border border, String title) { this(border, title, LEADING, DEFAULT_POSITION, null, null); } /** * Creates a TitledBorder instance with the specified border, * title, title-justification, and title-position. * * @param border the border * @param title the title the border should display * @param titleJustification the justification for the title * @param titlePosition the position for the title */ public TitledBorder(Border border, String title, int titleJustification, int titlePosition) { this(border, title, titleJustification, titlePosition, null, null); } /** * Creates a TitledBorder instance with the specified border, * title, title-justification, title-position, and title-font. * * @param border the border * @param title the title the border should display * @param titleJustification the justification for the title * @param titlePosition the position for the title * @param titleFont the font for rendering the title */ public TitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont) { this(border, title, titleJustification, titlePosition, titleFont, null); } /** * Creates a TitledBorder instance with the specified border, * title, title-justification, title-position, title-font, and * title-color. * * @param border the border * @param title the title the border should display * @param titleJustification the justification for the title * @param titlePosition the position for the title * @param titleFont the font of the title * @param titleColor the color of the title */ @ConstructorProperties({"border", "title", "titleJustification", "titlePosition", "titleFont", "titleColor"}) public TitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont, Color titleColor) { this.title = title; this.border = border; this.titleFont = titleFont; this.titleColor = titleColor; setTitleJustification(titleJustification); setTitlePosition(titlePosition); this.label = new JLabel(); this.label.setOpaque(false); this.label.putClientProperty(BasicHTML.propertyKey, null); } /** * Paints the border for the specified component with the * specified position and size. * @param c the component for which this border is being painted * @param g the paint graphics * @param x the x position of the painted border * @param y the y position of the painted border * @param width the width of the painted border * @param height the height of the painted border */ public void paintBorder(Component c, Graphics g, int x, int y, int width, int height) { Border border = getBorder(); String title = getTitle(); if ((title != null) && !title.isEmpty()) { int edge = (border instanceof TitledBorder) ? 0 : EDGE_SPACING; JLabel label = getLabel(c); Dimension size = label.getPreferredSize(); Insets insets = getBorderInsets(border, c, new Insets(0, 0, 0, 0)); int borderX = x + edge; int borderY = y + edge; int borderW = width - edge - edge; int borderH = height - edge - edge; int labelY = y; int labelH = size.height; int position = getPosition(); switch (position) { case ABOVE_TOP: insets.left = 0; insets.right = 0; borderY += labelH - edge; borderH -= labelH - edge; break; case TOP: insets.top = edge + insets.top/2 - labelH/2; if (insets.top < edge) { borderY -= insets.top; borderH += insets.top; } else { labelY += insets.top; } break; case BELOW_TOP: labelY += insets.top + edge; break; case ABOVE_BOTTOM: labelY += height - labelH - insets.bottom - edge; break; case BOTTOM: labelY += height - labelH; insets.bottom = edge + (insets.bottom - labelH) / 2; if (insets.bottom < edge) { borderH += insets.bottom; } else { labelY -= insets.bottom; } break; case BELOW_BOTTOM: insets.left = 0; insets.right = 0; labelY += height - labelH; borderH -= labelH - edge; break; } insets.left += edge + TEXT_INSET_H; insets.right += edge + TEXT_INSET_H; int labelX = x; int labelW = width - insets.left - insets.right; if (labelW > size.width) { labelW = size.width; } switch (getJustification(c)) { case LEFT: labelX += insets.left; break; case RIGHT: labelX += width - insets.right - labelW; break; case CENTER: labelX += (width - labelW) / 2; break; } if (border != null) { if ((position != TOP) && (position != BOTTOM)) { border.paintBorder(c, g, borderX, borderY, borderW, borderH); } else { Graphics g2 = g.create(); if (g2 instanceof Graphics2D) { Graphics2D g2d = (Graphics2D) g2; Path2D path = new Path2D.Float(); path.append(new Rectangle(borderX, borderY, borderW, labelY - borderY), false); path.append(new Rectangle(borderX, labelY, labelX - borderX - TEXT_SPACING, labelH), false); path.append(new Rectangle(labelX + labelW + TEXT_SPACING, labelY, borderX - labelX + borderW - labelW - TEXT_SPACING, labelH), false); path.append(new Rectangle(borderX, labelY + labelH, borderW, borderY - labelY + borderH - labelH), false); g2d.clip(path); } border.paintBorder(c, g2, borderX, borderY, borderW, borderH); g2.dispose(); } } g.translate(labelX, labelY); label.setSize(labelW, labelH); label.paint(g); g.translate(-labelX, -labelY); } else if (border != null) { border.paintBorder(c, g, x, y, width, height); } } /** * Reinitialize the insets parameter with this Border's current Insets. * @param c the component for which this border insets value applies * @param insets the object to be reinitialized */ public Insets getBorderInsets(Component c, Insets insets) { Border border = getBorder(); insets = getBorderInsets(border, c, insets); String title = getTitle(); if ((title != null) && !title.isEmpty()) { int edge = (border instanceof TitledBorder) ? 0 : EDGE_SPACING; JLabel label = getLabel(c); Dimension size = label.getPreferredSize(); switch (getPosition()) { case ABOVE_TOP: insets.top += size.height - edge; break; case TOP: { if (insets.top < size.height) { insets.top = size.height - edge; } break; } case BELOW_TOP: insets.top += size.height; break; case ABOVE_BOTTOM: insets.bottom += size.height; break; case BOTTOM: { if (insets.bottom < size.height) { insets.bottom = size.height - edge; } break; } case BELOW_BOTTOM: insets.bottom += size.height - edge; break; } insets.top += edge + TEXT_SPACING; insets.left += edge + TEXT_SPACING; insets.right += edge + TEXT_SPACING; insets.bottom += edge + TEXT_SPACING; } return insets; } /** * Returns whether or not the border is opaque. */ public boolean isBorderOpaque() { return false; } /** * Returns the title of the titled border. * * @return the title of the titled border */ public String getTitle() { return title; } /** * Returns the border of the titled border. * * @return the border of the titled border */ public Border getBorder() { return border != null ? border : UIManager.getBorder("TitledBorder.border"); } /** * Returns the title-position of the titled border. * * @return the title-position of the titled border */ public int getTitlePosition() { return titlePosition; } /** * Returns the title-justification of the titled border. * * @return the title-justification of the titled border */ public int getTitleJustification() { return titleJustification; } /** * Returns the title-font of the titled border. * * @return the title-font of the titled border */ public Font getTitleFont() { return titleFont; } /** * Returns the title-color of the titled border. * * @return the title-color of the titled border */ public Color getTitleColor() { return titleColor; } // REMIND(aim): remove all or some of these set methods? /** * Sets the title of the titled border. * @param title the title for the border */ public void setTitle(String title) { this.title = title; } /** * Sets the border of the titled border. * @param border the border */ public void setBorder(Border border) { this.border = border; } /** * Sets the title-position of the titled border. * @param titlePosition the position for the border */ public void setTitlePosition(int titlePosition) { switch (titlePosition) { case ABOVE_TOP: case TOP: case BELOW_TOP: case ABOVE_BOTTOM: case BOTTOM: case BELOW_BOTTOM: case DEFAULT_POSITION: this.titlePosition = titlePosition; break; default: throw new IllegalArgumentException(titlePosition + " is not a valid title position."); } } /** * Sets the title-justification of the titled border. * @param titleJustification the justification for the border */ public void setTitleJustification(int titleJustification) { switch (titleJustification) { case DEFAULT_JUSTIFICATION:Lines 1–500 of 733. Load more
/* * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javax.swing.border; import java.awt.Color; import java.awt.Component; import java.awt.Dimension; import java.awt.Font; import java.awt.Graphics; import java.awt.Graphics2D; import java.awt.Insets; import java.awt.Rectangle; import java.awt.geom.Path2D; import java.beans.ConstructorProperties; import javax.swing.JComponent; import javax.swing.JLabel; import javax.swing.UIManager; import javax.swing.plaf.basic.BasicHTML; /** * A class which implements an arbitrary border * with the addition of a String title in a * specified position and justification. * <p> * If the border, font, or color property values are not * specified in the constuctor or by invoking the appropriate * set methods, the property values will be defined by the current * look and feel, using the following property names in the * Defaults Table: * <ul> * <li>"TitledBorder.border" * <li>"TitledBorder.font" * <li>"TitledBorder.titleColor" * </ul> * <p> * <strong>Warning:</strong> * Serialized objects of this class will not be compatible with * future Swing releases. The current serialization support is * appropriate for short term storage or RMI between applications running * the same version of Swing. As of 1.4, support for long term storage * of all JavaBeans<sup><font size="-2">TM</font></sup> * has been added to the <code>java.beans</code> package. * Please see {@link java.beans.XMLEncoder}. * * @author David Kloba * @author Amy Fowler */ public class TitledBorder extends AbstractBorder { protected String title; protected Border border; protected int titlePosition; protected int titleJustification; protected Font titleFont; protected Color titleColor; private final JLabel label; /** * Use the default vertical orientation for the title text. */ static public final int DEFAULT_POSITION = 0; /** Position the title above the border's top line. */ static public final int ABOVE_TOP = 1; /** Position the title in the middle of the border's top line. */ static public final int TOP = 2; /** Position the title below the border's top line. */ static public final int BELOW_TOP = 3; /** Position the title above the border's bottom line. */ static public final int ABOVE_BOTTOM = 4; /** Position the title in the middle of the border's bottom line. */ static public final int BOTTOM = 5; /** Position the title below the border's bottom line. */ static public final int BELOW_BOTTOM = 6; /** * Use the default justification for the title text. */ static public final int DEFAULT_JUSTIFICATION = 0; /** Position title text at the left side of the border line. */ static public final int LEFT = 1; /** Position title text in the center of the border line. */ static public final int CENTER = 2; /** Position title text at the right side of the border line. */ static public final int RIGHT = 3; /** Position title text at the left side of the border line * for left to right orientation, at the right side of the * border line for right to left orientation. */ static public final int LEADING = 4; /** Position title text at the right side of the border line * for left to right orientation, at the left side of the * border line for right to left orientation. */ static public final int TRAILING = 5; // Space between the border and the component's edge static protected final int EDGE_SPACING = 2; // Space between the border and text static protected final int TEXT_SPACING = 2; // Horizontal inset of text that is left or right justified static protected final int TEXT_INSET_H = 5; /** * Creates a TitledBorder instance. * * @param title the title the border should display */ public TitledBorder(String title) { this(null, title, LEADING, DEFAULT_POSITION, null, null); } /** * Creates a TitledBorder instance with the specified border * and an empty title. * * @param border the border */ public TitledBorder(Border border) { this(border, "", LEADING, DEFAULT_POSITION, null, null); } /** * Creates a TitledBorder instance with the specified border * and title. * * @param border the border * @param title the title the border should display */ public TitledBorder(Border border, String title) { this(border, title, LEADING, DEFAULT_POSITION, null, null); } /** * Creates a TitledBorder instance with the specified border, * title, title-justification, and title-position. * * @param border the border * @param title the title the border should display * @param titleJustification the justification for the title * @param titlePosition the position for the title */ public TitledBorder(Border border, String title, int titleJustification, int titlePosition) { this(border, title, titleJustification, titlePosition, null, null); } /** * Creates a TitledBorder instance with the specified border, * title, title-justification, title-position, and title-font. * * @param border the border * @param title the title the border should display * @param titleJustification the justification for the title * @param titlePosition the position for the title * @param titleFont the font for rendering the title */ public TitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont) { this(border, title, titleJustification, titlePosition, titleFont, null); } /** * Creates a TitledBorder instance with the specified border, * title, title-justification, title-position, title-font, and * title-color. * * @param border the border * @param title the title the border should display * @param titleJustification the justification for the title * @param titlePosition the position for the title * @param titleFont the font of the title * @param titleColor the color of the title */ @ConstructorProperties({"border", "title", "titleJustification", "titlePosition", "titleFont", "titleColor"}) public TitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont, Color titleColor) { this.title = title; this.border = border; this.titleFont = titleFont; this.titleColor = titleColor; setTitleJustification(titleJustification); setTitlePosition(titlePosition); this.label = new JLabel(); this.label.setOpaque(false); this.label.putClientProperty(BasicHTML.propertyKey, null); } /** * Paints the border for the specified component with the * specified position and size. * @param c the component for which this border is being painted * @param g the paint graphics * @param x the x position of the painted border * @param y the y position of the painted border * @param width the width of the painted border * @param height the height of the painted border */ public void paintBorder(Component c, Graphics g, int x, int y, int width, int height) { Border border = getBorder(); String title = getTitle(); if ((title != null) && !title.isEmpty()) { int edge = (border instanceof TitledBorder) ? 0 : EDGE_SPACING; JLabel label = getLabel(c); Dimension size = label.getPreferredSize(); Insets insets = getBorderInsets(border, c, new Insets(0, 0, 0, 0)); int borderX = x + edge; int borderY = y + edge; int borderW = width - edge - edge; int borderH = height - edge - edge; int labelY = y; int labelH = size.height; int position = getPosition(); switch (position) { case ABOVE_TOP: insets.left = 0; insets.right = 0; borderY += labelH - edge; borderH -= labelH - edge; break; case TOP: insets.top = edge + insets.top/2 - labelH/2; if (insets.top < edge) { borderY -= insets.top; borderH += insets.top; } else { labelY += insets.top; } break; case BELOW_TOP: labelY += insets.top + edge; break; case ABOVE_BOTTOM: labelY += height - labelH - insets.bottom - edge; break; case BOTTOM: labelY += height - labelH; insets.bottom = edge + (insets.bottom - labelH) / 2; if (insets.bottom < edge) { borderH += insets.bottom; } else { labelY -= insets.bottom; } break; case BELOW_BOTTOM: insets.left = 0; insets.right = 0; labelY += height - labelH; borderH -= labelH - edge; break; } insets.left += edge + TEXT_INSET_H; insets.right += edge + TEXT_INSET_H; int labelX = x; int labelW = width - insets.left - insets.right; if (labelW > size.width) { labelW = size.width; } switch (getJustification(c)) { case LEFT: labelX += insets.left; break; case RIGHT: labelX += width - insets.right - labelW; break; case CENTER: labelX += (width - labelW) / 2; break; } if (border != null) { if ((position != TOP) && (position != BOTTOM)) { border.paintBorder(c, g, borderX, borderY, borderW, borderH); } else { Graphics g2 = g.create(); if (g2 instanceof Graphics2D) { Graphics2D g2d = (Graphics2D) g2; Path2D path = new Path2D.Float(); path.append(new Rectangle(borderX, borderY, borderW, labelY - borderY), false); path.append(new Rectangle(borderX, labelY, labelX - borderX - TEXT_SPACING, labelH), false); path.append(new Rectangle(labelX + labelW + TEXT_SPACING, labelY, borderX - labelX + borderW - labelW - TEXT_SPACING, labelH), false); path.append(new Rectangle(borderX, labelY + labelH, borderW, borderY - labelY + borderH - labelH), false); g2d.clip(path); } border.paintBorder(c, g2, borderX, borderY, borderW, borderH); g2.dispose(); } } g.translate(labelX, labelY); label.setSize(labelW, labelH); label.paint(g); g.translate(-labelX, -labelY); } else if (border != null) { border.paintBorder(c, g, x, y, width, height); } } /** * Reinitialize the insets parameter with this Border's current Insets. * @param c the component for which this border insets value applies * @param insets the object to be reinitialized */ public Insets getBorderInsets(Component c, Insets insets) { Border border = getBorder(); insets = getBorderInsets(border, c, insets); String title = getTitle(); if ((title != null) && !title.isEmpty()) { int edge = (border instanceof TitledBorder) ? 0 : EDGE_SPACING; JLabel label = getLabel(c); Dimension size = label.getPreferredSize(); switch (getPosition()) { case ABOVE_TOP: insets.top += size.height - edge; break; case TOP: { if (insets.top < size.height) { insets.top = size.height - edge; } break; } case BELOW_TOP: insets.top += size.height; break; case ABOVE_BOTTOM: insets.bottom += size.height; break; case BOTTOM: { if (insets.bottom < size.height) { insets.bottom = size.height - edge; } break; } case BELOW_BOTTOM: insets.bottom += size.height - edge; break; } insets.top += edge + TEXT_SPACING; insets.left += edge + TEXT_SPACING; insets.right += edge + TEXT_SPACING; insets.bottom += edge + TEXT_SPACING; } return insets; } /** * Returns whether or not the border is opaque. */ public boolean isBorderOpaque() { return false; } /** * Returns the title of the titled border. * * @return the title of the titled border */ public String getTitle() { return title; } /** * Returns the border of the titled border. * * @return the border of the titled border */ public Border getBorder() { return border != null ? border : UIManager.getBorder("TitledBorder.border"); } /** * Returns the title-position of the titled border. * * @return the title-position of the titled border */ public int getTitlePosition() { return titlePosition; } /** * Returns the title-justification of the titled border. * * @return the title-justification of the titled border */ public int getTitleJustification() { return titleJustification; } /** * Returns the title-font of the titled border. * * @return the title-font of the titled border */ public Font getTitleFont() { return titleFont; } /** * Returns the title-color of the titled border. * * @return the title-color of the titled border */ public Color getTitleColor() { return titleColor; } // REMIND(aim): remove all or some of these set methods? /** * Sets the title of the titled border. * @param title the title for the border */ public void setTitle(String title) { this.title = title; } /** * Sets the border of the titled border. * @param border the border */ public void setBorder(Border border) { this.border = border; } /** * Sets the title-position of the titled border. * @param titlePosition the position for the border */ public void setTitlePosition(int titlePosition) { switch (titlePosition) { case ABOVE_TOP: case TOP: case BELOW_TOP: case ABOVE_BOTTOM: case BOTTOM: case BELOW_BOTTOM: case DEFAULT_POSITION: this.titlePosition = titlePosition; break; default: throw new IllegalArgumentException(titlePosition + " is not a valid title position."); } } /** * Sets the title-justification of the titled border. * @param titleJustification the justification for the border */ public void setTitleJustification(int titleJustification) { switch (titleJustification) { case DEFAULT_JUSTIFICATION: