net.malisis.core.client.gui.component.interaction

Class UISelect<T>

java.lang.Object

net.malisis.core.client.gui.component.UIComponent<UISelect<T>>

net.malisis.core.client.gui.component.interaction.UISelect<T>

All Implemented Interfaces:

java.lang.Iterable<UISelect.Option<T>>, IGuiText<UISelect<T>>, IKeyListener, ITransformable, ITransformable.Alpha, ITransformable.Position<UISelect<T>>, ITransformable.Size<UISelect<T>>

Direct Known Subclasses:

EcfSelect

public class UISelect<T>
extends UIComponent<UISelect<T>>
implements java.lang.Iterable<UISelect.Option<T>>, IGuiText<UISelect<T>>

The Class UISelect.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UISelect.Option<T> The Class Option.
class	UISelect.OptionsContainer
static class	UISelect.SelectEvent<T> Event fired when a UISelect changes its selected UISelect.Option.

Nested classes/interfaces inherited from interface net.malisis.core.renderer.animation.transformation.ITransformable

ITransformable.Alpha, ITransformable.Brightness, ITransformable.Color, ITransformable.Position<T>, ITransformable.Rotate, ITransformable.Scale, ITransformable.Size<T>, ITransformable.Translate

Field Summary

Fields

Modifier and Type	Field and Description
protected GuiIconProvider	arrowIcon Icon used to draw the arrow.
protected GuiShape	arrowShape Shape used to draw the arrow.
protected int	bgColor Background color
protected FontOptions	disabledFontOptions The FontOptions to use for this UISelect when option is disabled.
protected com.google.common.base.Predicate<T>	disablePredicate Predicate for option disability
protected boolean	expanded Whether this UISelect is expanded.
protected MalisisFont	font The MalisisFont to use for this UISelect.
protected FontOptions	fontOptions The FontOptions to use for this UISelect.
protected int	hoverBgColor Hovered background color
protected FontOptions	hoveredFontOptions The FontOptions to use for this UISelect when option is hovered.
protected com.google.common.base.Function<T,java.lang.String>	labelFunction Function for options label
protected java.lang.String	labelPattern Pattern to use for options labels.
protected int	maxDisplayedOptions Max number displayed options.
protected int	maxExpandedWidth Max width of the option container.
protected com.google.common.base.Function<T,? extends UISelect.Option<T>>	optionFunction Function for option creation
protected com.google.common.collect.FluentIterable<UISelect.Option<T>>	options The options of this UISelect.
protected UISelect.OptionsContainer	optionsContainer Container holding the Options.
protected int	optionsHeight Height of displayed UISelect.Option box
protected int	optionsWidth Width of displayed UISelect.Option box
protected FontOptions	selectedFontOptions The FontOptions to use for this UISelect when option is selected.
protected UISelect.Option<T>	selectedOption Currently selected option index.

Fields inherited from class net.malisis.core.client.gui.component.UIComponent

alpha, anchor, disabled, focused, height, hovered, iconProvider, INHERITED, name, parent, rp, shape, tooltip, visible, width, x, y, zIndex

Constructor Summary

Constructors

Constructor and Description
UISelect(MalisisGui gui, int width) Instantiates a new UISelect.
UISelect(MalisisGui gui, int width, java.lang.Iterable<T> values) Instantiates a new UISelect.

Method Summary

