Inheritance diagram for com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >:

Collaboration diagram for com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >:

Public Member Functions
void	dispose ()

Dimension	getMinimumSize ()

Dimension	getPreferredSize ()

TooltipText	getTooltip ()

void	setBounds (final int x, final int y, final int width, final int height)

Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
int	getDialogBorderBottom ()

int	getDialogBorderLeft ()

int	getDialogBorderRight ()

int	getDialogBorderTop ()

String	getName ()

void	inhibitListeners ()

boolean	isDefault ()

boolean	isIgnore ()

void	mouseClicked (@NotNull final MouseEvent e)

void	mouseDragged (@NotNull final MouseEvent e)

void	mouseEntered (@NotNull final MouseEvent e)

void	mouseExited (@NotNull final MouseEvent e)

void	mouseMoved (@NotNull final MouseEvent e)

void	mousePressed (@NotNull final MouseEvent e)

void	mouseReleased (@NotNull final MouseEvent e)

void	mouseWheelMoved (final int wheelRotation)

void	setChanged ()

void	setChangedListener (@Nullable final GUIElementChangedListener changedListener)

void	setDefault (final boolean isDefault)

void	setIgnore ()

String	toString ()

Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.GUIElement
void	notifyOpen ()

Protected Member Functions
abstract String	getDescription (@Nullable T item)

abstract Component	getListCellRendererComponent (@NotNull final JList<? extends T > list, @Nullable final T value, final int index, final boolean selected, final boolean cellHasFocus)

	GUIComboBox (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @Nullable final GUILabelLog label, @NotNull final GuiFactory guiFactory)

void	setSelectedItem (@NotNull final T item)

void	updateModel (@Nullable final List< T > elements)

void	updateSelectedItem ()

abstract void	updateSelectedItem (@Nullable final T item)

Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
	AbstractGUIElement (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final boolean opaque, @NotNull final GuiFactory guiFactory)

TooltipText	newTooltipText (@Nullable final String tooltipText)

void	tooltipChanged ()

Private Attributes
final ActionListener	actionListener = e -> updateSelectedItem()

final JComboBox< T >	comboBox = new JComboBox<>(model)

boolean	inhibitActionListener

final GUILabelLog	label

final DefaultComboBoxModel< T >	model = new DefaultComboBoxModel<>()

Static Private Attributes
static final Pattern	PATTERN_BOLD_BEGIN = Pattern.compile("\\[b]")

static final Pattern	PATTERN_BOLD_END = Pattern.compile("\\[/b]")

static final long	serialVersionUID = 1

Detailed Description

A GUIElement that displays a combo box.

Parameters

<T>	the type of the entries of this list

Author: Andreas Kirschbaum

Definition at line 50 of file GUIComboBox.java.

Constructor & Destructor Documentation

◆ GUIComboBox()

com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.GUIComboBox	(	@NotNull final TooltipManager	tooltipManager,
		@NotNull final GUIElementListener	elementListener,
		@NotNull final String	name,
		@Nullable final GUILabelLog	label,
		@NotNull final GuiFactory	guiFactory
	)

protected

Creates a new instance.

Parameters

tooltipManager	the tooltip manager to update
elementListener	the element listener to notify
name	the name of this element
label	the label to update or null
guiFactory	the global GUI factory instance

Definition at line 106 of file GUIComboBox.java.

Member Function Documentation

◆ dispose()

void com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.dispose ( )

Releases all allocated resources.

Reimplemented from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.

Definition at line 117 of file GUIComboBox.java.

◆ getDescription()

abstract String com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.getDescription ( @Nullable T item )

abstractprotected

Returns the description for an item.

Parameters

item the item

Returns: the description

Referenced by com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.getTooltip(), and com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.updateSelectedItem().

Here is the caller graph for this function:

◆ getListCellRendererComponent()

abstract Component com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.getListCellRendererComponent	(	@NotNull final JList<? extends T >	list,
		@Nullable final T	value,
		final int	index,
		final boolean	selected,
		final boolean	cellHasFocus
	)

abstractprotected

Returns a Component that displays the

value

.

Parameters

list	the list that contains the value
value	the value that is displayed or null
index	the list index
selected	whether the value is selected
cellHasFocus	whether the value has the focus

