java.lang.Object
- io.codeworth.panelmatic.impl.AbstractPanelBuilder

All Implemented Interfaces:

PanelBuilder

Direct Known Subclasses:

GbPanelBuilder
```
public abstract class AbstractPanelBuilder
extends Object
implements PanelBuilder
```
This class provides a skeletal implementation of the PanelBuilder interface, to minimize the effort required to implement it from scratch. Deals with:
- Getting/setting the ComponentFactory
- Getting/setting the default component behaviors
- Getting/setting the component customizers (both the regulars and the single build ones)
- Lookup of strings in a ResourceBundle.
- Customizing the components
- Creating the effective behaviors for the added components (e.g. when more behavior modifiers are passed to an add(...) method
Author:

michaelbar-sinai

Nested Class Summary
- Nested classes/interfaces inherited from interface io.codeworth.panelmatic.PanelBuilder
  PanelBuilder.HeaderLevel

Constructor Summary

Constructors
Constructor	Description
`AbstractPanelBuilder()`
`AbstractPanelBuilder(ComponentBehavior baseComponentBehavior)`
`AbstractPanelBuilder(ComponentBehavior headerBehavior, ComponentBehavior labelBehavior, ComponentBehavior baseComponentBehavior)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`PanelBuilder`	`add(String title, JComponent comp, BehaviorModifier... modifiers)`
`protected PanelBuilder`	`add(String labelText, JComponent labelComp, JComponent aComp, BehaviorModifier... modifiers)`
`PanelBuilder`	`add(Icon icn, String title, JComponent comp, BehaviorModifier... modifiers)`
`PanelBuilder`	`add(JComponent comp, BehaviorModifier... modifiers)`
`PanelBuilder`	`add(JComponent labelComp, JComponent comp, BehaviorModifier... modifiers)`
`PanelBuilder`	`addFlexibleSpace()`	Adds an empty space that stretches to take any extra space available.
`PanelBuilder`	`addHeader(PanelBuilder.HeaderLevel hx, String title, JComponent... comps)`
`PanelBuilder`	`addHeader(PanelBuilder.HeaderLevel hx, Icon icn, String title, JComponent... comps)`
`protected abstract void`	`addHeaderImpl(JComponent aHeaderComp)`	Implementation of adding a header to the product.
`protected abstract void`	`addImpl(JComponent aLabelComp, JComponent aComp, ComponentBehavior aBehavior)`	The actual addition of the component to the product is done here.
`PanelBuilder`	`begin(PanelMaticComponentCustomizer... custsForCurrentBuild)`	Prepares the builder to get a panel using internally-created container.
`PanelBuilder`	`begin(JComponent basePanel, PanelMaticComponentCustomizer... custsForCurrentBuild)`	Prepares the builder to get a panel using the supplied `JComponent` as the top-level container.
`protected abstract void`	`beginImpl(JComponent aBaseComp)`	Implementation of the `begin(org.panelmatic.PanelMaticComponentCustomizer[])` method.
`protected JComponent`	`customizeComponent(String labelText, JComponent c)`	Runs the component through the customizers chain.
`JComponent`	`get(PanelPostProcessor... ppps)`	Finalizes the build, and returns the built panel.
`ComponentBehavior`	`getBaseComponentBehavior()`
`PanelBuilderComponentFactory`	`getComponentFactory()`
`List<PanelMaticComponentCustomizer>`	`getCustomizerChain()`	Allows access to the chain of `PanelMaticComponentCustomizer`s that customize components before adding them to the built panel.
`ComponentBehavior`	`getHeaderBehavior()`
`protected abstract JComponent`	`getImpl()`	Implementation of the #get(org.panelmatic.PanelPostProcessor[]) method.
`ComponentBehavior`	`getLabelBehavior()`
`ResourceBundle`	`getResourceBundle()`
`protected String`	`getResourceString(String key)`	Return a localized version of the string, if we have a resource bundle, or the passed key, if we don't.
`void`	`setBaseComponentBehavior(ComponentBehavior baseComponentBehavior)`
`void`	`setBuilderPool(BuilderPool aPool)`	Sets the pool into which the builder will return when done.
`void`	`setComponentFactory(PanelBuilderComponentFactory aComponentFactory)`
`void`	`setHeaderBehavior(ComponentBehavior aHeaderBehavior)`
`void`	`setLabelBehavior(ComponentBehavior aLabelBehavior)`
`AbstractPanelBuilder`	`setResourceBundle(ResourceBundle aResourceBundle)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractPanelBuilder
```
public AbstractPanelBuilder(ComponentBehavior headerBehavior,
                            ComponentBehavior labelBehavior,
                            ComponentBehavior baseComponentBehavior)
```
    Parameters:
    
    headerBehavior - The behavior of the headers
    
    labelBehavior - The behavior of the labels
    
    baseComponentBehavior - the behavior of the added components.
  - AbstractPanelBuilder
```
public AbstractPanelBuilder(ComponentBehavior baseComponentBehavior)
```
  - AbstractPanelBuilder
```
public AbstractPanelBuilder()
```
- Method Detail
  - begin
```
public PanelBuilder begin(PanelMaticComponentCustomizer... custsForCurrentBuild)
```
    Description copied from interface: PanelBuilder
    
    Prepares the builder to get a panel using internally-created container. When possible, you should use this method, rather than PanelBuilder.begin(javax.swing.JComponent, org.panelmatic.PanelMaticComponentCustomizer[]), as it is guaranteed to work.
    
    Specified by:
    
    begin in interface PanelBuilder
    
    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:
    
    this builder.
  - begin
```
public PanelBuilder begin(JComponent basePanel,
                          PanelMaticComponentCustomizer... custsForCurrentBuild)
```
    Description copied from interface: PanelBuilder
    
    Prepares the builder to get a panel using the supplied JComponent as the top-level container. Use when laying-out existing panels. The builder would probably try to set properties on the component, make sure that panel can handle those changes (e.g setting of a LayoutManager.
    
    Specified by:
    
    begin in interface PanelBuilder
    
    Parameters:
    
    basePanel - The component to be used as container.
    
    custsForCurrentBuild - Component customizers that are prepended to the normal component customizers, for this get only (until PanelBuilder.get(org.panelmatic.PanelPostProcessor[]) is called).
    
    Returns:
    
    this builder.
  - addHeader
```
public PanelBuilder addHeader(PanelBuilder.HeaderLevel hx,
                              String title,
                              JComponent... comps)
```
    Specified by:
    
    addHeader in interface PanelBuilder
  - addHeader
```
public PanelBuilder addHeader(PanelBuilder.HeaderLevel hx,
                              Icon icn,
                              String title,
                              JComponent... comps)
```
    Specified by:
    
    addHeader in interface PanelBuilder
  - add
```
public PanelBuilder add(String title,
                        JComponent comp,
                        BehaviorModifier... modifiers)
```
    Specified by:
    
    add in interface PanelBuilder
  - add
```
public PanelBuilder add(Icon icn,
                        String title,
                        JComponent comp,
                        BehaviorModifier... modifiers)
```
    Specified by:
    
    add in interface PanelBuilder
  - add
```
public PanelBuilder add(JComponent comp,
                        BehaviorModifier... modifiers)
```
    Specified by:
    
    add in interface PanelBuilder
  - add
```
public PanelBuilder add(JComponent labelComp,
                        JComponent comp,
                        BehaviorModifier... modifiers)
```
    Specified by:
    
    add in interface PanelBuilder
  - add
```
protected PanelBuilder add(String labelText,
                           JComponent labelComp,
                           JComponent aComp,
                           BehaviorModifier... modifiers)
```
  - addFlexibleSpace
```
public PanelBuilder addFlexibleSpace()
```
    Description copied from interface: PanelBuilder
    
    Adds an empty space that stretches to take any extra space available.
    
    Specified by:
    
    addFlexibleSpace in interface PanelBuilder
    
    Returns:
    
    this builder.
  - get
```
public JComponent get(PanelPostProcessor... ppps)
```
    Description copied from interface: PanelBuilder
    
    Finalizes the build, and returns the built panel. The builder returns to its pool. After calling this method, the client code can no longer use the builder! To obtain a new builder, call on of PanelMatic]'s begin() methods
    
    Specified by:
    
    get in interface PanelBuilder
    
    Parameters:
    
    ppps - optional post processors for the built panel.
    
    Returns:
    
    the built component.
  - beginImpl
```
protected abstract void beginImpl(JComponent aBaseComp)
```
    Implementation of the begin(org.panelmatic.PanelMaticComponentCustomizer[]) method.
    
    Parameters:
    
    aBaseComp - The starting component, may be null.
  - addHeaderImpl
```
protected abstract void addHeaderImpl(JComponent aHeaderComp)
```
    Implementation of adding a header to the product.
    
    Parameters:
    
    aHeaderComp - The component to be used as a header.
  - addImpl
```
protected abstract void addImpl(JComponent aLabelComp,
                                JComponent aComp,
                                ComponentBehavior aBehavior)
```
    The actual addition of the component to the product is done here.
    
    Parameters:
    
    aLabelComp - The component that will be used as a label. Can be null.
    
    aComp - The (customized) component that we add to the product.
    
    aBehavior - The (modified) behavior that aComp should have.
  - getImpl
```
protected abstract JComponent getImpl()
```
    Implementation of the #get(org.panelmatic.PanelPostProcessor[]) method. Return the product and clean the state.
    
    Returns:
    
    The built panel.
  - customizeComponent
```
protected JComponent customizeComponent(String labelText,
                                        JComponent c)
```
    Runs the component through the customizers chain.
    
    Parameters:
    
    labelText - The label the component would have. Might be useful for, e.g. setting a tool tip.
    
    c - the component to customize.
    
    Returns:
    
    a customized component. Note that this component ] might not be the same passed (e.g when wrapped by a customizer in a JScrollPane).
  - getResourceString