Modifier and Type	Method and Description
void	drawBackground(GuiRenderer renderer, int mouseX, int mouseY, float partialTick) Called first when drawing this UIComponent.
void	drawForeground(GuiRenderer renderer, int mouseX, int mouseY, float partialTick) Called last when drawing this UIComponent.
int	getBgColor()
FontOptions	getDisabledFontOptions() Gets the disabled FontOptions.
MalisisFont	getFont() Gets the MalisisFont.
FontOptions	getFontOptions() Gets the FontOptions.
int	getHoverBgColor()
FontOptions	getHoveredFontOptions() Gets the hovered FontOptions.
UISelect.Option<T>	getOption(T obj) Gets the UISelect.Option corresponding to the object.
FontOptions	getSelectedFontOptions() Gets the selected FontOptions.
protected int	getSelectedIndex()
UISelect.Option<T>	getSelectedOption() Gets the currently selected UISelect.Option.
T	getSelectedValue() Gets the value of the selectedOption.
boolean	isInsideBounds(int x, int y) Checks if supplied coordinates are inside this UIComponent bounds.
java.util.Iterator<UISelect.Option<T>>	iterator()
UISelect<T>	maxDisplayedOptions(int amount) Sets the maximum number of options displayed when expanded.
boolean	onClick(int x, int y) On click.
boolean	onKeyTyped(char keyChar, int keyCode) Called when a key is typed inside MalisisGui.
boolean	onScrollWheel(int x, int y, int delta) On scroll wheel.
T	select(T obj) Selects the UISelect.Option for the specified value.
T	select(UISelect.Option<T> option) Selects the UISelect.Option.
T	selectFirst() Selects the first UISelect.Option of this UISelect.
T	selectLast() Selects the last UISelect.Option of this UISelect.
T	selectNext() Select the UISelect.Option after the currently selected one.
T	selectPrevious() Selects the UISelect.Option before the currently selected one.
UISelect<T>	setBgColor(int bgColor)
UISelect<T>	setColors(int bgColor, int hoverBgColor)
UISelect<T>	setDisabledFontOptions(FontOptions options) Sets the disabled FontOptions.
UISelect<T>	setDisablePredicate(com.google.common.base.Predicate<T> predicate)
UISelect<T>	setFont(MalisisFont font) Sets the MalisisFont.
UISelect<T>	setFontOptions(FontOptions options) Sets the FontOptions.
UISelect<T>	setHoverBgColor(int hoverBgColor)
UISelect<T>	setHoveredFontOptions(FontOptions options) Sets the hovered FontOptions.
UISelect<T>	setLabelFunction(com.google.common.base.Function<T,java.lang.String> func)
UISelect<T>	setLabelPattern(java.lang.String labelPattern) Sets a pattern that will be used to format the option label.
UISelect<T>	setMaxExpandedWidth(int width) Sets the max width of the option container.
UISelect<T>	setOptionFunction(com.google.common.base.Function<T,? extends UISelect.Option<T>> func)
UISelect<T>	setOptions(java.lang.Iterable<T> values) Set the options to use for this UISelect.
UISelect<T>	setSelectedFontOptions(FontOptions options) Sets the selected FontOptions.
void	setSelectedOption(T obj) Sets the selected UISelect.Option from its containing key.
void	setSelectedOption(UISelect.Option<T> option) Sets the selected UISelect.Option.

Methods inherited from class net.malisis.core.client.gui.component.UIComponent

addControlComponent, attachData, componentX, componentY, draw, fireEvent, getAlpha, getAnchor, getComponentAt, getData, getGui, getHeight, getIconProvider, getName, getParent, getPropertyString, getRawHeight, getRawWidth, getRenderer, getTooltip, getWidth, getX, getY, getZIndex, isDisabled, isFocused, isHovered, isRelativeHeight, isRelativeWidth, isVisible, onAddedToScreen, onButtonPress, onButtonRelease, onDoubleClick, onDrag, onMouseMove, onRightClick, parentX, parentY, register, relativeX, relativeY, removeAllControlComponents, removeControlComponent, screenX, screenY, self, setAlpha, setAnchor, setDisabled, setFocused, setHovered, setName, setParent, setPosition, setPosition, setSize, setTooltip, setTooltip, setVisible, setZIndex, toString, unregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

font

protected MalisisFont font

The MalisisFont to use for this UISelect.

fontOptions

protected FontOptions fontOptions

The FontOptions to use for this UISelect.

hoveredFontOptions

protected FontOptions hoveredFontOptions

The FontOptions to use for this UISelect when option is hovered.

selectedFontOptions

protected FontOptions selectedFontOptions

The FontOptions to use for this UISelect when option is selected.

disabledFontOptions

protected FontOptions disabledFontOptions

The FontOptions to use for this UISelect when option is disabled.

options

protected com.google.common.collect.FluentIterable<UISelect.Option<T>> options

The options of this UISelect.

selectedOption

protected UISelect.Option<T> selectedOption

Currently selected option index.

maxExpandedWidth

protected int maxExpandedWidth

Max width of the option container.

maxDisplayedOptions

protected int maxDisplayedOptions

Max number displayed options.

