com.bonzaiengine.ui

Class UI

java.lang.Object

com.bonzaiengine.ui.UI

All Implemented Interfaces:

KeyListener, MouseListener, MouseMotionListener, MouseWheelListener

public class UI
extends java.lang.Object
implements KeyListener, MouseListener, MouseMotionListener, MouseWheelListener

Field Summary

Fields

Modifier and Type	Field and Description
boolean	bestUpdateConvergence Deprecated.
int	flag Internal flag
static float	SCALE UI theme scaling factor, must be set prior theme loading and ui updating

Constructor Summary

Constructors

Constructor and Description
UI(Theme theme, AssetManager assets)

Method Summary

Modifier and Type	Method and Description
void	addDialog(Widget dialog)
static AssetManager	createAssets()
static UI	current() Deprecated.
AssetManager	getAssets()
Widget	getContents()
Viewport	getCurrentViewport()
Widget	getFocus()
int	getNumDialogs()
Widget	getPopup()
SpriteRenderer	getSpriteRenderer()
Theme	getTheme()
Widget	getTooltip()
UiListener	getUiListener()
boolean	hasFocus(Widget widget)
boolean	isUnderPopupOrDialog(Widget widget)
boolean	keyPressed(KeyEvent e)
boolean	keyReleased(KeyEvent e)
boolean	keyTyped(KeyEvent e) UI/Widget: Press and release
boolean	mouseClicked(MouseEvent e)
boolean	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
boolean	mouseMoved(MouseEvent e)
boolean	mousePressed(MouseEvent e)
boolean	mouseReleased(MouseEvent e)
boolean	mouseWheelMoved(MouseWheelEvent e)
void	performAction(Widget widget, InputEvent event)
void	registerListeners(IComponent component)
BatchProfile	render(IGLApi glApi, Viewport viewport) UI rendering
static int	scale(int i)
void	setContents(Widget contents)
void	setFocus(Widget widget)
void	setPopup(Widget popup)
void	setTooltip(Widget tooltip)
void	setUiListener(UiListener uiListener)
void	update(ISceneTarget sceneTarget, Viewport viewport, long timePassedMS) Update and process events of this UI (contents, popup and dialogs).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCALE

public static float SCALE

UI theme scaling factor, must be set prior theme loading and ui updating

bestUpdateConvergence

@Deprecated
public boolean bestUpdateConvergence

Deprecated.

Disable fast update convergence (may require more cpu)

flag

public int flag

Internal flag

Constructor Detail

UI

public UI(Theme theme,
          AssetManager assets)

Method Detail

scale

public static final int scale(int i)

current

@Deprecated
public static final UI current()

Deprecated.

createAssets

public static AssetManager createAssets()

getTheme

public final Theme getTheme()

Returns:

the Theme of this UI

getSpriteRenderer

public final SpriteRenderer getSpriteRenderer()

Returns:

the SpriteRenderer of this UI. It is used by Widget for rendering.

setUiListener

public final void setUiListener(UiListener uiListener)

getUiListener

public final UiListener getUiListener()

registerListeners

public final void registerListeners(IComponent component)

Parameters:

component - component to register the events to, usually from ISceneTarget

setContents

public final void setContents(Widget contents)

Parameters:

contents - widget containing the contents of this UI

getContents

public final Widget getContents()

Returns:

this UI contents

setPopup

public final void setPopup(Widget popup)

Parameters:

popup - used by widgets to show a popup

getPopup

public final Widget getPopup()

setTooltip

public final void setTooltip(Widget tooltip)

Parameters:

tooltip - used by widgets to show a tooltip

getTooltip

public final Widget getTooltip()

addDialog

public final void addDialog(Widget dialog)

Parameters:

dialog - add a blocking dialog, will be automatically removed when not visible

getNumDialogs

public final int getNumDialogs()

Returns:

the number of active dialogs

setFocus

public final void setFocus(Widget widget)

Parameters:

widget - a Widget to request focus, the Widget must be focusable or null.

Throws:

java.lang.IllegalArgumentException - if the specified widget is not focusable

getFocus

public final Widget getFocus()

hasFocus

public final boolean hasFocus(Widget widget)

Returns:

true if the widget has the focus

isUnderPopupOrDialog

public final boolean isUnderPopupOrDialog(Widget widget)

update

public final void update(ISceneTarget sceneTarget,
                         Viewport viewport,
                         long timePassedMS)

Update and process events of this UI (contents, popup and dialogs).

Parameters:

glApi -

viewport -

timePassedMS - time passed for time based animation

getCurrentViewport

public final Viewport getCurrentViewport()

Returns:

the Viewport passed to UI#update(IGLApi, Viewport, long), returns null if not called from inside UI#update(IGLApi, Viewport, long)

render

public final BatchProfile render(IGLApi glApi,
                                 Viewport viewport)

UI rendering

Parameters:

glApi -

viewport -

Returns:

information on rendering performances

getAssets

public final AssetManager getAssets()

keyPressed

public final boolean keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

Parameters:

e - the KeyEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

keyReleased

public final boolean keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

Parameters:

e - the KeyEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

keyTyped

public final boolean keyTyped(KeyEvent e)

Description copied from interface: KeyListener

UI/Widget: Press and release

Specified by:

keyTyped in interface KeyListener

Parameters:

e - the KeyEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

mouseEntered

public final void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

Parameters:

e - the MouseEvent

mouseExited

public final void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

Parameters:

e - the MouseEvent

mouseClicked

public final boolean mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

Parameters:

e - the MouseEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

mousePressed

public final boolean mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

Parameters:

e - the MouseEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

mouseReleased

public final boolean mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

Parameters:

e - the MouseEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

mouseDragged

public final boolean mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

Parameters:

e - the MouseEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

mouseMoved

public final boolean mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

Parameters:

e - the MouseEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

mouseWheelMoved

public final boolean mouseWheelMoved(MouseWheelEvent e)

Specified by:

mouseWheelMoved in interface MouseWheelListener

Parameters:

e - the MouseWheelEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

performAction

public final void performAction(Widget widget,
                                InputEvent event)