UISelect (MalisisCore 1.7.10-0.12.2 API)

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>>, IClipable, IGuiText<UISelect<T>>, IKeyListener, ITransformable, ITransformable.Alpha, ITransformable.Position<UISelect<T>>, ITransformable.Size<UISelect<T>>
```
public class UISelect<T>
extends UIComponent<UISelect<T>>
implements java.lang.Iterable<UISelect.Option<T>>, IClipable, 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.
`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 GuiIcon`	`arrowIcon` Icon used to draw the arrow.
`protected GuiShape`	`arrowShape` Shape used to draw the arrow.
`protected int`	`bgColor` Background color
`protected FontRenderOptions`	`disabledFro` The `FontRenderOptions` 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 FontRenderOptions`	`fro` The `FontRenderOptions` to use for this `UISelect`.
`protected int`	`hoverBgColor` Hovered background color
`protected FontRenderOptions`	`hoveredFro` The `FontRenderOptions` to use for this `UISelect` when option is hovered.
`protected GuiIcon`	`iconsExpanded` Icon used to draw the option container.
`protected GuiIcon`	`iconsSelect` Icon used to draw this `UISelect`.
`protected GuiIcon`	`iconsSelectDisabled` Icon used to draw this `UISelect` when disabled.
`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 GuiShape`	`optionBackground` Shape used to draw the hovered `UISelect.Option` background
`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 int`	`optionsHeight` Height of displayed `UISelect.Option` box
`protected GuiShape`	`optionsShape` Shape used to draw the `options` box
`protected int`	`optionsWidth` Width of displayed `UISelect.Option` box
`protected FontRenderOptions`	`selectedFro` The `FontRenderOptions` 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, icon, 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

Methods
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()`
`ClipArea`	`getClipArea()` Gets `ClipArea` to be used for glScissor
`FontRenderOptions`	`getDisabledFontRendererOptions()` Gets the disabled `FontRenderOptions`.
`MalisisFont`	`getFont()` Gets the `MalisisFont` used for this `UILabel`.
`FontRenderOptions`	`getFontRendererOptions()` Gets the `FontRenderOptions` used for this `UILabel`.
`int`	`getHoverBgColor()`
`FontRenderOptions`	`getHoveredFontRendererOptions()` Gets the hovered `FontRenderOptions`.
`UISelect.Option<T>`	`getOption(T obj)` Gets the `UISelect.Option` corresponding to the object.
`protected UISelect.Option<T>`	`getOptionAt(int mouseX, int mouseY)` Gets the `UISelect.Option` at the speicfied coordinates.
`FontRenderOptions`	`getSelectedFontRendererOptions()` Gets the selected `FontRenderOptions`.
`UISelect.Option<T>`	`getSelectedOption()` Gets the currently selected `UISelect.Option`.
`T`	`getSelectedValue()` Gets the value of the `selectedOption`.
`int`	`getZIndex()` Gets the zIndex of this `UIComponent`.
`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)`
`void`	`setClipContent(boolean clip)` Sets whether this `IClipable` should clip or not.
`UISelect<T>`	`setColors(int bgColor, int hoverBgColor)`
`UISelect<T>`	`setDisabledFontRendererOptions(FontRenderOptions fro)` Sets the disabled `FontRenderOptions`.
`UISelect<T>`	`setDisablePredicate(com.google.common.base.Predicate<T> predicate)`
`void`	`setFocused(boolean focused)` Sets the `focused` state of this `UIComponent`.
`UISelect<T>`	`setFont(MalisisFont font, FontRenderOptions fro)` Sets the `MalisisFont` and `FontRenderOptions` to use for this `UILabel`.
`UISelect<T>`	`setHoverBgColor(int hoverBgColor)`
`UISelect<T>`	`setHoveredFontRendererOptions(FontRenderOptions fro)` Sets the hovered `FontRenderOptions`.
`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>`	`setSelectedFontRendererOptions(FontRenderOptions fro)` Sets the selected `FontRenderOptions`.
`void`	`setSelectedOption(T obj)` Sets the selected `UISelect.Option` from its containing key.
`void`	`setSelectedOption(UISelect.Option<T> option)` Sets the selected `UISelect.Option`.
`boolean`	`shouldClipContent()` Checks whether this `IClipable` should clip or not.

Methods inherited from class net.malisis.core.client.gui.component.UIComponent
addControlComponent, componentX, componentY, draw, fireEvent, getAlpha, getAnchor, getComponentAt, getGui, getHeight, getName, getParent, getPropertyString, getRawHeight, getRawWidth, getRenderer, getTooltip, getWidth, getX, getY, isDisabled, isFocused, isHovered, isRelativeHeight, isRelativeWidth, isVisible, onAddedToScreen, onButtonPress, onButtonRelease, onDoubleClick, onDrag, onMouseMove, onRightClick, parentX, parentY, register, relativeX, relativeY, removeAllControlComponents, removeControlComponent, screenX, screenY, setAlpha, setAnchor, setDisabled, 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 net.malisis.core.client.gui.component.IClipable
getHeight, getParent, getWidth, screenX, screenY

- Field Detail
  - font
```
protected MalisisFont font
```
    The MalisisFont to use for this UISelect. If null, uses GuiRenderer.getDefaultFont().
  - fro
```
protected FontRenderOptions fro
```
    The FontRenderOptions to use for this UISelect. If null, uses GuiRenderer.getDefaultFontRendererOptions().
  - hoveredFro
```
protected FontRenderOptions hoveredFro
```
    The FontRenderOptions to use for this UISelect when option is hovered.
  - selectedFro
```
protected FontRenderOptions selectedFro
```
    The FontRenderOptions to use for this UISelect when option is selected.
  - disabledFro
```
protected FontRenderOptions disabledFro
```
    The FontRenderOptions 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.
  - 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.
  - optionsShape
```
protected GuiShape optionsShape
```
    Shape used to draw the options box
  - optionBackground
```
protected GuiShape optionBackground
```
    Shape used to draw the hovered UISelect.Option background
  - iconsSelect
```
protected GuiIcon iconsSelect
```
    Icon used to draw this UISelect.
  - iconsSelectDisabled
```
protected GuiIcon iconsSelectDisabled
```
    Icon used to draw this UISelect when disabled.
  - iconsExpanded
```
protected GuiIcon iconsExpanded
```
    Icon used to draw the option container.
  - arrowIcon
```
protected GuiIcon 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()
```
    Gets the MalisisFont used for this UILabel.
    
    Specified by:
    
    getFont in interface IGuiText<UISelect<T>>
    
    Returns:
    the font
  - getFontRendererOptions
```
public FontRenderOptions getFontRendererOptions()
```
    Gets the FontRenderOptions used for this UILabel.
    
    Specified by:
    
    getFontRendererOptions in interface IGuiText<UISelect<T>>
    
    Returns:
    the font renderer options
  - setFont
```
public UISelect<T> setFont(MalisisFont font,
                  FontRenderOptions fro)