expanded

protected boolean expanded

Whether this UISelect is expanded.

optionsContainer

protected UISelect.OptionsContainer optionsContainer

Container holding the Options.

optionsWidth

protected int optionsWidth

Width of displayed UISelect.Option box

optionsHeight

protected int optionsHeight

Height of displayed UISelect.Option box

labelPattern

protected java.lang.String labelPattern

Pattern to use for options labels.

optionFunction

protected com.google.common.base.Function<T,? extends UISelect.Option<T>> optionFunction

Function for option creation

labelFunction

protected com.google.common.base.Function<T,java.lang.String> labelFunction

Function for options label

disablePredicate

protected com.google.common.base.Predicate<T> disablePredicate

Predicate for option disability

bgColor

protected int bgColor

Background color

hoverBgColor

protected int hoverBgColor

Hovered background color

arrowShape

protected GuiShape arrowShape

Shape used to draw the arrow.

arrowIcon

protected GuiIconProvider arrowIcon

Icon used to draw the arrow.

Constructor Detail

UISelect

public UISelect(MalisisGui gui,
                int width,
                java.lang.Iterable<T> values)

Instantiates a new UISelect.

Parameters:

gui - the gui

width - the width

values - the values

UISelect

public UISelect(MalisisGui gui,
                int width)

Instantiates a new UISelect.

Parameters:

gui - the gui

width - the width

Method Detail

getFont

public MalisisFont getFont()

Description copied from interface: IGuiText

Gets the MalisisFont.

Specified by:

getFont in interface IGuiText<UISelect<T>>

Returns:

the font

setFont

public UISelect<T> setFont(MalisisFont font)

Description copied from interface: IGuiText

Sets the MalisisFont.

Specified by:

setFont in interface IGuiText<UISelect<T>>

Parameters:

font - the new font

Returns:

the t

getFontOptions

public FontOptions getFontOptions()

Description copied from interface: IGuiText

Gets the FontOptions.

Specified by:

getFontOptions in interface IGuiText<UISelect<T>>

Returns:

the font options

setFontOptions

public UISelect<T> setFontOptions(FontOptions options)

Description copied from interface: IGuiText

Sets the FontOptions.

Specified by:

setFontOptions in interface IGuiText<UISelect<T>>

Parameters:

options - the font options

Returns:

the t

getHoveredFontOptions

public FontOptions getHoveredFontOptions()

Gets the hovered FontOptions.

Returns:

the hoveredFontOptions

setSelectedFontOptions

public UISelect<T> setSelectedFontOptions(FontOptions options)

Sets the selected FontOptions.

Parameters:

options - the options

Returns:

this UISelect

getSelectedFontOptions

public FontOptions getSelectedFontOptions()

Gets the selected FontOptions.

Returns:

the selectedFontOptions

setDisabledFontOptions

public UISelect<T> setDisabledFontOptions(FontOptions options)

Sets the disabled FontOptions.

Parameters:

options - the options

Returns:

this UISelect

getDisabledFontOptions

public FontOptions getDisabledFontOptions()

Gets the disabled FontOptions.

Returns:

the disabledFontOptions

setHoveredFontOptions

public UISelect<T> setHoveredFontOptions(FontOptions options)

Sets the hovered FontOptions.

Parameters:

options - the options

Returns:

this UISelect

getBgColor

public int getBgColor()

setBgColor

public UISelect<T> setBgColor(int bgColor)

getHoverBgColor

public int getHoverBgColor()

setHoverBgColor

public UISelect<T> setHoverBgColor(int hoverBgColor)

setColors

public UISelect<T> setColors(int bgColor,
                             int hoverBgColor)

setOptionFunction

public UISelect<T> setOptionFunction(com.google.common.base.Function<T,? extends UISelect.Option<T>> func)

setLabelFunction

public UISelect<T> setLabelFunction(com.google.common.base.Function<T,java.lang.String> func)

setDisablePredicate

public UISelect<T> setDisablePredicate(com.google.common.base.Predicate<T> predicate)

setLabelPattern

public UISelect<T> setLabelPattern(java.lang.String labelPattern)

Sets a pattern that will be used to format the option label.

Parameters:

labelPattern - the label pattern

Returns:

this UISelect

setMaxExpandedWidth

