Package org.jdesktop.swingx

Class JXHeader

  • All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible, Scrollable
    public class JXHeader
extends JXPanel

    JXHeader is a simple component consisting of a title, a description, and an icon. An example of such a component can be seen on Romain Guys ProgX website

    JXHeader is a simple component that is also sufficiently configurable to be usable. The description area accepts HTML conforming to version 3.2 of the HTML standard. The icon, title, and description are all configurable. JXHeader itself extends JXPanel, providing translucency and painting delegates.

    If I were to reconstruct the ui shown in the above screenshot, I might do so like this:

    
      JXHeader header = new JXHeader();
      header.setTitle("Timing Framework Spline Editor");
      header.setDescription("Drag control points in the display to change the " +
          "shape of the spline\n" +
          "Click the Copy Code button to generate the corresponding Java code.");
      Icon icon = new ImageIcon(getClass().getResource("tools.png"));
      header.setIcon(icon);

    Note: The HTML support doesn't exist yet. The UI delegate needs to discover whether the text supplied is HTML or not, and change the content type of the editor pane being used. The problem is that if "text/html" is always used, the font is wrong. This same situation will be found in other parts of the code (JXErrorPane, for instance), so this needs to be dealt with.

    Defaults

    BasicHeaderUI uses the following UI defaults:

    • Header.defaultIcon: The default icon to use when creating a new JXHeader.

    Author:
    rbair, rah003
    See Also:
    Serialized Form

    • Constructor Detail

      • JXHeader

        public JXHeader()
        Creates a new instance of JXHeader

      • JXHeader

        public JXHeader​(String title,
                String description)
        Creates a new instance of JXHeader. PropertyChangeEvents are fired when the title and description properties are set.
        Parameters:
        title - specifies the title property for this JXHeader
        description - specifies the description property for this JXHeader

      • JXHeader

        public JXHeader​(String title,
                String description,
                Icon icon)
        Creates a new instance of JXHeader. PropertyChangeEvents are fired when the title and description properties are set.
        Parameters:
        title - specifies the title property for this JXHeader
        description - specifies the description property for this JXHeader
        icon - specifies the icon property for this JXHeader

    • Method Detail

      • updateUI

        public void updateUI()
        Notification from the UIManager that the L&F has changed. Replaces the current UI object with the latest version from the UIManager.
        Overrides:
        updateUI in class JPanel
        See Also:
        JComponent.updateUI()

      • setTitle

        public void setTitle​(String title)
        Sets the title to use. This may be either plain text, or a simplified version of HTML, as JLabel would use.
        Parameters:
        title - the Title. May be null.

      • getTitle

        public String getTitle()
        Gets the title. This may use HTML, such as that supported by JLabel (version 3.2 of the HTML spec).
        Returns:
        the title. May be null.

      • setDescription

        public void setDescription​(String description)
        Sets the description for this header. This may use HTML, such as that supported by JLabel (version 3.2 of the HTML spec).
        Parameters:
        description - the description. May be null, may be HTML or plain text.

      • getDescription

        public String getDescription()
        Gets the description.
        Returns:
        description

      • setIcon

        public void setIcon​(Icon icon)
        Sets the icon to use for the header. It is generally recommended that this be an image 64x64 pixels in size, and that the icon have no gaps at the top.
        Parameters:
        icon - may be null

      • getIcon

        public Icon getIcon()
        Gets the icon.
        Returns:
        the Icon being used. May be null.

      • setTitleFont

        public void setTitleFont​(Font font)
        Sets new font for title.
        Parameters:
        font - New title font.

      • getTitleFont

        public Font getTitleFont()
        Gets title font.
        Returns:
        the Font being used. May be null.

      • setDescriptionFont

        public void setDescriptionFont​(Font font)
        Sets font for the description line of header.
        Parameters:
        font - New description font.

      • getDescriptionFont

        public Font getDescriptionFont()
        Gets description font.
        Returns:
        the Font being used. May be null.

      • getTitleForeground

        public Color getTitleForeground()
        Gets current title foreground color.
        Returns:
        the Color used to paint title. May be null.

      • setTitleForeground

        public void setTitleForeground​(Color titleForeground)
        Sets title foreground color.
        Parameters:
        titleForeground - the Color to be used to paint title.

      • getDescriptionForeground

        public Color getDescriptionForeground()
        Gets current description foreground color.
        Returns:
        the Color used to paint description. May be null.

      • setDescriptionForeground

        public void setDescriptionForeground​(Color descriptionForeground)
        Sets description foreground color.
        Parameters:
        descriptionForeground - the Color to be used to paint description.

      • getIconPosition

        public JXHeader.IconPosition getIconPosition()
        Gets current icon position. Default is RIGHT.
        Returns:
        Current Icon position.

      • setIconPosition

        public void setIconPosition​(JXHeader.IconPosition iconPosition)
        Sets new Icon position. Position is relative to the text. Default value is RIGHT.
        Parameters:
        iconPosition - new desired icon position
        See Also:
        getIconPosition()