Package swingtree

Class SplitItemDelegate<I extends JMenuItem>

java.lang.Object

swingtree.AbstractDelegate<I>

swingtree.SplitItemDelegate<I>

Type Parameters:

I - The JMenuItem subtype for which this context was created.

public final class SplitItemDelegate<I extends JMenuItem>
extends AbstractDelegate<I>

Instances of this are delegated to the individual JSplitButton items and their ActionEvents exposed to you inside your Action handlers, like for example one you would supply to SplitItem.onSelection(Action). This class exists to give said actions all the necessary context they need to perform their tasks.

Method Summary

Modifier and Type	Method	Description
SplitItemDelegate<I>	appendToButtonText(String postfix)	Appends the supplied String to the text displayed on the JSplitButton.
SplitItemDelegate<I>	displayCurrentItemText()	Use this to conveniently make the JSplitButton display the text of the currently selected JMenuItem (button item).
String	getButtonText()	Allows you to retrieve the text currently displayed on the JSplitButton.
final I	getCurrentItem()	Exposes the JMenuItem which is currently selected by the user and displayed as the button item of the JSplitButton.
ActionEvent	getEvent()	Exposes the underlying ActionEvent that is being handled by this delegate.
List<I>	getSiblinghood()	This method provides a convenient way to access all the children of the parent component of the split item this delegate is for.
List<I>	getSiblings()	Exposes the "siblings" of the delegated component, which refers to all children of its parent component, except for itself.
JSplitButton	getSplitButton()	Returns the underlying JSplitButton instance or throws an exception if the current thread is not the Swing thread.
SplitItemDelegate<I>	prependToButtonText(String prefix)	A convenience method which takes the supplied String and prepends it to the text displayed on the JSplitButton.
SplitItemDelegate<I>	selectAllItems()	Selects all JMenuItems by passing true to their AbstractButton.setSelected(boolean) methods.
SplitItemDelegate<I>	selectCurrentItem()	Selects the current JMenuItem by passing true to the AbstractButton.setSelected(boolean) method.
SplitItemDelegate<I>	selectItem(int i)	Selects the targeted split item (JMenuItem).
SplitItemDelegate<I>	selectOnlyCurrentItem()	Selects only the current JMenuItem by passing true to the AbstractButton.setSelected(boolean) method.
SplitItemDelegate<I>	selectOnlyItem(int i)	Selects the targeted split item (JMenuItem) and unselects all other items.
SplitItemDelegate<I>	setButtonText(String text)	Takes the supplied String and passes it to the AbstractButton.setText(String) while running on the UI thread.
SplitItemDelegate<I>	unselectAllItems()	Unselects all JMenuItems by passing false to their AbstractButton.setSelected(boolean) methods.
SplitItemDelegate<I>	unselectCurrentItem()	Unselects the current JMenuItem by passing false to the AbstractButton.setSelected(boolean) method.
SplitItemDelegate<I>	unselectItem(int i)	Unselects the targeted split item (JMenuItem).

Methods inherited from class swingtree.AbstractDelegate

_component, _isUndefinedColor, _isUndefinedFont, _siblingsSource, animateFor, animateFor, animateFor, animateFor, animateStyleFor, animateStyleFor, find, find, find, findAll, findAllByGroup, findAllByGroup, findAllByGroup, findAllByGroup, get, getBackground, getBorder, getBounds, getCursor, getFont, getForeground, getHeight, getLocation, getMaxSize, getMinSize, getParent, getPrefSize, getScale, getSize, getTooltip, getWidth, getX, getY, isEnabled, isOpaque, isVisible, paint, paint, paint, paint, parentDelegate, scale, scale, scale, scale, setBackground, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBorder, setBounds, setBounds, setBounds, setCursor, setCursor, setEnabled, setFont, setForeground, setForegroundColor, setForegroundColor, setForegroundColor, setForegroundColor, setHeight, setMaxHeight, setMaxSize, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinSize, setMinWidth, setOpaque, setPrefHeight, setPrefSize, setPrefSize, setPrefSize, setPrefWidth, setSize, setSize, setSize, setTooltip, setVisible, setWidth, shapeOf, style

Methods inherited from class java.lang.Object

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

Method Details

getEvent

public ActionEvent getEvent()

Exposes the underlying ActionEvent that is being handled by this delegate. It is a semantic event which indicates that a component-defined action occurred. This high-level event is generated by the split button when the component-specific action occurs (such as being pressed). The event is originally passed to every ActionListener object that registered to receive such events using the component's addActionListener method.

Returns:

The ActionEvent which caused this action to be executed.

