Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

## Package org.jdesktop.swingx

Contains extensions to the Swing GUI toolkit, including new and enhanced components that provide functionality commonly required by rich, data-centric client applications.

See:
Description

Interface Summary
JXCollapsiblePane.CollapsiblePaneContainer | Tagging interface for containers in a JXCollapsiblePane hierarchy who needs to be revalidated (invalidate/validate/repaint) when the pane is expanding or collapsing.
JXLabel.IValue |
JXTipOfTheDay.ShowOnStartupChoice | Used in conjunction with the `JXTipOfTheDay.showDialog(Component, ShowOnStartupChoice)` to save the "Show tips on startup" choice.

Class Summary
AbstractPatternPanel | Common base class of ui clients.
ForwardingRepaintManager | A `RepaintManager` that is designed to forward all calls to a contained delegate.
HorizontalLayout | Organizes components in a horizontal layout.
JXBusyLabel | A simple circular animation, useful for denoting an action is taking place that may take an unknown length of time to complete.
JXButton | A `Painter` enabled subclass of `JButton`.
JXCollapsiblePane | `JXCollapsiblePane` provides a component which can collapse or expand its content area with animation and fade in/fade out effects.
JXColorSelectionButton | A button which allows the user to select a single color.
JXComboBox | An enhanced `JComboBox` that provides the following additional functionality:
JXComboBox.ComboBoxAdapter |
JXDatePicker | A component for entering dates with a user interaction similar to a JComboBox.
JXDialog | First cut for enhanced Dialog.
JXEditorPane | `JXEditorPane` offers enhanced functionality over the standard `JEditorPane`.
JXErrorPane | JXErrorPane is a common error component suitable for displaying errors, warnings, and exceptional application behavior to users.
JXFindBar | A simple low-intrusion default widget for incremental search.
JXFindPanel | `JXFindPanel` is a basic find panel suitable for use in dialogs.
JXFormattedTextField | `JFormattedTextField`, with integrated support for prompts and buddies.
JXFrame | `JXFrame` is an enhanced `JFrame`.
JXGradientChooser | A specialized JXPanel that allows the user to construct and choose a Gradient.
JXGraph | `JXGraph` provides a component which can display one or more plots on top of a graduated background (or grid.)
JXGraph.Plot | A plot represents a mathematical transformation used by `JXGraph`.
JXHeader | `JXHeader is a simple component consisting of a title, a description, and an icon.`
JXHyperlink | A hyperlink component that derives from JButton to provide compatibility mostly for binding actions enabled/disabled behavior accessibility i18n etc...
JXImagePanel | Deprecated. (pre-1.6.2) use a JXPanel with an ImagePainter; see Issue 988
JXImageView | A panel which shows an image centered.
JXLabel | A `JLabel` subclass which supports `Painter`s, multi-line text, and text rotation.
JXLabel.MultiLineSupport |
JXList | Enhanced List component with support for general SwingX sorting/filtering, rendering, highlighting, rollover and search functionality.
JXList.ListAdapter | A component adapter targeted at a JXList.
JXLoginPane | JXLoginPane is a specialized JPanel that implements a Login dialog with support for saving passwords supplied for future use in a secure manner.
JXLoginPane.JXLoginDialog |
JXLoginPane.JXLoginFrame |
JXMonthView | Component that displays a month calendar which can be used to select a day or range of days.
JXMultiSplitPane | All properties in this class are bound: when a properties value is changed, all PropertyChangeListeners are fired.
JXMultiSplitPane.DividerPainter | Draws a single Divider.
JXMultiThumbSlider<E> | A slider which can have multiple control points or Thumbs
JXPanel | An extended `JPanel` that provides additional features.
JXRadioGroup<T> | `JXRadioGroup` is a group of radio buttons that functions as a unit.
JXRootPane | Extends the JRootPane by supporting specific placements for a toolbar and a status bar.
JXSearchField | A text field with a find icon in which the user enters text that identifies items to search for.
JXSearchPanel | `JXSearchPanel` provides complex searching features.
JXStatusBar | A container for `JComponents` that is typically placed at the bottom of a form and runs the entire width of the form.
JXStatusBar.Constraint | The constraint object to be used with the `JXStatusBar`.
JXTable | Enhanced Table component with support for general SwingX sorting/filtering, rendering, highlighting, rollover and search functionality.
JXTable.BooleanEditor | The default editor for `Boolean` types.
JXTable.GenericEditor | Default editor registered for `Object`.
JXTable.NumberEditor | Editor for `Number`s.
JXTable.TableAdapter |
JXTableHeader | TableHeader with extended functionality if associated Table is of type JXTable.
JXTableHeader.SortGestureRecognizer | Deprecated. no longer used internally - keep until we know better how to meet our requirments in Mustang
JXTaskPane | `JXTaskPane` is a container for tasks and other arbitrary components.
JXTaskPaneContainer | `JXTaskPaneContainer` provides an elegant view to display a list of tasks ordered by groups (`JXTaskPane`s).
JXTextArea | `JTextArea`, with integrated support for prompts.
JXTextField | `JTextField`, with integrated support for prompts and buddies.
JXTipOfTheDay | Provides the "Tip of The Day" pane and dialog.
JXTitledPanel | A special type of Panel that has a Title section and a Content section. The following properties can be set with the UIManager to change the look and feel of the JXTitledPanel: JXTitledPanel.titleForeground JXTitledPanel.titleBackground JXTitledPanel.titleFont JXTitledPanel.titlePainter JXTitledPanel.captionInsets JXTitledPanel.rightDecorationInsets JXTitledPanel.leftDecorationInsets
JXTitledSeparator | A simple horizontal separator that contains a title.
JXTree | Enhanced Tree component with support for SwingX rendering, highlighting, rollover and search functionality.
JXTree.TreeAdapter |
JXTreeTable | `JXTreeTable` is a specialized `table` consisting of a single column in which to display hierarchical data, and any number of other columns in which to display regular data.
JXTreeTable.TreeTableDataAdapter |
JXTreeTable.TreeTableModelAdapter |
MultiSplitLayout | The MultiSplitLayout layout manager recursively arranges its components in row and column groups called "Splits".
MultiSplitLayout.ColSplit |
MultiSplitLayout.Divider | Models a single vertical/horiztonal divider.
MultiSplitLayout.Leaf | Models a java.awt Component child.
MultiSplitLayout.Node | Base class for the nodes that model a MultiSplitLayout.
MultiSplitLayout.RowSplit |
MultiSplitLayout.Split | Defines a vertical or horizontal subdivision into two or more tiles.
RepaintManagerX | An implementation of `RepaintManager` which adds support for transparency in `JXPanel`s.
StackLayout | `StackLayout` is a Swing layout aimed to act as the layers stack of most popuplar graphics editing tools like The GIMP or Photoshop.
SwingXUtilities | A collection of utility methods for Swing(X) classes.
UIAction | UIAction is the basis of all of basic's action classes that are used in an ActionMap.
VerticalLayout | Organizes components in a vertical layout.

