Package swingtree

Class UIForSplitButton<B extends JSplitButton>

java.lang.Object

swingtree.UIForAnything<UIForSplitButton<B>,B,JComponent>

swingtree.UIForAnySwing<UIForSplitButton<B>,B>

swingtree.UIForAnyButton<UIForSplitButton<B>,B>

swingtree.UIForSplitButton<B>

public final class UIForSplitButton<B extends JSplitButton>
extends UIForAnyButton<UIForSplitButton<B>,B>

A SwingTree builder node designed for configuring JSplitButton instances.

Method Summary

Modifier and Type	Method	Description
protected UIForSplitButton<B>	_newBuilderWithState(swingtree.BuilderState<B> newState)	An internal wither method which creates a new builder instance with the provided BuilderState stored inside it.
protected swingtree.BuilderState<B>	_state()	Returns the state of the builder, which is a container for the wrapped component as well as it's type and current EventProcessor.
UIForSplitButton<B>	add(JMenuItem item)	Use this to add a JMenuItem to the JSplitButton popup menu.
<I extends JMenuItem> UIForSplitButton<B>	add(SplitItem<I> splitItem)	Use this to add a SplitItem to the JSplitButton popup menu.
<M extends JMenuItem> UIForSplitButton<B>	add(UIForMenuItem<M> forItem)	Use this to add a JMenuItem to the JSplitButton popup menu.
UIForSplitButton<B>	onButtonClick(sprouts.Action<SplitItemDelegate<JMenuItem>> action)	Use this as an alternative to onClick(Action) to register a button click action with an action lambda having access to a delegate with more context information including not only the current JSplitButton instance, but also the currently selected JMenuItem and a list of all other items.
UIForSplitButton<B>	onCancel(sprouts.Action<ComponentDelegate<B,PopupMenuEvent>> action)	Registers a listener to be notified when the split button options drop down popup is canceled, which typically happens when the user clicks outside the popup menu.
UIForSplitButton<B>	onClick(sprouts.Action<ComponentDelegate<B,ActionEvent>> action)	Use this to register a basic action for when the JSplitButton button is being clicked (not the split part).
UIForSplitButton<B>	onClose(sprouts.Action<ComponentDelegate<B,PopupMenuEvent>> action)	Registers a listener to be notified when the split button is closed, meaning its popup menu is hidden after the user clicks on the split button drop down button.
UIForSplitButton<B>	onOpen(sprouts.Action<ComponentDelegate<B,PopupMenuEvent>> action)	Registers a listener to be notified when the split button is opened, meaning its popup menu is shown after the user clicks on the split button drop down button.
UIForSplitButton<B>	onSelection(sprouts.Action<SplitButtonDelegate<JMenuItem>> action)	Actions registered here will be called when the user selects a JMenuItem from the popup menu of this JSplitButton.
UIForSplitButton<B>	onSplitClick(sprouts.Action<SplitButtonDelegate<JMenuItem>> action)	Actions registered here will be called when the split part of the JSplitButton was clicked.
<E extends Enum<E>> UIForSplitButton<B>	withSelection(sprouts.Var<E> selection)	Use this to build JSplitButtons where the selectable options are represented by an Enum type.
<E extends Enum<E>> UIForSplitButton<B>	withSelection(sprouts.Var<E> selection, Function<E,String> textProvider)	Use this to build JSplitButtons where the selectable options are represented by an Enum type.
<E extends Enum<E>> UIForSplitButton<B>	withSelection(sprouts.Var<E> selection, sprouts.Event clickEvent)	Use this to build JSplitButtons where the selectable options are represented by an Enum type, and the click event is handles by an Event instance.
<E extends Enum<E>> UIForSplitButton<B>	withSelection(sprouts.Var<E> selection, sprouts.Event clickEvent, Function<E,String> textProvider)	Allows you to build JSplitButtons where the selectable options are represented by an Enum type, and the click event is handled by an Event instance as well as a "text provider", which is a function that maps an enum value to a string to be used as the button text displayed to the user.

Methods inherited from class swingtree.UIForAnyButton

