Package com.jidesoft.swing

Class JideTitledBorder

  • All Implemented Interfaces:
    java.io.Serializable, javax.swing.border.Border
    public class JideTitledBorder
extends javax.swing.border.AbstractBorder
    The source code is the same as TitledBorder in JDK 1.4.2 except field TEXT_INSET_H is 0 instead of 5.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ABOVE_BOTTOM
      Position the title above the border's bottom line.
      static int ABOVE_TOP
      Position the title above the border's top line.
      static int BELOW_BOTTOM
      Position the title below the border's bottom line.
      static int BELOW_TOP
      Position the title below the border's top line.
      protected javax.swing.border.Border border  
      static int BOTTOM
      Position the title in the middle of the border's bottom line.
      static int CENTER
      Position title text in the center of the border line.
      static int DEFAULT_JUSTIFICATION
      Use the default justification for the title text.
      static int DEFAULT_POSITION
      Use the default vertical orientation for the title text.
      protected static int EDGE_SPACING  
      static int LEADING
      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 int LEFT
      Position title text at the left side of the border line.
      static int RIGHT
      Position title text at the right side of the border line.
      protected static int TEXT_INSET_H  
      protected static int TEXT_SPACING  
      protected java.lang.String title  
      protected java.awt.Color titleColor  
      protected java.awt.Font titleFont  
      protected int titleJustification  
      protected int titlePosition  
      static int TOP
      Position the title in the middle of the border's top line.
      static int TRAILING
      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.

    • Constructor Summary

      Constructors 
      Constructor Description
      JideTitledBorder​(java.lang.String title)
      Creates a JideTitledBorder instance.
      JideTitledBorder​(javax.swing.border.Border border)
      Creates a JideTitledBorder instance with the specified border and an empty title.
      JideTitledBorder​(javax.swing.border.Border border, java.lang.String title)
      Creates a JideTitledBorder instance with the specified border and title.
      JideTitledBorder​(javax.swing.border.Border border, java.lang.String title, int titleJustification, int titlePosition)
      Creates a JideTitledBorder instance with the specified border, title, title-justification, and title-position.
      JideTitledBorder​(javax.swing.border.Border border, java.lang.String title, int titleJustification, int titlePosition, java.awt.Font titleFont)
      Creates a JideTitledBorder instance with the specified border, title, title-justification, title-position, and title-font.
      JideTitledBorder​(javax.swing.border.Border border, java.lang.String title, int titleJustification, int titlePosition, java.awt.Font titleFont, java.awt.Color titleColor)
      Creates a JideTitledBorder instance with the specified border, title, title-justification, title-position, title-font, and title-color.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getBaseline​(java.awt.Component c, int width, int height)
      Returns the baseline.
      java.awt.Component.BaselineResizeBehavior getBaselineResizeBehavior​(java.awt.Component c)
      Returns an enum indicating how the baseline of the border changes as the size changes.
      javax.swing.border.Border getBorder()
      Returns the border of the titled border.
      java.awt.Insets getBorderInsets​(java.awt.Component c)
      This default implementation returns a new Insets instance where the top, left, bottom, and right fields are set to 0.
      java.awt.Insets getBorderInsets​(java.awt.Component c, java.awt.Insets insets)
      Reinitialize the insets parameter with this Border's current Insets.
      protected java.awt.Font getFont​(java.awt.Component c)  
      java.awt.Dimension getMinimumSize​(java.awt.Component c)
      Returns the minimum dimensions this border requires in order to fully display the border and title.
      java.lang.String getTitle()
      Returns the title of the titled border.
      java.awt.Color getTitleColor()
      Returns the title-color of the titled border.
      java.awt.Font getTitleFont()
      Returns the title-font of the titled border.
      int getTitleJustification()
      Returns the title-justification of the titled border.
      int getTitlePosition()
      Returns the title-position of the titled border.
      boolean isBorderOpaque()
      Returns whether or not the border is opaque.
      void paintBorder​(java.awt.Component c, java.awt.Graphics g, int x, int y, int width, int height)
      Paints the border for the specified component with the specified position and size.
      void setBorder​(javax.swing.border.Border border)
      Sets the border of the titled border.
      void setTitle​(java.lang.String title)
      Sets the title of the titled border.
      void setTitleColor​(java.awt.Color titleColor)
      Sets the title-color of the titled border.
      void setTitleFont​(java.awt.Font titleFont)
      Sets the title-font of the titled border.
      void setTitleJustification​(int titleJustification)
      Sets the title-justification of the titled border.
      void setTitlePosition​(int titlePosition)
      Sets the title-position of the titled border.

      • Methods inherited from class javax.swing.border.AbstractBorder

        getInteriorRectangle, getInteriorRectangle

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • title

        protected java.lang.String title

      • border

        protected javax.swing.border.Border border

      • titlePosition

        protected int titlePosition

      • titleJustification

        protected int titleJustification

      • titleFont

        protected java.awt.Font titleFont

      • titleColor

        protected java.awt.Color titleColor

      • DEFAULT_POSITION

        public static final int DEFAULT_POSITION
        Use the default vertical orientation for the title text.
        See Also:
        Constant Field Values

      • ABOVE_TOP

        public static final int ABOVE_TOP
        Position the title above the border's top line.
        See Also:
        Constant Field Values

      • TOP

        public static final int TOP
        Position the title in the middle of the border's top line.
        See Also:
        Constant Field Values

      • BELOW_TOP

        public static final int BELOW_TOP
        Position the title below the border's top line.
        See Also:
        Constant Field Values

      • ABOVE_BOTTOM

        public static final int ABOVE_BOTTOM
        Position the title above the border's bottom line.
        See Also:
        Constant Field Values

      • BOTTOM

        public static final int BOTTOM
        Position the title in the middle of the border's bottom line.
        See Also:
        Constant Field Values

      • BELOW_BOTTOM

        public static final int BELOW_BOTTOM
        Position the title below the border's bottom line.
        See Also:
        Constant Field Values

      • DEFAULT_JUSTIFICATION

        public static final int DEFAULT_JUSTIFICATION
        Use the default justification for the title text.
        See Also:
        Constant Field Values

      • LEFT

        public static final int LEFT
        Position title text at the left side of the border line.
        See Also:
        Constant Field Values

      • CENTER

        public static final int CENTER
        Position title text in the center of the border line.
        See Also:
        Constant Field Values

      • RIGHT

        public static final int RIGHT
        Position title text at the right side of the border line.
        See Also:
        Constant Field Values

      • LEADING

        public static final int LEADING
        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.
        See Also:
        Constant Field Values

      • TRAILING

        public static final int TRAILING
        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.
        See Also:
        Constant Field Values

    • Constructor Detail

      • JideTitledBorder

        public JideTitledBorder​(java.lang.String title)
        Creates a JideTitledBorder instance.
        Parameters:
        title - the title the border should display

      • JideTitledBorder

        public JideTitledBorder​(javax.swing.border.Border border)
        Creates a JideTitledBorder instance with the specified border and an empty title.
        Parameters:
        border - the border

      • JideTitledBorder

        public JideTitledBorder​(javax.swing.border.Border border,
                        java.lang.String title)
        Creates a JideTitledBorder instance with the specified border and title.
        Parameters:
        border - the border
        title - the title the border should display

      • JideTitledBorder

        public JideTitledBorder​(javax.swing.border.Border border,
                        java.lang.String title,
                        int titleJustification,
                        int titlePosition)
        Creates a JideTitledBorder instance with the specified border, title, title-justification, and title-position.
        Parameters:
        border - the border
        title - the title the border should display
        titleJustification - the justification for the title
        titlePosition - the position for the title

      • JideTitledBorder

        public JideTitledBorder​(javax.swing.border.Border border,
                        java.lang.String title,
                        int titleJustification,
                        int titlePosition,
                        java.awt.Font titleFont)
        Creates a JideTitledBorder instance with the specified border, title, title-justification, title-position, and title-font.
        Parameters:
        border - the border
        title - the title the border should display
        titleJustification - the justification for the title
        titlePosition - the position for the title
        titleFont - the font for rendering the title

      • JideTitledBorder

        @ConstructorProperties({"border","title","titleJustification","titlePosition","titleFont","titleColor"})