public UISelect<T> setMaxExpandedWidth(int width)

Sets the max width of the option container.

Parameters:

width - the width

Returns:

this UISelect

maxDisplayedOptions

public UISelect<T> maxDisplayedOptions(int amount)

Sets the maximum number of options displayed when expanded.

Parameters:

amount - the amount

Returns:

this UISelect

setOptions

public UISelect<T> setOptions(java.lang.Iterable<T> values)

Set the options to use for this UISelect.

Parameters:

values - the values

Returns:

this UISelect

getOption

public UISelect.Option<T> getOption(T obj)

Gets the UISelect.Option corresponding to the object.

Parameters:

obj - the key of the Option

Returns:

the option

setSelectedOption

public void setSelectedOption(T obj)

Sets the selected UISelect.Option from its containing key.

Parameters:

obj - the new selected option

setSelectedOption

public void setSelectedOption(UISelect.Option<T> option)

Sets the selected UISelect.Option.

Parameters:

option - the new selected option

getSelectedOption

public UISelect.Option<T> getSelectedOption()

Gets the currently selected UISelect.Option.

Returns:

the selected option

getSelectedValue

public T getSelectedValue()

Gets the value of the selectedOption.

Returns:

the selected value

select

public T select(UISelect.Option<T> option)

Selects the UISelect.Option.

Parameters:

option - the option

Returns:

the option value

select

public T select(T obj)

Selects the UISelect.Option for the specified value.

Parameters:

obj - the obj

Returns:

the option value

selectFirst

public T selectFirst()

Selects the first UISelect.Option of this UISelect.

Returns:

the option value

selectLast

public T selectLast()

Selects the last UISelect.Option of this UISelect.

Returns:

the option value

selectPrevious

public T selectPrevious()

Selects the UISelect.Option before the currently selected one.

Returns:

the option value

selectNext

public T selectNext()

Select the UISelect.Option after the currently selected one.

Returns:

the t

getSelectedIndex

protected int getSelectedIndex()

isInsideBounds

public boolean isInsideBounds(int x,
                              int y)

Description copied from class: UIComponent

Checks if supplied coordinates are inside this UIComponent bounds.

Overrides:

isInsideBounds in class UIComponent<UISelect<T>>

Parameters:

x - the x

y - the y

Returns:

true, if coordinates are inside bounds

drawBackground

public void drawBackground(GuiRenderer renderer,
                           int mouseX,
                           int mouseY,
                           float partialTick)

Description copied from class: UIComponent

Called first when drawing this UIComponent.

Specified by:

drawBackground in class UIComponent<UISelect<T>>

Parameters:

renderer - the renderer

mouseX - the mouse x

mouseY - the mouse y

partialTick - the partial tick

drawForeground

public void drawForeground(GuiRenderer renderer,
                           int mouseX,
                           int mouseY,
                           float partialTick)

Description copied from class: UIComponent

Called last when drawing this UIComponent.

Specified by:

drawForeground in class UIComponent<UISelect<T>>

Parameters:

renderer - the renderer

mouseX - the mouse x

mouseY - the mouse y

partialTick - the partial tick

onClick

public boolean onClick(int x,
                       int y)

Description copied from class: UIComponent

On click.

Overrides:

onClick in class UIComponent<UISelect<T>>

Parameters:

x - the x

y - the y

Returns:

true, if successful

onScrollWheel

public boolean onScrollWheel(int x,
                             int y,
                             int delta)

Description copied from class: UIComponent

On scroll wheel.

Overrides:

onScrollWheel in class UIComponent<UISelect<T>>

Parameters:

x - the x

y - the y

delta - the delta

Returns:

true, if successful

onKeyTyped

public boolean onKeyTyped(char keyChar,
                          int keyCode)

Description copied from interface: IKeyListener

Called when a key is typed inside MalisisGui.

Specified by:

onKeyTyped in interface IKeyListener

Overrides:

onKeyTyped in class UIComponent<UISelect<T>>

Parameters:

keyChar - the key char

keyCode - the key code

Returns:

true, to prevent parents and gui to handle the key typed

iterator

public java.util.Iterator<UISelect.Option<T>> iterator()

Specified by:

iterator in interface java.lang.Iterable<UISelect.Option<T>>