Returns: the component to render the value

◆ getMinimumSize()

Dimension com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.getMinimumSize ( )

Definition at line 129 of file GUIComboBox.java.

◆ getPreferredSize()

Dimension com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.getPreferredSize ( )

Definition at line 123 of file GUIComboBox.java.

◆ getTooltip()

TooltipText com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.getTooltip ( )

Returns the current tooltip text.

Returns: the tooltip text or
null

to not show a tooltip

Reimplemented from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.

Definition at line 235 of file GUIComboBox.java.

◆ setBounds()

void com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.setBounds	(	final int	x,
		final int	y,
		final int	width,
		final int	height
	)

Definition at line 135 of file GUIComboBox.java.

◆ setSelectedItem()

void com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.setSelectedItem ( @NotNull final T item )

protected

Updates the selected item.

Parameters

item	the new selected item

Definition at line 221 of file GUIComboBox.java.

◆ updateModel()

void com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.updateModel ( @Nullable final List< T > elements )

protected

Updates entries shown in the combo box.

Parameters

elements the new entries to show

Definition at line 144 of file GUIComboBox.java.

Referenced by com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.updateModel().

Here is the caller graph for this function:

◆ updateSelectedItem() [1/2]

void com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.updateSelectedItem ( )

protected

Called whenever the selected item has changed.

Definition at line 195 of file GUIComboBox.java.

Referenced by com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.updateModel(), and com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.updateSelectedItem().

Here is the caller graph for this function:

◆ updateSelectedItem() [2/2]

abstract void com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.updateSelectedItem ( @Nullable final T item )

abstractprotected

Will be called whenever the selected item has changed.

Parameters

item	the selected item

Member Data Documentation

◆ actionListener

final ActionListener com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.actionListener = e -> updateSelectedItem()

private

The ActionListener for comboBox.

Definition at line 91 of file GUIComboBox.java.

Referenced by com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.dispose(), and com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.GUIComboBox().

◆ comboBox

final JComboBox<T> com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.comboBox = new JComboBox<>(model)

private

The Swing component that implements the combo box.

Definition at line 85 of file GUIComboBox.java.

◆ inhibitActionListener

boolean com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.inhibitActionListener

private

If set, ignores calls to actionListener.

Definition at line 96 of file GUIComboBox.java.

Referenced by com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.updateModel(), and com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.updateSelectedItem().

◆ label

final GUILabelLog com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.label

private

The GUILog to update or

null

.

Definition at line 79 of file GUIComboBox.java.

Referenced by com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.GUIComboBox(), and com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.updateSelectedItem().

◆ model

final DefaultComboBoxModel<T> com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.model = new DefaultComboBoxModel<>()

private

The model for comboBox.

Definition at line 73 of file GUIComboBox.java.

Referenced by com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.updateModel().

◆ PATTERN_BOLD_BEGIN

final Pattern com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.PATTERN_BOLD_BEGIN = Pattern.compile("\\[b]")

staticprivate

A Pattern that matches "[b]".

Definition at line 61 of file GUIComboBox.java.

Referenced by com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.getTooltip().

◆ PATTERN_BOLD_END

final Pattern com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.PATTERN_BOLD_END = Pattern.compile("\\[/b]")

staticprivate

A Pattern that matches "[/b]".

Definition at line 67 of file GUIComboBox.java.

Referenced by com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< Integer >.getTooltip().

◆ serialVersionUID

final long com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >.serialVersionUID = 1

staticprivate

The serial version UID.

Definition at line 55 of file GUIComboBox.java.

The documentation for this class was generated from the following file:

src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/combobox/GUIComboBox.java

Public Member Functions

Protected Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GUIComboBox()

Member Function Documentation

◆ dispose()

◆ getDescription()

◆ getListCellRendererComponent()

◆ getMinimumSize()

◆ getPreferredSize()

◆ getTooltip()

◆ setBounds()

◆ setSelectedItem()

◆ updateModel()

◆ updateSelectedItem() [1/2]

◆ updateSelectedItem() [2/2]

Member Data Documentation

◆ actionListener

◆ comboBox

◆ inhibitActionListener

◆ label

◆ model

◆ PATTERN_BOLD_BEGIN

◆ PATTERN_BOLD_END

◆ serialVersionUID