Package com.intellij.util.ui

Class UI.PanelFactory

java.lang.Object

com.intellij.util.ui.UI.PanelFactory

Enclosing class:

UI

public static class UI.PanelFactory
extends java.lang.Object

Factory class for creating panels of components. There are two different types of panels.

1) Component panel. It's essentially a JComponent that can be decorated with:

• a label that's located on the right of the component
• a help context label that's located on the left or below of the component
• an icon with a question mark that show a popup with more information which is show on the left

For more information see ComponentPanelBuilder

2) ProgressBar panel. A panel containing JProgressBar that has specific layout which is different from an arbitrary component panel. A progress bar panel can contain following items:

• a label that' located above or on the left of the progress bar
• a comment label that's located below the progress bar
• Cancel, Play, Pause buttons with assignable actions

For more information see ProgressPanelBuilder

Either of the mentioned panels can be grouped together in a grid. I.e. it's possible to create a grid of panels see grid(). When using grid internal implementation makes sure all labels (if the are placed on the left) are located in the leftmost column and components/progress bars are in the second column expanding horizontally.

PanelGridBuilder has convenient PanelGridBuilder.resize() method that allows rows to expand vertically when the grid is resized. By default all rows stick to the top of the grid and all available empty space is expanded below rows.

For concrete examples look ComponentPanelTestAction test action and class.

Constructor Summary

Constructors

Constructor and Description
PanelFactory()

Method Summary

Modifier and Type	Method and Description
static PanelGridBuilder	grid() Creates a panel grid.
static ComponentPanelBuilder	panel(javax.swing.JComponent component) Creates a panel builder for arbitrary JComponent.
static ProgressPanelBuilder	panel(javax.swing.JProgressBar progressBar) Creates a panel builder for arbitrary JProgressBar.

Methods inherited from class java.lang.Object

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

Constructor Detail

PanelFactory

public PanelFactory()

Method Detail

panel

public static ComponentPanelBuilder panel(javax.swing.JComponent component)

Creates a panel builder for arbitrary JComponent.

Parameters:

component - is the central component

Returns:

a newly created instance of ComponentPanelBuilder for configuring the panel before creation.

panel

public static ProgressPanelBuilder panel(javax.swing.JProgressBar progressBar)

Creates a panel builder for arbitrary JProgressBar.

Parameters:

progressBar - is the central progressBar

Returns:

a newly created instance of ProgressPanelBuilder for configuring the panel before creation.

grid

public static PanelGridBuilder grid()

Creates a panel grid. Each grid should contain panels of the same type.

Returns:

a newly created PanelGridBuilder