```
protected String getResourceString(String key)
```
    Return a localized version of the string, if we have a resource bundle, or the passed key, if we don't.
    
    Parameters:
    
    key - The key to lookup in the bundle (if we have one). When null, the method returns null.
    
    Returns:
    
    If we have a resource bundle, the string whose key is passed. Otherwise, key.
  - getBaseComponentBehavior
```
public ComponentBehavior getBaseComponentBehavior()
```
  - getCustomizerChain
```
public List<PanelMaticComponentCustomizer> getCustomizerChain()
```
    Description copied from interface: PanelBuilder
    
    Allows access to the chain of PanelMaticComponentCustomizers that customize components before adding them to the built panel.
    To add a customizer, use builder.getCustomizerChain().add( cust ); Note that since the builders are pooled, changes made to a builder obtained by PanelMatic.begin(...) might not effect other builders obtained the same way. To ensure all builders are changed, consider implementing a PanelBuilderFactory and calling this method on the PanelBuilderFactory.build() method.
    
    Specified by:
    
    getCustomizerChain in interface PanelBuilder
    
    Returns:
    
    The chain of customizers.
  - getHeaderBehavior
```
public ComponentBehavior getHeaderBehavior()
```
  - getLabelBehavior
```
public ComponentBehavior getLabelBehavior()
```
  - setBaseComponentBehavior
