Package org.jdesktop.swingx.plaf.basic

Class BasicTitledPanelUI

java.lang.Object
javax.swing.plaf.ComponentUI
javax.swing.plaf.PanelUI
org.jdesktop.swingx.plaf.TitledPanelUI
org.jdesktop.swingx.plaf.basic.BasicTitledPanelUI
public class BasicTitledPanelUI extends TitledPanelUI
All TitledPanels contain a title section and a content section. The default implementation for the title section relies on a Gradient background. All title sections can have components embedded to the "left" or "right" of the Title.
Author:
Richard Bair, Jeanette Winzenburg, rah003

  • Field Details

    • caption

      protected JLabel caption
      JLabel used for the title in the Title section of the JTitledPanel.

    • topPanel

      protected JXPanel topPanel
      The Title section panel.

    • titleChangeListener

      protected PropertyChangeListener titleChangeListener
      Listens to changes in the title of the JXTitledPanel component

    • left

      protected JComponent left
      component embedded to the left

  • Constructor Details

    • BasicTitledPanelUI

      public BasicTitledPanelUI()
      Creates a new instance of BasicTitledPanelUI

  • Method Details

    • createUI

      public static ComponentUI createUI(JComponent c)
      Returns an instance of the UI delegate for the specified component. Each subclass must provide its own static createUI method that returns an instance of that UI delegate subclass. If the UI delegate subclass is stateless, it may return an instance that is shared by multiple components. If the UI delegate is stateful, then it should return a new instance per component. The default implementation of this method throws an error, as it should never be invoked.
      Parameters:
      c - the component
      Returns:
      an instance of the UI delegate for the specified component

    • installUI

      public void installUI(JComponent c)
      Configures the specified component appropriate for the look and feel. This method is invoked when the ComponentUI instance is being installed as the UI delegate on the specified component. This method should completely configure the component for the look and feel, including the following:
      1. Install any default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should not be overridden.
      2. Install a LayoutManager on the component if necessary.
      3. Create/add any required sub-components to the component.
      4. Create/install event listeners on the component.
      5. Create/install a PropertyChangeListener on the component in order to detect and respond to component property changes appropriately.
      6. Install keyboard UI (mnemonics, traversal, etc.) on the component.
      7. Initialize any appropriate instance data.
      Overrides:
      installUI in class ComponentUI
      Parameters:
      c - the component where this UI delegate is being installed
      See Also:

    • installDefaults

      protected void installDefaults(JXTitledPanel titledPanel)
      TODO doc
      Parameters:
      titledPanel - JXTitledPanel

    • uninstallDefaults

      protected void uninstallDefaults(JXTitledPanel titledPanel)
      TODO doc
      Parameters:
      titledPanel - JXTitledPanel

    • installComponents

      protected void installComponents(JXTitledPanel titledPanel)
      TODO doc
      Parameters:
      titledPanel - JXTitledPanel

    • uninstallComponents

      protected void uninstallComponents(JXTitledPanel titledPanel)
      TODO doc
      Parameters:
      titledPanel - JXTitledPanel

    • getCaptionInsets

      protected Insets getCaptionInsets()
      TODO doc
      Returns:
      Insets

    • createAndConfigureTopPanel

      protected JXPanel createAndConfigureTopPanel(JXTitledPanel titledPanel)
      TODO doc
      Parameters:
      titledPanel - JXTitledPanel
      Returns:
      JXPanel

    • createAndConfigureCaption

      protected JLabel createAndConfigureCaption(JXTitledPanel titledPanel)
      TODO doc
      Parameters:
      titledPanel - JXTitledPanel
      Returns:
      JLabel

    • uninstallUI

      public void uninstallUI(JComponent c)
      Reverses configuration which was done on the specified component during installUI. This method is invoked when this UIComponent instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed in installUI, being careful to leave the JComponent instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following:
      1. Remove any UI-set borders from the component.
      2. Remove any UI-set layout managers on the component.
      3. Remove any UI-added sub-components from the component.
      4. Remove any UI-added event/property listeners from the component.
      5. Remove any UI-installed keyboard UI from the component.
      6. Nullify any allocated instance data objects to allow for GC.
      Overrides:
      uninstallUI in class ComponentUI
      Parameters:
      c - the component from which this UI delegate is being removed; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
      See Also:

    • installListeners

      protected void installListeners(JXTitledPanel titledPanel)
      TODO doc
      Parameters:
      titledPanel - JXTitledPanel

    • uninstallListeners

      protected void uninstallListeners(JXTitledPanel titledPanel)
      TODO doc
      Parameters:
      titledPanel - JXTitledPanel

    • installProperty

      protected void installProperty(JComponent c, String propName, Object value)
      JXTitledPanel
      Parameters:
      c - JComponent
      propName - String
      value - Object

    • paint

      public void paint(Graphics g, JComponent c)
      Paints the specified component appropriate for the look and feel. This method is invoked from the ComponentUI.update method when the specified component is being painted. Subclasses should override this method and use the specified Graphics object to render the content of the component.

      PENDING JW: we don't need this, do we - remove!

      Overrides:
      paint in class ComponentUI
      Parameters:
      g - the Graphics context in which to paint
      c - the component being painted; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
      See Also:

    • setRightDecoration

      public void setRightDecoration(JComponent decoration)
      Adds the given JComponent as a decoration on the right of the title
      Specified by:
      setRightDecoration in class TitledPanelUI
      Parameters:
      decoration - component

    • getRightDecoration

      public JComponent getRightDecoration()
      Description copied from class: TitledPanelUI
      TODO doc
      Specified by:
      getRightDecoration in class TitledPanelUI
      Returns:
      JComponent

    • setLeftDecoration

      public void setLeftDecoration(JComponent decoration)
      Adds the given JComponent as a decoration on the left of the title
      Specified by:
      setLeftDecoration in class TitledPanelUI
      Parameters:
      decoration - component

    • getLeftDecoration

      public JComponent getLeftDecoration()
      Description copied from class: TitledPanelUI
      TODO doc
      Specified by:
      getLeftDecoration in class TitledPanelUI
      Returns:
      JComponent

    • getTitleBar

      public Container getTitleBar()
      Specified by:
      getTitleBar in class TitledPanelUI
      Returns:
      the Container acting as the title bar for this component