public JideTitledBorder​(javax.swing.border.Border border,
                        java.lang.String title,
                        int titleJustification,
                        int titlePosition,
                        java.awt.Font titleFont,
                        java.awt.Color titleColor)
        Creates a JideTitledBorder instance with the specified border, title, title-justification, title-position, title-font, and title-color.
        Parameters:
        border - the border
        title - the title the border should display
        titleJustification - the justification for the title
        titlePosition - the position for the title
        titleFont - the font of the title
        titleColor - the color of the title

    • Method Detail

      • paintBorder

        public void paintBorder​(java.awt.Component c,
                        java.awt.Graphics g,
                        int x,
                        int y,
                        int width,
                        int height)
        Paints the border for the specified component with the specified position and size.
        Specified by:
        paintBorder in interface javax.swing.border.Border
        Overrides:
        paintBorder in class javax.swing.border.AbstractBorder
        Parameters:
        c - the component for which this border is being painted
        g - the paint graphics
        x - the x position of the painted border
        y - the y position of the painted border
        width - the width of the painted border
        height - the height of the painted border

      • getBorderInsets

        public java.awt.Insets getBorderInsets​(java.awt.Component c)
        This default implementation returns a new Insets instance where the top, left, bottom, and right fields are set to 0.
        Specified by:
        getBorderInsets in interface javax.swing.border.Border
        Overrides:
        getBorderInsets in class javax.swing.border.AbstractBorder
        Parameters:
        c - the component for which this border insets value applies
        Returns:
        the new Insets object initialized to 0

      • getBorderInsets

        public java.awt.Insets getBorderInsets​(java.awt.Component c,
                                       java.awt.Insets insets)
        Reinitialize the insets parameter with this Border's current Insets.
        Overrides:
        getBorderInsets in class javax.swing.border.AbstractBorder
        Parameters:
        c - the component for which this border insets value applies
        insets - the object to be reinitialized

      • isBorderOpaque

        public boolean isBorderOpaque()
        Returns whether or not the border is opaque.
        Specified by:
        isBorderOpaque in interface javax.swing.border.Border
        Overrides:
        isBorderOpaque in class javax.swing.border.AbstractBorder

      • getTitle

        public java.lang.String getTitle()
        Returns the title of the titled border.

      • getBorder

        public javax.swing.border.Border getBorder()
        Returns the border of the titled border.

      • getTitlePosition

        public int getTitlePosition()
        Returns the title-position of the titled border.

      • getTitleJustification

        public int getTitleJustification()
        Returns the title-justification of the titled border.

      • getTitleFont

        public java.awt.Font getTitleFont()
        Returns the title-font of the titled border.

      • getTitleColor

        public java.awt.Color getTitleColor()
        Returns the title-color of the titled border.

      • setTitle

        public void setTitle​(java.lang.String title)
        Sets the title of the titled border. param title the title for the border

      • setBorder

        public void setBorder​(javax.swing.border.Border border)
        Sets the border of the titled border.
        Parameters:
        border - the border

      • setTitlePosition

        public void setTitlePosition​(int titlePosition)
        Sets the title-position of the titled border.
        Parameters:
        titlePosition - the position for the border

      • setTitleJustification

        public void setTitleJustification​(int titleJustification)
        Sets the title-justification of the titled border.
        Parameters:
        titleJustification - the justification for the border

      • setTitleFont

        public void setTitleFont​(java.awt.Font titleFont)
        Sets the title-font of the titled border.
        Parameters:
        titleFont - the font for the border title

      • setTitleColor

        public void setTitleColor​(java.awt.Color titleColor)
        Sets the title-color of the titled border.
        Parameters:
        titleColor - the color for the border title

      • getMinimumSize

        public java.awt.Dimension getMinimumSize​(java.awt.Component c)
        Returns the minimum dimensions this border requires in order to fully display the border and title.
        Parameters:
        c - the component where this border will be drawn

      • getBaseline

        public int getBaseline​(java.awt.Component c,
                       int width,
                       int height)
        Returns the baseline.
        Overrides:
        getBaseline in class javax.swing.border.AbstractBorder
        Throws:
        java.lang.NullPointerException
        java.lang.IllegalArgumentException
        Since:
        1.6
        See Also:
        JComponent.getBaseline(int, int)

      • getBaselineResizeBehavior

        public java.awt.Component.BaselineResizeBehavior getBaselineResizeBehavior​(java.awt.Component c)
        Returns an enum indicating how the baseline of the border changes as the size changes.
        Overrides:
        getBaselineResizeBehavior in class javax.swing.border.AbstractBorder
        Throws:
        java.lang.NullPointerException
        Since:
        1.6
        See Also:
        JComponent.getBaseline(int, int)

      • getFont

        protected java.awt.Font getFont​(java.awt.Component c)