org.mini2Dx.ui.element

Class Modal

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.ParentUiElement

org.mini2Dx.ui.element.Column

org.mini2Dx.ui.element.Container

org.mini2Dx.ui.element.Modal

All Implemented Interfaces:

Hoverable, Navigatable

Direct Known Subclasses:

AbsoluteModal, AlignedModal

public abstract class Modal
extends Container
implements Navigatable

A Container implementation that can be navigated by player input and supports hotkeys

Field Summary

Fields inherited from class org.mini2Dx.ui.element.ParentUiElement

asyncAddQueue, asyncRemoveAll, asyncRemoveQueue, children, renderNode

Fields inherited from class org.mini2Dx.ui.element.UiElement

deferredQueue, effects, styleId, visibility, zIndex

Constructor Summary

Constructors

Constructor and Description
Modal()
Modal(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	clearControllerHotkeys() Unmaps all controller hotkeys
void	clearHotkeys() Unmaps all hotkeys
void	clearKeyboardHotkeys() Unmaps all keyboard hotkeys
UiNavigation	getNavigation() Returns the UiNavigation currently being navigated
ActionableRenderNode	hotkey(ControllerButton button) Returns the corresponding ActionableRenderNode mapped to a ControllerButton hotkey
ActionableRenderNode	hotkey(int keycode) Returns the corresponding ActionableRenderNode mapped to a keyboard hotkey
ActionableRenderNode	navigate(int keycode) Triggers a navigation and returns the newly highlighted ActionableRenderNode
void	setHotkey(ControllerButton button, Actionable actionable) Maps a ControllerButton to a Actionable
void	setHotkey(int keycode, Actionable actionable) Maps a keyboard button to a Actionable
void	setNavigation(UiNavigation navigation)
void	syncWithRenderNode() Syncs data between the UiElement and RenderNode
void	unsetHotkey(ControllerButton button) Unmaps a ControllerButton hotkey
void	unsetHotkey(int keycode) Unmaps a keyboard hotkey

Methods inherited from class org.mini2Dx.ui.element.Column

createRenderNode, withElements, withElements

Methods inherited from class org.mini2Dx.ui.element.ParentUiElement

add, add, addAsync, attach, defer, detach, getElementById, getFlexDirection, getLayout, getTotalChildren, remove, remove, removeAll, removeAllAsync, removeAsync, setFlexDirection, setLayout, setStyleId, setVisibility, setZIndex

Methods inherited from class org.mini2Dx.ui.element.UiElement

addEffectListener, addHoverListener, applyEffect, equals, getId, getStyleId, getVisibility, getZIndex, hashCode, isDebugEnabled, notifyEffectListenersOnFinished, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, removeEffectListener, removeHoverListener, setDebugEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mini2Dx.ui.element.Navigatable

getId

Constructor Detail

Modal

public Modal()

Modal

public Modal(java.lang.String id)

Method Detail

syncWithRenderNode

public void syncWithRenderNode()

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode

Overrides:

syncWithRenderNode in class ParentUiElement

navigate

public ActionableRenderNode navigate(int keycode)

Description copied from interface: Navigatable

Triggers a navigation and returns the newly highlighted ActionableRenderNode

Specified by:

navigate in interface Navigatable

Parameters:

keycode - The navigation Input.Keys value

Returns:

Null if no UiNavigation is available

hotkey

public ActionableRenderNode hotkey(int keycode)

Description copied from interface: Navigatable

Returns the corresponding ActionableRenderNode mapped to a keyboard hotkey

Specified by:

hotkey in interface Navigatable

Parameters:

keycode - The Input.Keys keycode that is the hotkey

Returns:

Null if there is no mapping

hotkey

public ActionableRenderNode hotkey(ControllerButton button)

Description copied from interface: Navigatable

Returns the corresponding ActionableRenderNode mapped to a ControllerButton hotkey

Specified by:

hotkey in interface Navigatable

Parameters:

button - The ControllerButton that is the hotkey

Returns:

Null if there is no mapping

setHotkey

public void setHotkey(ControllerButton button,
                      Actionable actionable)

Description copied from interface: Navigatable

Maps a ControllerButton to a Actionable

Specified by:

setHotkey in interface Navigatable

Parameters:

button - The ControllerButton that is the hotkey

actionable - The Actionable to trigger when the hotkey is pressed

setHotkey

public void setHotkey(int keycode,
                      Actionable actionable)

Description copied from interface: Navigatable

Maps a keyboard button to a Actionable

Specified by:

setHotkey in interface Navigatable

Parameters:

keycode - The Input.Keys keycode that is the hotkey

actionable - The Actionable to trigger when the key is pressed

unsetHotkey

public void unsetHotkey(ControllerButton button)

Description copied from interface: Navigatable

Unmaps a ControllerButton hotkey

Specified by:

unsetHotkey in interface Navigatable

Parameters:

button - The ControllerButton that is the hotkey

unsetHotkey

public void unsetHotkey(int keycode)

Description copied from interface: Navigatable

Unmaps a keyboard hotkey

Specified by:

unsetHotkey in interface Navigatable

Parameters:

keycode - The Input.Keys keycode that is the hotkey

clearControllerHotkeys

public void clearControllerHotkeys()

Description copied from interface: Navigatable

Unmaps all controller hotkeys

Specified by:

clearControllerHotkeys in interface Navigatable

clearKeyboardHotkeys

public void clearKeyboardHotkeys()

Description copied from interface: Navigatable

Unmaps all keyboard hotkeys

Specified by:

clearKeyboardHotkeys in interface Navigatable

clearHotkeys

public void clearHotkeys()

Description copied from interface: Navigatable

Unmaps all hotkeys

Specified by:

clearHotkeys in interface Navigatable

getNavigation

public UiNavigation getNavigation()

Description copied from interface: Navigatable

Returns the UiNavigation currently being navigated

Specified by:

getNavigation in interface Navigatable

Returns:

Null if no navigation is occurring

setNavigation

public void setNavigation(UiNavigation navigation)