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

Class UISelect

java.lang.Object

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

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

All Implemented Interfaces:

java.lang.Iterable<UISelect.Option>, IClipable, ITransformable, ITransformable.Alpha, ITransformable.Position<UISelect>, ITransformable.Size<UISelect>

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

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 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 boolean	expanded Whether this UISelect is expanded.
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 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 java.util.HashMap<java.lang.Integer,UISelect.Option>	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 int	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.util.HashMap<java.lang.Integer,UISelect.Option> options) 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.
ClipArea	getClipArea() Gets ClipArea to be used for glScissor
protected UISelect.Option	getHoveredOption(int mouseX, int mouseY)
UISelect.Option	getOption(java.lang.Object obj) Gets the UISelect.Option corresponding to the object.
UISelect.Option	getSelectedOption() Gets the currently selected UISelect.Option.
int	getZIndex() Gets the zIndex of this UIComponent.
boolean	isInsideBounds(int x, int y) Checks if supplied coordinates are inside this UIComponent bounds.
boolean	isOptionHovered(UISelect.Option option)
java.util.Iterator<UISelect.Option>	iterator()
UISelect	maxDisplayedOptions(int amount) Sets the maximum number of options displayed when expanded.
void	onClick(MouseEvent.Release event) On click.
void	onKeyTyped(KeyboardEvent event) On key typed.
void	onScrollWheel(MouseEvent.ScrollWheel event) On scroll wheel.
UISelect.Option	select(int index) Select the UISelect.Option using the index.
UISelect.Option	select(java.lang.Object obj) Select the UISelect.Option corresponding to the object.
UISelect.Option	select(UISelect.Option option)
void	setClipContent(boolean clip) Sets whether this IClipable should clip or not.
void	setFocused(boolean focused) Sets the focused state of this UIComponent.
UISelect	setLabelPattern(java.lang.String labelPattern) Sets a pattern that will be used to format the option label.
UISelect	setMaxExpandedWidth(int width) Sets the max width of the option container.
UISelect	setOptions(java.util.HashMap<java.lang.Integer,UISelect.Option> options) Set the options to use for this UISelect
void	setSelectedOption(int index) Sets the selected UISelect.Option from its position in the list.
void	setSelectedOption(java.lang.Object obj) Sets the selected UISelect.Option from its containing key.
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, fireKeyboardEvent, fireMouseEvent, getAlpha, getAnchor, getComponentAt, getGui, getHeight, getName, getParent, getPropertyString, getRawHeight, getRawWidth, getTooltip, getWidth, getX, getY, isDisabled, isFocused, isHovered, isRelativeHeight, isRelativeWidth, isVisible, onAddedToScreen, 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

options

protected java.util.HashMap<java.lang.Integer,UISelect.Option> options

The options of this UISelect.

selectedOption

protected int 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.

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.util.HashMap<java.lang.Integer,UISelect.Option> options)

Instantiates a new UISelect

Parameters:

gui - the gui

width - the width

options - the options

UISelect

public UISelect(MalisisGui gui,
        int width)

Instantiates a new UISelect.

Parameters:

gui - the gui

width - the width

Method Detail

setFocused

public void setFocused(boolean focused)

Description copied from class: UIComponent

Sets the focused state of this UIComponent.

Overrides:

setFocused in class UIComponent<UISelect>

Parameters:

focused - the state

setLabelPattern

public UISelect 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 setMaxExpandedWidth(int width)

Sets the max width of the option container.

Parameters:

width - the width

Returns:

this UISelect

maxDisplayedOptions

public UISelect maxDisplayedOptions(int amount)

Sets the maximum number of options displayed when expanded.

Parameters:

amount - the amount

Returns:

this UISelect

setOptions

public UISelect setOptions(java.util.HashMap<java.lang.Integer,UISelect.Option> options)

Set the options to use for this UISelect

Parameters:

options - the options

Returns:

this UISelect

setSelectedOption

public void setSelectedOption(int index)

Sets the selected UISelect.Option from its position in the list.

Parameters:

index - the new selected option

setSelectedOption

public void setSelectedOption(java.lang.Object obj)

Sets the selected UISelect.Option from its containing key.

Parameters:

obj - the new selected option

getOption

public UISelect.Option getOption(java.lang.Object obj)

Gets the UISelect.Option corresponding to the object.

Parameters:

obj - the key of the Option

Returns:

the option

getSelectedOption

public UISelect.Option getSelectedOption()

Gets the currently selected UISelect.Option.

Returns:

the selected option

select

public UISelect.Option select(int index)

Select the UISelect.Option using the index.

Parameters:

index - the index

Returns:

the option

select

public UISelect.Option select(UISelect.Option option)

select

public UISelect.Option select(java.lang.Object obj)

Select the UISelect.Option corresponding to the object.

Parameters:

obj - the obj

Returns:

the option

getHoveredOption

protected UISelect.Option getHoveredOption(int mouseX,
                               int mouseY)

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>

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>

Returns:

the zIndex

isOptionHovered

public boolean isOptionHovered(UISelect.Option option)

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>

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>

Parameters:

renderer - the renderer

mouseX - the mouse x

mouseY - the mouse y

partialTick - the partial tick

onClick

public void onClick(MouseEvent.Release event)

On click.

Parameters:

event - the event

onScrollWheel

public void onScrollWheel(MouseEvent.ScrollWheel event)

On scroll wheel.

Parameters:

event - the event

onKeyTyped

public void onKeyTyped(KeyboardEvent event)

On key typed.

Parameters:

event - the event

iterator

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

Specified by:

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