```
public void setBaseComponentBehavior(ComponentBehavior baseComponentBehavior)
```
  - setBuilderPool
```
public void setBuilderPool(BuilderPool aPool)
```
    Description copied from interface: PanelBuilder
    
    Sets the pool into which the builder will return when done. Normally client code should not call this method.
    
    Specified by:
    
    setBuilderPool in interface PanelBuilder
    
    Parameters:
    
    aPool - the pool this builder should return to when done building.
  - getComponentFactory
```
public PanelBuilderComponentFactory getComponentFactory()
```
  - setComponentFactory
```
public void setComponentFactory(PanelBuilderComponentFactory aComponentFactory)
```
  - setHeaderBehavior
```
public void setHeaderBehavior(ComponentBehavior aHeaderBehavior)
```
  - setLabelBehavior
```
public void setLabelBehavior(ComponentBehavior aLabelBehavior)
```
  - getResourceBundle
```
public ResourceBundle getResourceBundle()
```
  - setResourceBundle
```
public AbstractPanelBuilder setResourceBundle(ResourceBundle aResourceBundle)
```

Class AbstractPanelBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface io.codeworth.panelmatic.PanelBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractPanelBuilder

AbstractPanelBuilder

AbstractPanelBuilder

Method Detail

begin

begin

addHeader

addHeader

add

add

add

add

add

addFlexibleSpace

get

beginImpl

addHeaderImpl

addImpl

getImpl

customizeComponent

getResourceString

getBaseComponentBehavior

getCustomizerChain

getHeaderBehavior

getLabelBehavior

setBaseComponentBehavior

setBuilderPool

getComponentFactory

setComponentFactory

setHeaderBehavior

setLabelBehavior

getResourceBundle

setResourceBundle