_onChange, _onClick, _onModelChange, isBorderPaintedIf, isBorderPaintedIf, isPressedIf, isSelectedIf, isSelectedIf, isSelectedIf, isSelectedIf, isSelectedIfNot, isSelectedIfNot, isSelectedIfNot, makePlain, onChange, withButtonGroup, withFont, withFont, withFontSize, withFontSize, withHorizontalAlignment, withHorizontalAlignment, withHorizontalTextAlignment, withHorizontalTextAlignment, withIcon, withIcon, withIcon, withIcon, withIcon, withIcon, withIcon, withIcon, withMargin, withMargin, withText, withText, withVerticalAlignment, withVerticalAlignment, withVerticalTextAlignment, withVerticalTextAlignment

Methods inherited from class swingtree.UIForAnySwing

_addComponentTo, _addViewableProps, _addViewableProps, _isUndefinedColor, _isUndefinedFont, _setBackground, _setEnabled, _setMinHeight, _setMinWidth, _setPrefWidth, add, add, add, add, add, add, add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll, doUpdates, group, group, id, id, isEnabledIf, isEnabledIf, isEnabledIf, isEnabledIfNot, isEnabledIfNot, isEnabledIfNot, isFocusableIf, isFocusableIf, isFocusableIf, isFocusableIfNot, isFocusableIfNot, isFocusableIfNot, isValidIf, isVisibleIf, isVisibleIf, isVisibleIf, isVisibleIfNot, isVisibleIfNot, isVisibleIfNot, makeFocused, makeNonOpaque, makeOpaque, on, on, onCharTyped, onFocusGain, onFocusLoss, onHidden, onKeyPress, onKeyRelease, onKeyTyped, onMouseClick, onMouseDrag, onMouseEnter, onMouseEnter, onMouseEnterGreedy, onMouseExit, onMouseExit, onMouseExitGreedy, onMouseMove, onMousePress, onMouseRelease, onMouseWheelDown, onMouseWheelMove, onMouseWheelUp, onMoved, onPressed, onRelease, onResize, onShown, onTyped, onTyped, onView, withBackground, withBackground, withBackgroundColor, withBackgroundIf, withBackgroundIf, withBackgroundIf, withBackgroundIf, withBorder, withBorder, withBorderTitled, withBorderTitled, withBoxLayout, withCompoundBorder, withCompoundBorderTitled, withCursor, withCursor, withCursorIf, withCursorIf, withDragAway, withDropSite, withEmptyBorder, withEmptyBorder, withEmptyBorder, withEmptyBorder, withEmptyBorderTitled, withEmptyBorderTitled, withEmptyBorderTitled, withEmptyBorderTitled, withEmptyBorderTitled, withEmptyBorderTitled, withEmptyBorderTitled, withEmptyBorderTitled, withFlowLayout, withFlowLayout, withFlowLayout, withForeground, withForeground, withForegroundColor, withForegroundIf, withForegroundIf, withForegroundIf, withForegroundIf, withGridBagLayout, withGridLayout, withGridLayout, withGridLayout, withHeight, withHeight, withHeightExactly, withHeightExactly, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLayout, withLineBorder, withLineBorder, withLineBorder, withLineBorderTitled, withLineBorderTitled, withLineBorderTitled, withLineBorderTitled, withMatteBorder, withMatteBorder, withMatteBorder, withMatteBorderTitled, withMatteBorderTitled, withMatteBorderTitled, withMaxHeight, withMaxHeight, withMaxSize, withMaxSize, withMaxSize, withMaxSize, withMaxSize, withMaxWidth, withMaxWidth, withMinHeight, withMinHeight, withMinSize, withMinSize, withMinSize, withMinSize, withMinSize, withMinWidth, withMinWidth, withPrefHeight, withPrefHeight, withPrefSize, withPrefSize, withPrefSize, withPrefSize, withPrefSize, withPrefWidth, withPrefWidth, withProperty, withRepaintOn, withRepaintOn, withRepaintOn, withRepaintOn, withRepaintOn, withRepaintOn, withRoundedLineBorder, withRoundedLineBorder, withRoundedLineBorder, withRoundedLineBorder, withRoundedLineBorderTitled, withRoundedLineBorderTitled, withRoundedLineBorderTitled, withRoundedLineBorderTitled, withRoundedLineBorderTitled, withRoundedLineBorderTitled, withRoundedLineBorderTitled, withSize, withSize, withSize, withSize, withSizeExactly, withSizeExactly, withSizeExactly, withSizeExactly, withStyle, withTooltip, withTooltip, withTransitionalStyle, withTransitoryStyle, withWidth, withWidth, withWidthExactly, withWidthExactly

