com.bonzaiengine.ui

Class UI

java.lang.Object

com.bonzaiengine.ui.UI

All Implemented Interfaces:

FocusListener, KeyListener, MouseListener, MouseMotionListener, MouseWheelListener

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

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()

Method Summary

Modifier and Type	Method and Description
void	addDialog(Widget dialog)
void	closeAllDialogs() Close all active dialogs
static AssetManager	createAssets()
void	focusGained(FocusEvent e)
void	focusLost(FocusEvent e)
static UI	getIfCurrent() Deprecated.
int	getNumDialogs()
Widget	getPopup()
boolean	hasFocus(Widget widget)
boolean	isUnderPopupOrDialog(Widget widget)
boolean	keyPressed(KeyEvent e)
boolean	keyReleased(KeyEvent e)
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, java.lang.String command)
protected void	processEvents(ISceneTarget sceneTarget, Viewport viewport)
void	registerListeners(IComponent component)
void	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	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

clone, equals, finalize, 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()

Method Detail

scale

public static final int scale(int i)

getIfCurrent

@Deprecated
public static UI getIfCurrent()

Deprecated.

Should only be used internally

createAssets

public static AssetManager createAssets()

registerListeners

public void registerListeners(IComponent component)

Parameters:

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

setContents

public void setContents(Widget contents)

Parameters:

contents - widget containing the contents of this UI

setPopup

public void setPopup(Widget popup)

Parameters:

popup - used by widgets to show a popup

getPopup

public Widget getPopup()

addDialog

public void addDialog(Widget dialog)

Parameters:

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

getNumDialogs

public int getNumDialogs()

Returns:

the number of active dialogs

closeAllDialogs

public void closeAllDialogs()

Close all active dialogs

setFocus

public 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

hasFocus

public boolean hasFocus(Widget widget)

Returns:

true if the widget has the focus

isUnderPopupOrDialog

public boolean isUnderPopupOrDialog(Widget widget)

update

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

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

Parameters:

viewport -

timePassedMS - time passed for time based animation

render

public void render(IGLApi glApi,
                   Viewport viewport)

UI rendering

Parameters:

glApi -

viewport -

processEvents

protected void processEvents(ISceneTarget sceneTarget,
                             Viewport viewport)

keyPressed

public 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 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

mouseClicked

public 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 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 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 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 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 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

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

Parameters:

e - the MouseEvent

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

Parameters:

e - the MouseEvent

focusGained

public void focusGained(FocusEvent e)

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent e)

Specified by:

focusLost in interface FocusListener

performAction

public void performAction(Widget widget,
                          InputEvent event,
                          java.lang.String command)