de.weltraumschaf.commons.swing

Class ToolBarButtonBuilder

java.lang.Object

de.weltraumschaf.commons.swing.ToolBarButtonBuilder

public final class ToolBarButtonBuilder
extends Object

Builder to create a tool bar button.

You should not use this class directly. Instead use ToolBarBuilder.

Since:

1.0.0

Author:

Sven Strittmatter

Field Summary

Fields

Modifier and Type	Field and Description
private JButton	button The built button.
private ToolBarBuilder	parent The tool bar builder which creates the tool bar to which button will belong.

Constructor Summary

Constructors

Constructor and Description
ToolBarButtonBuilder(Icon image, ToolBarBuilder parent) Package private constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ToolBarButtonBuilder	addListener(ActionListener listener) Add a listener to the button.
ToolBarBuilder	end() Call if ready with building the button.
(package private) JButton	getButton() Get the built button.
ToolBarButtonBuilder	toolTipText(String text) Set tool tip text of the button.

Methods inherited from class java.lang.Object

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

Field Detail

button

private final JButton button

The built button.

parent

private final ToolBarBuilder parent

The tool bar builder which creates the tool bar to which button will belong.

Constructor Detail

ToolBarButtonBuilder

ToolBarButtonBuilder(Icon image,
                    ToolBarBuilder parent)

Package private constructor. This sub builder is constructed by the ToolBarBuilder.

Parameters:

image - Image of the button.

parent - Constructing tool bar builder.

Method Detail

getButton

JButton getButton()

Get the built button.

Returns:

Always return the same instance per builder.

toolTipText

public ToolBarButtonBuilder toolTipText(String text)

Set tool tip text of the button.

Parameters:

text - Tool tip text.

Returns:

The builder itself.

addListener

public ToolBarButtonBuilder addListener(ActionListener listener)

Add a listener to the button.

Parameters:

listener - Action listener to handle events.

Returns:

Returns the builder itself.

end

public ToolBarBuilder end()

Call if ready with building the button.

Returns:

The parent tool bar builder.