Methods inherited from class swingtree.UIForAnything

_addBuildersTo, _addBuilderTo, _addComponentsTo, _disposeState, _onShow, _onShow, _runInApp, _runInApp, _runInUI, _this, _with, _withOnShow, _withOnShow, add, add, add, add, apply, applyIf, applyIfPresent, component, equals, get, getComponent, getType, hashCode, peek, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

_state

protected swingtree.BuilderState<B> _state()

Description copied from class: UIForAnything

Returns the state of the builder, which is a container for the wrapped component as well as it's type and current EventProcessor.

Specified by:

_state in class UIForAnything<UIForSplitButton<B extends JSplitButton>,B extends JSplitButton,JComponent>

Returns:

The state of the builder.

_newBuilderWithState

protected UIForSplitButton<B> _newBuilderWithState(swingtree.BuilderState<B> newState)

Description copied from class: UIForAnything

An internal wither method which creates a new builder instance with the provided BuilderState stored inside it.

Specified by:

_newBuilderWithState in class UIForAnything<UIForSplitButton<B extends JSplitButton>,B extends JSplitButton,JComponent>

Parameters:

newState - The new state which should be stored inside the new builder instance.

Returns:

A new builder instance with the provided state stored inside it.

withSelection

public <E extends Enum<E>> UIForSplitButton<B> withSelection(sprouts.Var<E> selection,
 sprouts.Event clickEvent)

Use this to build JSplitButtons where the selectable options are represented by an Enum type, and the click event is handles by an Event instance.

Type Parameters:

E - The Enum type defining the selectable options.

Parameters:

selection - The Var which holds the currently selected Enum value. This will be updated when the user selects a new value.

clickEvent - The Event which will be fired when the user clicks on the button.

Returns:

A UI builder instance wrapping a JSplitButton.

withSelection

public <E extends Enum<E>> UIForSplitButton<B> withSelection(sprouts.Var<E> selection,
 sprouts.Event clickEvent,
 Function<E,String> textProvider)

Allows you to build JSplitButtons where the selectable options are represented by an Enum type, and the click event is handled by an Event instance as well as a "text provider", which is a function that maps an enum value to a string to be used as the button text displayed to the user.

Type Parameters:

E - The Enum type defining the selectable options.

Parameters:

selection - The Var which holds the currently selected Enum value. This will be updated when the user selects a new value.

clickEvent - The Event which will be fired when the user clicks on the button.

textProvider - A function which provides the text representation of an enum value. If this function throws an exception, the enum value's Enum.toString() method will be used as a fallback. Exceptions are logged as errors.

Returns:

The next declarative UI builder for the JSplitButton type.

withSelection

public <E extends Enum<E>> UIForSplitButton<B> withSelection(sprouts.Var<E> selection)

Use this to build JSplitButtons where the selectable options are represented by an Enum type. Changes to the selected value are propagated to the provided Var instance, and the text representation of the selected value is determined using the Enum.toString() method.

Type Parameters:

E - The Enum type defining the selectable options.

Parameters:

selection - The Var which holds the currently selected Enum value. This will be updated when the user selects a new value.

Returns:

A UI builder instance wrapping a JSplitButton.

withSelection

public <E extends Enum<E>> UIForSplitButton<B> withSelection(sprouts.Var<E> selection,
 Function<E,String> textProvider)

Use this to build JSplitButtons where the selectable options are represented by an Enum type. Changes to the selected value are propagated to the provided Var instance, and the text representation of the selected value is dynamically determined through the supplied text provider function.

Type Parameters:

E - The Enum type defining the selectable options.

Parameters:

selection - The Var which holds the currently selected Enum value. This will be updated when the user selects a new value.

textProvider - A function which provides the text representation of an enum value. If this function throws an exception, the enum value's Enum.toString() method will be used as a fallback. Exceptions are logged as errors.

Returns:

A UI builder instance wrapping a JSplitButton.

onSplitClick

public UIForSplitButton<B> onSplitClick(sprouts.Action<SplitButtonDelegate<JMenuItem>> action)