Enum Summary
JXBusyLabel.Direction | Direction is used to set the initial direction in which the animation starts.
JXCollapsiblePane.Direction | The direction defines how the collapsible pane will collapse.
JXFrame.StartPosition | An enumeration of `JXFrame` starting locations.
JXHeader.IconPosition | Specifies desired location of the icon relative to the title/description text.
JXImagePanel.Style |
JXLabel.TextAlignment | Text alignment enums.
JXLoginPane.SaveMode | The JXLoginPane can attempt to save certain user information such as the username, password, or both to their respective stores.
JXLoginPane.Status | Returns the status of the login process
JXSearchField.LayoutStyle | Defines, how the find and cancel button are layouted.
JXSearchField.SearchMode | Defines when action events are posted.
JXStatusBar.Constraint.ResizeBehavior |
ScrollableSizeHint | Sizing hints for layout, useful f.i.

Exception Summary
MultiSplitLayout.InvalidLayoutException | The specified Node is either the wrong type or was configured incorrectly.

Annotation Types Summary
TranslucentRepaintManager | An annotation that can be applied to a `RepaintManager` to suggest that the `RepaintManager` supports translucency.

## Package org.jdesktop.swingx Description

Contains extensions to the Swing GUI toolkit, including new and enhanced components that provide functionality commonly required by rich, data-centric client applications. Many of these features will eventually be incorporated into the Swing toolkit, although API compatibility will not be guaranteed.

## New or Enhanced Functionality

### Auto-completion for TextFields and ComboBoxes

### Enhanced Rendering Support for Collection Components

### Built-In Search Support for Collection Components and JXEditorPane

### Filtering/Sorting for Tables and Lists

NOTE: Currently on the move to core (JDK 6+) sorting/filtering. Trunk has all SwingX specials removed, JXTable sort api back again. JXList still disabled.

### Login/Authentication Framework

### Painter-enabled components

Components that use painters for background rendering alter the functionality of how `Component.setBackground(java.awt.Color)` works. Setting the background color of a painter-enabled component effectively sets the background painter to paint the requested color.

Look and Feel implementors should note that setting a `java.swing.plaf.UIResource` to `setBackground` will cause a `Painter` `UIResource` to be installed. This means that implementors should set the background before setting the painter as the last one set wins.

## New and Enhanced components

### Buttons and Labels

- `JXButton`
- `Hyperlink`
- `JXLabel`
- `JXBusyLabel`
- `JXRadioGroup`

### Collection Components

These are sortable/filterable (with the exception of hierarchical components) with consistent and uniform SwingX rendering, highlighting, searching and rollover support.

- `Table` uses the enhanced `TableHeader`
- `List` - rollover and sort/filter functionality is disabled by default
- `Tree`
- `TreeTable` - a new hierarchical component with support of tabular node properties

### Top-level Windows, General and Special Purpose Containers

- Enhanced `Frame` using an extended `RootPane RootPane` to support a `StatusBar`
- `Dialog`
- `Panel`
- `ErrorPane`
- `LoginPane`
- Search components: `FindBar` used for incremental search (similar to FireFox), `FindPanel` used in a find dialog, and `SearchPanel` used for what was it?
- Nested SplitPane `MultiSplitPane`
- Vertical collapsing/expansion functionality is provided by a `CollapsiblePane`. A special purpose collapsible is the `TaskPane` which typically is used to group buttons/hyperlinks which perform related tasks. A special `TaskPaneContainer` is responsible for the layout of several TaskPanes.
- Easily configurable `TipOfTheDay`
- `TitledPanel`

### Miscellaneous Components

- New calendar components: the `DatePicker` allows to select a single Date and a `MonthView` showing the overview of one or more months.
- `Header`
- `TitledSeparator`
- `JXColorSelectionButton`
- `JXEditorPane`
- `JXGradientChooser`
- `JXGraph`
- Image containers `ImageView` and `ImagePanel` (PENDING JW: merge/remove one?)
- `MultiThumbSlider`

## External Information Sources

SwingX Twiki Change History SwingLabs User and Developer Discussion Forum

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

Copyright © 2010. All Rights Reserved.