/*

 * 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.Graphics;

import java.awt.Insets;

import java.awt.Rectangle;

import java.beans.ConstructorProperties;

import javax.swing.JComponent;

import javax.swing.UIManager;

/**

 * 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>&quot;TitledBorder.border&quot;

 * <li>&quot;TitledBorder.font&quot;

 * <li>&quot;TitledBorder.titleColor&quot;

 * </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;

    /**

     * 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. */

    /** Position the title in the middle of the border's top line. */

    /** Position the title below the border's top line. */

    /** Position the title above the border's bottom line. */

    /** Position the title in the middle of the border's bottom line. */

    /** Position the title below the border's bottom line. */

    /**

     * 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. */

    /** Position title text in the center of the border line. */

    /** Position title text at the right side of the border line. */

    /** 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

     */

        this(null, title, LEADING, DEFAULT_POSITION, null, null);

    }

    /**

     * Creates a TitledBorder instance with the specified border

     * and an empty title.

     *

     * @param border  the 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,

        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,

        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,

        this.title = title;

        this.border = border;

        this.titleFont = titleFont;

        this.titleColor = titleColor;

        setTitleJustification(titleJustification);

        setTitlePosition(titlePosition);

    }

    /**

     * 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) {

            }

                }

                    }

                }

            }

        }

    }

    /**

     * 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) {

        }

        }

        }

        return insets;

    }

    /**

     * Returns whether or not the border is opaque.

     */

    public boolean isBorderOpaque() { return false; }

    /**

     * Returns the title of the titled border.

     */

    public String getTitle()        {       return title;   }

    /**

     * Returns the border of the titled border.

     */

    }

    /**

     * Returns the title-position of the titled border.

     */

    public int getTitlePosition() {

        return titlePosition;

    }

    /**

     * Returns the title-justification of the titled border.

     */

    public int getTitleJustification()      {       return titleJustification;      }

    /**

     * Returns the title-font of the titled border.

     */

    public Font getTitleFont()      {

    }

    /**

     * Returns the title-color of the titled border.

     */

    public Color getTitleColor()    {

    }

    // 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) {

                this.titlePosition = titlePosition;

                break;

        }

    }

    /**

     * 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:

          case LEFT:

          case CENTER:

          case RIGHT:

          case LEADING:

          case TRAILING:

            this.titleJustification = titleJustification;

            break;

          default:

            throw new IllegalArgumentException(titleJustification +

                                        " is not a valid title justification.");

        }

    }

    /**

     * Sets the title-font of the titled border.

     * @param titleFont the font for the border title

     */

    public void setTitleFont(Font titleFont) {

        this.titleFont = titleFont;

    }