Actions registered here will be called when the split part of the JSplitButton was clicked. The provided lambda receives a delegate object with a rich API exposing a lot of context information including not only the current JSplitButton instance, but also the currently selected JMenuItem and a list of all other items.

Parameters:

action - The Action which will receive an ComponentDelegate exposing all essential components making up this JSplitButton.

Returns:

This very instance, which enables builder-style method chaining.

onSelection

public UIForSplitButton<B> onSelection(sprouts.Action<SplitButtonDelegate<JMenuItem>> action)

Actions registered here will be called when the user selects a JMenuItem from the popup menu of this JSplitButton. The delegate passed to the provided action lambda exposes a lot of context information including not only the current JSplitButton instance, but also the currently selected JMenuItem and a list of all other items.

Parameters:

action - The Action which will receive an SplitItemDelegate exposing all essential components making up this JSplitButton.

Returns:

This very instance, which enables builder-style method chaining.

Throws:

IllegalArgumentException - if the provided action is null.

onButtonClick

public UIForSplitButton<B> onButtonClick(sprouts.Action<SplitItemDelegate<JMenuItem>> action)

Use this as an alternative to onClick(Action) to register a button click action with an action lambda having access to a delegate with more context information including not only the current JSplitButton instance, but also the currently selected JMenuItem and a list of all other items.

Parameters:

action - The Action which will receive an ComponentDelegate exposing all essential components making up this JSplitButton.

Returns:

This very instance, which enables builder-style method chaining.

onClick

public UIForSplitButton<B> onClick(sprouts.Action<ComponentDelegate<B,ActionEvent>> action)

Use this to register a basic action for when the JSplitButton button is being clicked (not the split part). If you need more context information delegated to the action then consider using onButtonClick(Action).

Overrides:

onClick in class UIForAnyButton<UIForSplitButton<B extends JSplitButton>,B extends JSplitButton>

Parameters:

action - An Action instance which will be wrapped by an ComponentDelegate and passed to the button component.

Returns:

This very instance, which enables builder-style method chaining.

onOpen

public UIForSplitButton<B> onOpen(sprouts.Action<ComponentDelegate<B,PopupMenuEvent>> action)

Registers a listener to be notified when the split button is opened, meaning its popup menu is shown after the user clicks on the split button drop down button.

Parameters:

action - the action to be executed when the split button is opened.

Returns:

this very instance, which enables builder-style method chaining.

onClose

public UIForSplitButton<B> onClose(sprouts.Action<ComponentDelegate<B,PopupMenuEvent>> action)

Registers a listener to be notified when the split button is closed, meaning its popup menu is hidden after the user clicks on the split button drop down button.

Parameters:

action - the action to be executed when the split button is closed.

Returns:

this very instance, which enables builder-style method chaining.

onCancel

public UIForSplitButton<B> onCancel(sprouts.Action<ComponentDelegate<B,PopupMenuEvent>> action)

Registers a listener to be notified when the split button options drop down popup is canceled, which typically happens when the user clicks outside the popup menu.

Parameters:

action - the action to be executed when the split button popup is canceled.

Returns:

this very instance, which enables builder-style method chaining.

add

public <M extends JMenuItem> UIForSplitButton<B> add(UIForMenuItem<M> forItem)

Use this to add a JMenuItem to the JSplitButton popup menu.

Type Parameters:

M - The type of the JMenuItem wrapped by the given UIForMenuItem instance.

Parameters:

forItem - The builder whose wrapped JMenuItem will be added to and exposed by the JSplitButton once the split part was pressed.

Returns:

This very instance, which enables builder-style method chaining.

add

public UIForSplitButton<B> add(JMenuItem item)

Use this to add a JMenuItem to the JSplitButton popup menu.

Parameters:

item - A JMenuItem which will be exposed by this JSplitButton once the split part was pressed.

Returns:

This very instance, which enables builder-style method chaining.

add

public <I extends JMenuItem> UIForSplitButton<B> add(SplitItem<I> splitItem)

Use this to add a SplitItem to the JSplitButton popup menu.

Type Parameters:

I - The JMenuItem type which should be added to this JSplitButton builder.

Parameters:

splitItem - The SplitItem instance wrapping a JMenuItem as well as some associated Actions.

Returns:

This very instance, which enables builder-style method chaining.