```
    Sets the MalisisFont and FontRenderOptions to use for this UILabel.
    
    Specified by:
    
    setFont in interface IGuiText<UISelect<T>>
    
    Parameters:
    font - the new font
    fro - the fro
  - getHoveredFontRendererOptions
```
public FontRenderOptions getHoveredFontRendererOptions()
```
    Gets the hovered FontRenderOptions.
    
    Returns:
    the hoveredFro
  - setSelectedFontRendererOptions
```
public UISelect<T> setSelectedFontRendererOptions(FontRenderOptions fro)
```
    Sets the selected FontRenderOptions.
    
    Parameters:
    fro - the fro
    
    Returns:
    this UISelect
  - getSelectedFontRendererOptions
```
public FontRenderOptions getSelectedFontRendererOptions()
```
    Gets the selected FontRenderOptions.
    
    Returns:
    the hoveredFro
  - setDisabledFontRendererOptions
```
public UISelect<T> setDisabledFontRendererOptions(FontRenderOptions fro)
```
    Sets the disabled FontRenderOptions.
    
    Parameters:
    fro - the fro
    
    Returns:
    this UISelect
  - getDisabledFontRendererOptions
```
public FontRenderOptions getDisabledFontRendererOptions()
```
    Gets the disabled FontRenderOptions.
    
    Returns:
    the hoveredFro
  - setHoveredFontRendererOptions
```
public UISelect<T> setHoveredFontRendererOptions(FontRenderOptions fro)
```
    Sets the hovered FontRenderOptions.
    
    Parameters:
    fro - the fro
    
    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)
```
  - setFocused
```
public void setFocused(boolean focused)
```
    Description copied from class: UIComponent
    
    Sets the focused state of this UIComponent.
    
    Overrides:
    
    setFocused in class UIComponent<UISelect<T>>
    
    Parameters:
    focused - the state
  - 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
  - getOptionAt
```
protected UISelect.Option<T> getOptionAt(int mouseX,
                             int mouseY)
```
    Gets the UISelect.Option at the speicfied coordinates.
    
    Parameters:
    mouseX - the mouse x
    mouseY - the mouse y
    
    Returns:
    the option
  - 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
  - getZIndex
```
public int getZIndex()
```
    Description copied from class: UIComponent
    
    Gets the zIndex of this UIComponent.
    
    Overrides:
    
    getZIndex in class UIComponent<UISelect<T>>
    
    Returns:
    the zIndex
  - getClipArea
```
public ClipArea getClipArea()
```
    Description copied from interface: IClipable
    
    Gets ClipArea to be used for glScissor
    
    Specified by:
    
    getClipArea in interface IClipable
    
    Returns:
    the clip area.
  - setClipContent
```
public void setClipContent(boolean clip)
```
    Description copied from interface: IClipable
    
    Sets whether this IClipable should clip or not.
    
    Specified by:
    
    setClipContent in interface IClipable
    
    Parameters:
    clip - the new clip content
  - shouldClipContent
```
public boolean shouldClipContent()
```
    Description copied from interface: IClipable
    
    Checks whether this IClipable should clip or not.
    
    Specified by:
    
    shouldClipContent in interface IClipable
    
    Returns:
    true, if should clip
  - 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>>

Class UISelect<T>

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface net.malisis.core.client.gui.component.IClipable

Field Detail

font

fro

hoveredFro

selectedFro

disabledFro

options

selectedOption

maxExpandedWidth

maxDisplayedOptions

expanded

optionsWidth

optionsHeight

labelPattern

optionFunction

labelFunction

disablePredicate

bgColor

hoverBgColor

arrowShape

optionsShape

optionBackground

iconsSelect

iconsSelectDisabled

iconsExpanded

arrowIcon

Constructor Detail

UISelect

UISelect

Method Detail

getFont

getFontRendererOptions

setFont

getHoveredFontRendererOptions

setSelectedFontRendererOptions

getSelectedFontRendererOptions

setDisabledFontRendererOptions

getDisabledFontRendererOptions

setHoveredFontRendererOptions

getBgColor

setBgColor

getHoverBgColor

setHoverBgColor

setColors

setOptionFunction

setLabelFunction

setDisablePredicate

setFocused

setLabelPattern

setMaxExpandedWidth

maxDisplayedOptions

setOptions

getOption

setSelectedOption

setSelectedOption

getSelectedOption

getSelectedValue

select

select

selectFirst

selectLast

selectPrevious

selectNext

getOptionAt

isInsideBounds

getZIndex

getClipArea

setClipContent

shouldClipContent

drawBackground