de.weltraumschaf.commons.swing

Class ToolBarBuilder

java.lang.Object

de.weltraumschaf.commons.swing.ToolBarBuilder

public final class ToolBarBuilder
extends Object

This builder offers a internal DSL for creating tool bars.

Example:

final JToolBar toolbar = ToolBarBuilder.builder()
            .button("/de/weltraumschaf/swing/folder_16x16.gif")
                .toolTipText("Open an existing document.")
                .addListener(new Listener())
            .end()
            .button("/de/weltraumschaf/swing/disk_16x16.gif")
                .toolTipText("Save current document.")
                .addListener(new Listener())
            .end()
            .button("/de/weltraumschaf/swing/page_16x16.gif")
                .toolTipText("Create a new document.")
                .addListener(new Listener())
            .end()
            .create();
 

Since:

1.0.0

Author:

Sven Strittmatter

Field Summary

Fields

Modifier and Type	Field and Description
(package private) JToolBar	toolbar The built tool bar.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ToolBarBuilder() Use builder() instead.

Method Summary

Methods

Modifier and Type	Method and Description
static ToolBarBuilder	builder() Creates a new builder instance.
ToolBarButtonBuilder	button(Icon icon) Creates a button in the tool bar.
ToolBarButtonBuilder	button(URL iconResource) Creates a button in the tool bar.
JToolBar	create() Returns the built tool bar.

Methods inherited from class java.lang.Object

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

Field Detail

toolbar

final JToolBar toolbar

The built tool bar.

Constructor Detail

ToolBarBuilder

private ToolBarBuilder()

Use builder() instead.

Method Detail

builder

public static ToolBarBuilder builder()

Creates a new builder instance.

Returns:

Always a new instance.

button

public ToolBarButtonBuilder button(URL iconResource)

Creates a button in the tool bar.

Parameters:

iconResource - Path to the button's icon resource.

Returns:

A button builder.

button

public ToolBarButtonBuilder button(Icon icon)

Creates a button in the tool bar.

Parameters:

icon - Icon of the button.

Returns:

A button builder.

create

public JToolBar create()

Returns the built tool bar.

Returns:

Returns always the same instance per builder.