Package org.jdesktop.swingx

Class JXStatusBar

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
org.jdesktop.swingx.JXStatusBar
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable
@JavaBean public class JXStatusBar extends JComponent

A container for JComponents that is typically placed at the bottom of a form and runs the entire width of the form. There are 3 important functions that JXStatusBar provides. First, JXStatusBar provides a hook for a pluggable look. There is a definite look associated with status bars on windows, for instance. By implementing a subclass of JComponent, we provide a way for the pluggable look and feel system to modify the look of the status bar.

Second, JXStatusBar comes with its own layout manager. Each item is added to the JXStatusBar with a JXStatusBar.Constraint as the constraint argument. The JXStatusBar.Constraint contains an Insets object, as well as a ResizeBehavior, which can be FIXED or FILL. The resize behaviour applies to the width of components. All components added will maintain there preferred height, and the height of the JXStatusBar will be the height of the highest component plus insets.

A constraint with JXStatusBar.Constraint.ResizeBehavior.FIXED will cause the component to occupy a fixed area on the JXStatusBar. The size of the area remains constant when the JXStatusBar is resized. A constraint with this behavior may also take a width value, see JXStatusBar.Constraint.setFixedWidth(int). The width is a preferred minimum width. If the component preferred width is greater than the constraint width, the component width will apply.

All components with constraint JXStatusBar.Constraint.ResizeBehavior.FILL will share equally any spare space in the JXStatusBar. Spare space is that left over after allowing for all FIXED component and the preferred width of FILL components, plus insets

Constructing a JXStatusBar is very straightforward: 


      JXStatusBar bar = new JXStatusBar();
      JLabel statusLabel = new JLabel("Ready");
      JXStatusBar.Constraint c1 = new JXStatusBar.Constraint();
      c1.setFixedWidth(100);
      bar.add(statusLabel, c1);     // Fixed width of 100 with no inserts
      JXStatusBar.Constraint c2 = new JXStatusBarConstraint(
              JXStatusBar.Constraint.ResizeBehavior.FILL); // Fill with no inserts
      JProgressBar pbar = new JProgressBar();
      bar.add(pbar, c2);            // Fill with no inserts - will use remaining space

Two common use cases for status bars include tracking application status and progress. JXStatusBar does not manage these tasks, but instead special components exist or can be created that do manage these tasks. For example, if your application has a TaskManager or some other repository of currently running jobs, you could easily create a TaskManagerProgressBar that tracks those jobs. This component could then be added to the JXStatusBar like any other component.

Client Properties

The BasicStatusBarUI.AUTO_ADD_SEPARATOR client property can be specified, which will disable the auto-adding of separators. In this case, you must add your own JSeparator components. To use: 


      JXStatusBar sbar = new JXStatusBar();
      sbar.putClientProperty(BasicStatusBarUI.AUTO_ADD_SEPARATOR, false);
      sbar.add(comp1);
      sbar.add(new JSeparator(JSeparator.VERTICAL));
      sbar.add(comp2);
      sbar.add(comp3);
Author:
pdoubleya, rbair, Karl George Schaefer
See Also:

  • Field Details

  • Constructor Details

    • JXStatusBar

      public JXStatusBar()
      Creates a new JXStatusBar

  • Method Details

    • setResizeHandleEnabled

      public void setResizeHandleEnabled(boolean resizeHandleEnabled)
      Parameters:
      resizeHandleEnabled - the resizeHandleEnabled to set

    • isResizeHandleEnabled

      public boolean isResizeHandleEnabled()
      Returns:
      the resizeHandleEnabled

    • getUI

      public StatusBarUI getUI()
      Returns the look and feel (LaF) object that renders this component.
      Overrides:
      getUI in class JComponent
      Returns:
      the StatusBarUI object that renders this component

    • setUI

      public void setUI(StatusBarUI ui)
      Sets the look and feel (LaF) object that renders this component.
      Parameters:
      ui - the StatusBarUI LaF object
      See Also:

    • getUIClassID

      public String getUIClassID()
      Returns a string that specifies the name of the LaF class that renders this component.
      Overrides:
      getUIClassID in class JComponent
      Returns:
      "StatusBarUI"
      See Also:

    • updateUI

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