Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.component.button

Interface ButtonBuilder<C extends AbstractButton,T,B extends ButtonBuilder<C,T,B>>

Type Parameters:

C - the button type

T - the value type

B - the builder type

All Superinterfaces:

ComponentBuilder<C,B>, ComponentValueBuilder<C,T,B>, Supplier<C>

All Known Subinterfaces:

CheckBoxBuilder, CheckBoxMenuItemBuilder<B>, MenuItemBuilder<C,B>, RadioButtonBuilder, RadioButtonMenuItemBuilder<B>, ToggleButtonBuilder<C,B>, ToggleMenuItemBuilder<C,B>

public interface ButtonBuilder<C extends AbstractButton,T,B extends ButtonBuilder<C,T,B>>
extends ComponentValueBuilder<C,T,B>

Builds buttons.

Field Summary

Fields inherited from interface is.codion.swing.common.ui.component.builder.ComponentValueBuilder

COMPONENT_VALUE

Method Summary

Modifier and Type	Method	Description
B	action(@Nullable Action action)
B	actionListener(ActionListener actionListener)
B	borderPainted(boolean borderPainted)
static <B extends ButtonBuilder<JButton, Void, B>> ButtonBuilder<JButton,Void,B>	builder()
B	buttonGroup(@Nullable ButtonGroup buttonGroup)
B	contentAreaFilled(boolean contentAreaFilled)
B	control(Control control)
B	control(Supplier<? extends Control> control)
B	disabledIcon(@Nullable Icon disabledIcon)
B	disabledSelectedIcon(@Nullable Icon disabledSelectedIcon)
B	focusPainted(boolean focusPainted)
B	horizontalAlignment(int horizontalAlignment)
B	horizontalTextPosition(int horizontalTextPosition)
B	icon(@Nullable Icon icon)
B	iconTextGap(int iconTextGap)
B	includeText(boolean includeText)	Note that setting this to false overrides the caption text from the action, if one is specified.
B	margin(@Nullable Insets insets)
B	mnemonic(int mnemonic)
B	multiClickThreshold(long multiClickThreshold)
B	pressedIcon(@Nullable Icon pressedIcon)
B	rolloverEnabled(boolean rolloverEnabled)
B	rolloverIcon(@Nullable Icon rolloverIcon)
B	rolloverSelectedIcon(@Nullable Icon rolloverSelectedIcon)
B	selected(boolean selected)	Sets the inital selected status of the button, overridden by initial value.
B	selectedIcon(@Nullable Icon selectedIcon)
B	text(@Nullable String text)
B	verticalAlignment(int verticalAlignment)
B	verticalTextPosition(int verticalTextPosition)

Methods inherited from interface is.codion.swing.common.ui.component.builder.ComponentBuilder

background, border, build, build, clientProperty, componentListener, componentOrientation, enabled, enabled, focusable, focusable, focusCycleRoot, focusListener, font, foreground, get, keyEvent, keyListener, label, label, maximumHeight, maximumSize, maximumWidth, minimumHeight, minimumSize, minimumWidth, mouseListener, mouseMotionListener, mouseWheelListener, name, onBuild, onSetVisible, opaque, popupMenu, popupMenuControl, popupMenuControls, preferredHeight, preferredSize, preferredWidth, propertyChangeListener, propertyChangeListener, scrollPane, toolTipText, toolTipText, transferFocusOnEnter, transferFocusOnEnter, transferHandler, visible, visible

Methods inherited from interface is.codion.swing.common.ui.component.builder.ComponentValueBuilder

buildValue, buildValue, consumer, link, link, listener, modifiedIndicator, modifiedIndicatorFactory, onBuildValue, validator, validIndicator, validIndicator, validIndicatorFactory, value

Method Details

text

B text(@Nullable String text)

Parameters:

text - the button caption text

Returns:

this builder instance

See Also:

• AbstractButton.setText(String)

mnemonic

B mnemonic(int mnemonic)

Parameters:

mnemonic - the mnemonic

Returns:

this builder instance

See Also:

• AbstractButton.setMnemonic(int)

includeText

B includeText(boolean includeText)

Note that setting this to false overrides the caption text from the action, if one is specified.

Parameters:

includeText - specifies whether a caption text should be included

Returns:

this builder instance

horizontalAlignment

B horizontalAlignment(int horizontalAlignment)

Parameters:

horizontalAlignment - the horizontal alignment

Returns:

this builder instance

See Also:

• AbstractButton.setHorizontalAlignment(int)

verticalAlignment

B verticalAlignment(int verticalAlignment)

Parameters:

verticalAlignment - the vertical alignment

Returns:

this builder instance

See Also:

• AbstractButton.setVerticalAlignment(int)