getSplitButton

public JSplitButton getSplitButton()

Returns the underlying JSplitButton instance or throws an exception if the current thread is not the Swing thread.

Returns:

The JSplitButton to which this SplitItem (and its JMenuItem) belongs.

getCurrentItem

public final I getCurrentItem()

Exposes the JMenuItem which is currently selected by the user and displayed as the button item of the JSplitButton. This is the item which caused the ActionEvent to be fired.

Returns:

The JMenuItem which caused this action to be executed.

getSiblinghood

public List<I> getSiblinghood()

This method provides a convenient way to access all the children of the parent component of the split item this delegate is for.

Returns:

A list of all the JMenuItem which constitute the options exposed by the JSplitButton.

getSiblings

public List<I> getSiblings()

Exposes the "siblings" of the delegated component, which refers to all children of its parent component, except for itself. This is contrary to the getSiblinghood() method which returns all children of the parent component including the current component.

Returns:

A list of all the JMenuItem which constitute the options exposed by the JSplitButton except the current JMenuItem exposed by getCurrentItem().

selectCurrentItem

public SplitItemDelegate<I> selectCurrentItem()

Selects the current JMenuItem by passing true to the AbstractButton.setSelected(boolean) method.

Returns:

This SplitItemDelegate instance to allow for method chaining.

selectOnlyCurrentItem

public SplitItemDelegate<I> selectOnlyCurrentItem()

Selects only the current JMenuItem by passing true to the AbstractButton.setSelected(boolean) method. All other JMenuItems will be unselected.

Returns:

This SplitItemDelegate instance to allow for method chaining.

unselectCurrentItem

public SplitItemDelegate<I> unselectCurrentItem()

Unselects the current JMenuItem by passing false to the AbstractButton.setSelected(boolean) method.

Returns:

This SplitItemDelegate instance to allow for method chaining.

unselectAllItems

public SplitItemDelegate<I> unselectAllItems()

Unselects all JMenuItems by passing false to their AbstractButton.setSelected(boolean) methods.

Returns:

This SplitItemDelegate instance to allow for method chaining.

selectAllItems

public SplitItemDelegate<I> selectAllItems()

Selects all JMenuItems by passing true to their AbstractButton.setSelected(boolean) methods.

Returns:

This SplitItemDelegate instance to allow for method chaining.

displayCurrentItemText

public SplitItemDelegate<I> displayCurrentItemText()

Use this to conveniently make the JSplitButton display the text of the currently selected JMenuItem (button item).

Returns:

This SplitItemDelegate instance to allow for method chaining.

setButtonText

public SplitItemDelegate<I> setButtonText(String text)

Takes the supplied String and passes it to the AbstractButton.setText(String) while running on the UI thread.

Parameters:

text - The text which should be displayed on the JSplitButton.

Returns:

This SplitItemDelegate instance to allow for method chaining.

getButtonText

public String getButtonText()

Allows you to retrieve the text currently displayed on the JSplitButton.

Returns:

The text displayed on the JSplitButton.

appendToButtonText

public SplitItemDelegate<I> appendToButtonText(String postfix)

Appends the supplied String to the text displayed on the JSplitButton.

Parameters:

postfix - The text which should be appended to the text displayed on the JSplitButton.

Returns:

This SplitItemDelegate instance to allow for method chaining.

prependToButtonText

public SplitItemDelegate<I> prependToButtonText(String prefix)

A convenience method which takes the supplied String and prepends it to the text displayed on the JSplitButton. This method is equivalent to calling setButtonText(String) with the concatenation of the supplied String and the current text displayed on the JSplitButton.

Parameters:

prefix - The text which should be prepended to the text displayed on the JSplitButton.

Returns:

This SplitItemDelegate instance to allow for method chaining.

selectItem

public SplitItemDelegate<I> selectItem(int i)

Selects the targeted split item (JMenuItem).

Parameters:

i - The item index of the JMenuItem which should be selected.

Returns:

This SplitItemDelegate instance to allow for method chaining.

selectOnlyItem

public SplitItemDelegate<I> selectOnlyItem(int i)

Selects the targeted split item (JMenuItem) and unselects all other items.

Parameters:

i - The item index of the JMenuItem which should be selected exclusively.

Returns:

This SplitItemDelegate instance to allow for method chaining.

unselectItem

public SplitItemDelegate<I> unselectItem(int i)

Unselects the targeted split item (JMenuItem).

Parameters:

i - The item index of the JMenuItem which should be unselected.

Returns:

This SplitItemDelegate instance to allow for method chaining.