Package io.codeworth.panelmatic

Class PanelMatic

java.lang.Object

io.codeworth.panelmatic.PanelMatic

public class PanelMatic
extends Object

A "starter class" for the PanelMatic system. Use the static method to start building new panels.

Customizing the created panels can be done in a few ways:

• Passing PanelMaticComponentCustomizers to the begin(org.panelmatic.PanelMaticComponentCustomizer[]) method.
• Implementing a PanelBuilderComponentFactory and setting it as the component factory of the panelBuilder.
• Implementing a PanelBuilderFactory and customizing the created PanelBuilders when building them. Then telling PanelMatic to use the factory via setBuilderFactory(org.panelmatic.PanelBuilderFactory).
• Implementing the PanelBuilder interface. This would also entail creating a factory.

This class holds a PanelBuilderFactory and uses it to create PanelBuilders when needed. The panel builders are re-used via a BuilderPool.

As building panels can only take place in the Event Dispatch Thread, no thread-safety precautions were taken.

Simple Usage Example

        JComponent panel = PanelMatic.begin()
                               .addHeader( HeaderLevel.H1, "User Details")
                               .add("Name", nameField )
                               .add("Address", addressField )
                               .add( optInCheckBox )
                               .add( memoTextArea, Modifiers.GROW )
                               .get();
 

Author:

michaelbar-sinai

Constructor Summary

Constructors

Constructor	Description
PanelMatic()

Method Summary

Modifier and Type	Method	Description
static PanelBuilder	begin(PanelMaticComponentCustomizer... custsForCurrentBuild)	Retrieves a builder (either pooled or new) and returns it.
static PanelBuilder	begin(JComponent basePanel, PanelMaticComponentCustomizer... custsForCurrentBuild)	Retrieves a builder (either pooled or new) and returns it.
static ComponentOrientation	getComponentOrientation()
static ResourceBundle	getLocalizationBundle()
static void	setBuilderFactory(PanelBuilderFactory pbf)	Sets the panel builder factory and creates a new builder pool.
static void	setComponentOrientation(ComponentOrientation anOrientation)	Sets the component orientation of the created panels.
static void	setLocalizationBundle(ResourceBundle aBundle)	Sets the localization resource bundle for the builders.

Methods inherited from class java.lang.Object

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

Constructor Detail

PanelMatic

public PanelMatic()

Method Detail

setBuilderFactory

public static void setBuilderFactory(PanelBuilderFactory pbf)

Sets the panel builder factory and creates a new builder pool.

Parameters:

pbf - The new builder factory. Cannot be null

Throws:

IllegalArgumentException - if pbf is null.

begin

public static PanelBuilder begin(PanelMaticComponentCustomizer... custsForCurrentBuild)

Retrieves a builder (either pooled or new) and returns it. The returned builder is using its own panel as the top-level panel.

Parameters:

custsForCurrentBuild - Component customizers that are prepended to the normal component customizers, for this get only (until PanelBuilder.get(org.panelmatic.PanelPostProcessor[]) is called).

Returns:

A panel builder ready to get a new panel.

begin

public static PanelBuilder begin(JComponent basePanel,
                                 PanelMaticComponentCustomizer... custsForCurrentBuild)

Retrieves a builder (either pooled or new) and returns it. The returned builder is using the passed panel as the top level panel.

Parameters:

basePanel - The panel the builder will start building from.

custsForCurrentBuild - Component customizers that are prepended to the normal component customizers, for this get only (until PanelBuilder.get(org.panelmatic.PanelPostProcessor[]) is called).

Returns:

a builder ready to get a panel using basePanel as the top-level container.

setLocalizationBundle

public static void setLocalizationBundle(ResourceBundle aBundle)

Sets the localization resource bundle for the builders. If aBundle is not null, the string parameter of PanelBuilder's various addXXX methods is interpreted as a key for a string in the passed bundle.

If aBundle is null, that string parameter is displayed as-is.

Note: PanelBuilders obtained before calling this method will not be affected.

Parameters:

aBundle - the localization resource bundle, may be null.

getLocalizationBundle

public static ResourceBundle getLocalizationBundle()

setComponentOrientation

public static void setComponentOrientation(ComponentOrientation anOrientation)

Sets the component orientation of the created panels.

Note: PanelBuilders obtained before calling this method will not be affected.

Parameters:

anOrientation - the orientation of the built panels.

getComponentOrientation

public static ComponentOrientation getComponentOrientation()