horizontalTextPosition

B horizontalTextPosition(int horizontalTextPosition)

Parameters:

horizontalTextPosition - the horizontal text position

Returns:

this builder instance

See Also:

• AbstractButton.setHorizontalTextPosition(int)

verticalTextPosition

B verticalTextPosition(int verticalTextPosition)

Parameters:

verticalTextPosition - the vertical text position

Returns:

this builder instance

See Also:

• AbstractButton.setVerticalTextPosition(int)

icon

B icon(@Nullable Icon icon)

Parameters:

icon - the icon

Returns:

this builder instance

See Also:

• AbstractButton.setIcon(Icon)

pressedIcon

B pressedIcon(@Nullable Icon pressedIcon)

Parameters:

pressedIcon - the icon

Returns:

this builder instance

See Also:

• AbstractButton.setPressedIcon(Icon)

selectedIcon

B selectedIcon(@Nullable Icon selectedIcon)

Parameters:

selectedIcon - the icon

Returns:

this builder instance

See Also:

• AbstractButton.setSelectedIcon(Icon)

rolloverIcon

B rolloverIcon(@Nullable Icon rolloverIcon)

Parameters:

rolloverIcon - the icon

Returns:

this builder instance

See Also:

• AbstractButton.setRolloverIcon(Icon)

rolloverSelectedIcon

B rolloverSelectedIcon(@Nullable Icon rolloverSelectedIcon)

Parameters:

rolloverSelectedIcon - the icon

Returns:

this builder instance

See Also:

• AbstractButton.setRolloverSelectedIcon(Icon)

disabledIcon

B disabledIcon(@Nullable Icon disabledIcon)

Parameters:

disabledIcon - the icon

Returns:

this builder instance

See Also:

• AbstractButton.setDisabledIcon(Icon)

disabledSelectedIcon

B disabledSelectedIcon(@Nullable Icon disabledSelectedIcon)

Parameters:

disabledSelectedIcon - the icon

Returns:

this builder instance

See Also:

• AbstractButton.setIcon(Icon)

iconTextGap

B iconTextGap(int iconTextGap)

Parameters:

iconTextGap - the icon text gap

Returns:

this builder instance

See Also:

• AbstractButton.setIconTextGap(int)

margin

B margin(@Nullable Insets insets)

Parameters:

insets - the margin insets

Returns:

this builder instance

See Also:

• AbstractButton.setMargin(Insets)

borderPainted

B borderPainted(boolean borderPainted)

Parameters:

borderPainted - true if the border should be painted

Returns:

this builder instance

See Also:

• AbstractButton.setBorderPainted(boolean)

contentAreaFilled

B contentAreaFilled(boolean contentAreaFilled)

Parameters:

contentAreaFilled - true if content area should be filled

Returns:

this builder instance

See Also:

• AbstractButton.setContentAreaFilled(boolean)

focusPainted

B focusPainted(boolean focusPainted)

Parameters:

focusPainted - true if focus should be painted

Returns:

this builder instance

See Also:

• AbstractButton.setFocusPainted(boolean)

rolloverEnabled

B rolloverEnabled(boolean rolloverEnabled)

Parameters:

rolloverEnabled - true if rollover should be enabled

Returns:

this builder instance

See Also:

• AbstractButton.setRolloverEnabled(boolean)

multiClickThreshold

B multiClickThreshold(long multiClickThreshold)

Parameters:

multiClickThreshold - the multi click threshold

Returns:

this builder instance

See Also:

• AbstractButton.setMultiClickThreshhold(long)

buttonGroup

B buttonGroup(@Nullable ButtonGroup buttonGroup)

Parameters:

buttonGroup - the group to add the button to

Returns:

this builder instance

selected

B selected(boolean selected)

Sets the inital selected status of the button, overridden by initial value.

Parameters:

selected - the initial selected status of the button

Returns:

this builder instance

See Also:

• AbstractButton.setSelected(boolean)

action

B action(@Nullable Action action)

Parameters:

action - the button action

Returns:

this builder instance

See Also:

• AbstractButton.setAction(Action)

control

B control(Control control)

Parameters:

control - the control to base the button on

Returns:

this builder instance

control

B control(Supplier<? extends Control> control)

Parameters:

control - the control to base the button on

Returns:

this builder instance

actionListener

B actionListener(ActionListener actionListener)

Parameters:

actionListener - the action listener

Returns:

this builder instance

See Also:

• AbstractButton.addActionListener(ActionListener)

builder

static <B extends ButtonBuilder<JButton,
Void,
B>>
ButtonBuilder<JButton,Void,B> builder()

Type Parameters:

B - the builder type

Returns:

a builder for a JButton