com.bonzaiengine.ui.widget

Class Widget

java.lang.Object

com.bonzaiengine.ui.widget.Widget

Direct Known Subclasses:

Button, Panel, TextField

public class Widget
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Widget.NotifyEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	COMMAND_KEY_ENTER
protected static java.lang.String	COMMAND_MOUSE_CLICK
protected static java.lang.String	COMMAND_UNKNOWN
protected boolean	culled
protected int	fontChangeId
protected java.lang.String	fontName
protected int	fontSize
protected IFont	lastFont
protected int	lastFontSize
protected static boolean	RENDER_BACKGROUND
protected static boolean	RENDER_FOREGROUND

Constructor Summary

Constructors

Constructor and Description
Widget()

Method Summary

Modifier and Type	Method and Description
protected boolean	addActionListener(ActionListener listener)
void	addAnimator(WidgetAnimator<?> a)
protected boolean	addChangeListener(ChangeListener l)
void	addFocusListener(FocusListener l)
void	addKeyListener(KeyListener l)
void	addMouseListener(MouseListener l)
void	addMouseMotionListener(MouseMotionListener l)
void	addMouseWheelListener(MouseWheelListener l)
void	bindTo(java.lang.Object object) Associate all field with the annotation BindToName to the Widget contained by this Widget
boolean	contains(Widget widget)
protected void	delayNotifyEvent(Widget.NotifyEvent event) Notify event with a delay, parent notification should use this
boolean	dispatchKeyEvent(UI ui, KeyEvent e, boolean toFocusable)
protected void	dispatchMouseExited(UI ui, MouseEvent e)
EventState	dispatchMouseMoved(UI ui, MouseEvent e, EventState eventState)
EventState	dispatchMousePressed(UI ui, MouseEvent e)
boolean	dispatchMouseReleased(UI ui, MouseEvent e)
EventState	dispatchMouseWheelMoved(UI ui, MouseWheelEvent e)
void	dispatchNotifyEvent(Widget.NotifyEvent event)
protected boolean	dispatchShowPopup(UI ui, MouseEvent e)
protected void	doMoveOpti(int dx, int dy)
<W extends Widget> W	find(java.util.function.Predicate<Widget> predicate)
<W extends Widget> W	find(java.lang.String name)
protected boolean	fireAction(UI ui, InputEvent sourceEvent, java.lang.String command)
protected void	fireAnimator(long timePassedMS)
protected void	fireChange()
protected boolean	fireKeyEvent(UI ui, KeyEvent e)
protected boolean	fireMouseEvent(UI ui, MouseEvent e) Process the mouse events of the widget
protected Widget	focusableTraversalDown(boolean next)
protected Widget	focusableTraversalUp(boolean next)
Widget	focusTraversal(boolean next)
void	forceSize(int w, int h) For the size of a widget.
protected Sprite	getCurrentBackground()
protected Color4	getCurrentBackgroundColor()
Widget	getFocusable()
protected int	getFontSizeForRender(IFont font)
int	getHeightOnScreen()
Insets	getInsets(Insets dst)
int	getInsetsHeight()
int	getInsetsWidth()
void	getLocation(Point dst)
Point	getLocationOnScreen(Point dst)
int	getLocationXOnScreen()
int	getLocationYOnScreen()
<W extends MenuPopup> W	getMenuPopup()
protected int	getMinHeightLayout()
int	getMinHeightWidget()
protected int	getMinWidthLayout()
int	getMinWidthWidget()
<W extends Widget> W	getPopup()
int	getPreferredHeight()
int	getPreferredWidth()
Sprite	getRefBackground()
Widget	getRoot()
<W extends Widget> W	getTooltip()
int	getViewportBorderBottom()
int	getViewportBorderHeight()
int	getViewportBorderLeft()
int	getViewportBorderWidth()
int	getWidthOnScreen()
boolean	hasFocus()
protected boolean	hasKeyEventFocus()
protected boolean	hasMenuPopupVisible()
protected boolean	isBackgroundOpaque()
protected boolean	isDownOrMouseDown()
boolean	isFocusable()
protected boolean	isFree()
boolean	isMouseOverOrDown()
boolean	isOver(int pointX, int pointY)
protected boolean	isOverlappingRendering()
boolean	isRenderingAndEnabled()
protected void	notifyEvent(UI ui, Widget.NotifyEvent event)
protected boolean	onActionPerformed(UI ui, ActionEvent e)
protected void	onDiscardState()
protected void	onFocusChanged(UI ui, FocusEvent e)
protected void	onFontChanged(UI ui)
protected boolean	onKeyPressed(UI ui, KeyEvent e)
protected boolean	onKeyReleased(UI ui, KeyEvent e)
protected boolean	onMouseClicked(UI ui, MouseEvent e)
protected boolean	onMouseDownDragUp(UI ui, MouseEvent e)
protected boolean	onMouseDragged(UI ui, MouseEvent e)
protected void	onMouseEntered(UI ui, MouseEvent e)
protected void	onMouseExited(UI ui, MouseEvent e)
protected boolean	onMouseMoved(UI ui, MouseEvent e)
protected boolean	onMousePressed(UI ui, MouseEvent e)
protected boolean	onMouseReleased(UI ui, MouseEvent e)
protected boolean	onMouseWheelMoved(UI ui, MouseWheelEvent e)
protected void	onMove(int dx, int dy)
protected void	onParentChanged()
protected void	onStateChanged(ChangeEvent e)
protected void	onStyleChanged()
void	refreshFocus()
protected boolean	removeActionListener(ActionListener listener)
protected void	removeAllActionListener()
boolean	removeAnimator(WidgetAnimator<?> a)
protected boolean	removeChangeListener(ChangeListener listener)
boolean	removeFocusListener(FocusListener listener)
boolean	removeKeyListener(KeyListener l)
boolean	removeMouseListener(MouseListener l)
boolean	removeMouseMotionListener(MouseMotionListener l)
boolean	removeMouseWheelListener(MouseWheelListener l)
void	render(UI ui) Widget rendering
protected void	renderGL(UI ui)
void	requestFocus()
protected boolean	resolveBlockEvents(int x, int y)
Widget	resolveLocationRef()
void	setAutoPack(boolean autoPack)
void	setAutoPackHeight(boolean autoPackHeight)
void	setAutoPackWidth(boolean autoPackWidth)
void	setBackgroundColor(Color4 backgroundColor)
protected void	setDown(boolean down)
void	setEnabled(boolean enabled)
void	setFocusable(boolean focusable)
void	setInsets(Insets insets)
void	setInsets(int top, int left, int bottom, int right)
protected void	setIsBackground(boolean isBackground)
void	setLocation(int x, int y) Set the location of this Widget relatively to its parent.
void	setLocation(Point src)
void	setLocationAnchor(Anchor locationAnchor)
void	setLocationRef(java.lang.String locationRef)
void	setLocationRef2(Widget locationRef2)
void	setLocationRefAnchor(Anchor locationAnchorRef)
void	setMaxSize(int w, int h)
void	setMaxSize(Size size)
void	setMenuPopup(MenuPopup menuPopup)
void	setMinSize(int w, int h)
void	setMinSize(Size size)
protected void	setMinSizeLayout(int w, int h)
protected void	setParent(Panel parent)
void	setPopup(Widget popup)
void	setSize(int w, int h) Set size.
void	setSize(Size size)
void	setSizeOnScreen(int w, int h) Entrypoint for layouot manager
void	setStyle(java.lang.String style)
void	setTooltip(Widget tooltip)
void	setVisible(boolean visible)
java.lang.String	toString()
WidgetTraversal.Status	traverse(WidgetTraversal consumer)
protected boolean	triggerChildsUpdate()
boolean	uiFireAction(UI ui, InputEvent event, java.lang.String command) Used internally
void	update(UI ui, long timePassedMS) Widget update.
protected void	updateListenersForPosition()
protected void	updateMinViewport(Viewport dst)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RENDER_BACKGROUND

protected static boolean RENDER_BACKGROUND

RENDER_FOREGROUND

protected static boolean RENDER_FOREGROUND

COMMAND_UNKNOWN

protected static final java.lang.String COMMAND_UNKNOWN

See Also:

Constant Field Values

COMMAND_KEY_ENTER

protected static final java.lang.String COMMAND_KEY_ENTER

See Also:

Constant Field Values

COMMAND_MOUSE_CLICK

protected static final java.lang.String COMMAND_MOUSE_CLICK

See Also:

Constant Field Values

fontName

protected java.lang.String fontName

fontSize

protected int fontSize

lastFont

protected IFont lastFont

lastFontSize

protected int lastFontSize

fontChangeId

protected int fontChangeId

culled

protected boolean culled

Constructor Detail

Widget

public Widget()

Method Detail

getFontSizeForRender

protected final int getFontSizeForRender(IFont font)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

update

public void update(UI ui,
                   long timePassedMS)

Widget update. Occures before rendering to compute current states and absolute positioning.

Parameters:

ui -

timePassedMS -

onStyleChanged

protected void onStyleChanged()

onFontChanged

protected void onFontChanged(UI ui)

triggerChildsUpdate

protected final boolean triggerChildsUpdate()

isFree

protected final boolean isFree()

resolveLocationRef

public final Widget resolveLocationRef()

updateListenersForPosition

protected final void updateListenersForPosition()

updateMinViewport

protected void updateMinViewport(Viewport dst)

getViewportBorderLeft

public int getViewportBorderLeft()

getViewportBorderBottom

public int getViewportBorderBottom()

getViewportBorderWidth

public int getViewportBorderWidth()

getViewportBorderHeight

public int getViewportBorderHeight()

render

public final void render(UI ui)

Widget rendering

isOverlappingRendering

protected boolean isOverlappingRendering()

Returns:

true is the Widget has overlapping rendering element
Default: false
The renderer enables optimizations when no overlapping elements.

renderGL

protected void renderGL(UI ui)

setIsBackground

protected final void setIsBackground(boolean isBackground)

notifyEvent

protected void notifyEvent(UI ui,
                           Widget.NotifyEvent event)

onDiscardState

protected void onDiscardState()

dispatchNotifyEvent

public final void dispatchNotifyEvent(Widget.NotifyEvent event)

delayNotifyEvent

protected final void delayNotifyEvent(Widget.NotifyEvent event)

Notify event with a delay, parent notification should use this

addAnimator

public final void addAnimator(WidgetAnimator<?> a)

Parameters:

a - listener to register to this widget

removeAnimator

public final boolean removeAnimator(WidgetAnimator<?> a)

fireAnimator

protected final void fireAnimator(long timePassedMS)

addActionListener

protected boolean addActionListener(ActionListener listener)

removeActionListener

protected boolean removeActionListener(ActionListener listener)

removeAllActionListener

protected void removeAllActionListener()

uiFireAction

public final boolean uiFireAction(UI ui,
                                  InputEvent event,
                                  java.lang.String command)

Used internally

fireAction

protected final boolean fireAction(UI ui,
                                   InputEvent sourceEvent,
                                   java.lang.String command)

onActionPerformed

protected boolean onActionPerformed(UI ui,
                                    ActionEvent e)

addChangeListener

protected boolean addChangeListener(ChangeListener l)

removeChangeListener

protected boolean removeChangeListener(ChangeListener listener)

fireChange

protected final void fireChange()

onStateChanged

protected void onStateChanged(ChangeEvent e)

addFocusListener

public void addFocusListener(FocusListener l)

Parameters:

l - listener to register to this widget

removeFocusListener

public boolean removeFocusListener(FocusListener listener)

onFocusChanged

protected void onFocusChanged(UI ui,
                              FocusEvent e)

onKeyPressed

protected boolean onKeyPressed(UI ui,
                               KeyEvent e)

onKeyReleased

protected boolean onKeyReleased(UI ui,
                                KeyEvent e)

onMouseClicked

protected boolean onMouseClicked(UI ui,
                                 MouseEvent e)

onMouseEntered

protected void onMouseEntered(UI ui,
                              MouseEvent e)

onMouseExited

protected void onMouseExited(UI ui,
                             MouseEvent e)

onMousePressed

protected boolean onMousePressed(UI ui,
                                 MouseEvent e)

onMouseReleased

protected boolean onMouseReleased(UI ui,
                                  MouseEvent e)

onMouseDownDragUp

protected boolean onMouseDownDragUp(UI ui,
                                    MouseEvent e)

onMouseMoved

protected boolean onMouseMoved(UI ui,
                               MouseEvent e)

onMouseDragged

protected boolean onMouseDragged(UI ui,
                                 MouseEvent e)

onMouseWheelMoved

protected boolean onMouseWheelMoved(UI ui,
                                    MouseWheelEvent e)

resolveBlockEvents

protected boolean resolveBlockEvents(int x,
                                     int y)

isBackgroundOpaque

protected boolean isBackgroundOpaque()

hasMenuPopupVisible

protected boolean hasMenuPopupVisible()

addKeyListener

public void addKeyListener(KeyListener l)

Parameters:

l - listener to register to this widget

removeKeyListener

public final boolean removeKeyListener(KeyListener l)

addMouseListener

public final void addMouseListener(MouseListener l)

Parameters:

l - listener to register to this widget

removeMouseListener

public final boolean removeMouseListener(MouseListener l)

addMouseMotionListener

public final void addMouseMotionListener(MouseMotionListener l)

Parameters:

l - listener to register to this widget

removeMouseMotionListener

public final boolean removeMouseMotionListener(MouseMotionListener l)

addMouseWheelListener

public final void addMouseWheelListener(MouseWheelListener l)

Parameters:

l - listener to register to this widget

removeMouseWheelListener

public final boolean removeMouseWheelListener(MouseWheelListener l)

fireKeyEvent

protected boolean fireKeyEvent(UI ui,
                               KeyEvent e)

fireMouseEvent

protected boolean fireMouseEvent(UI ui,
                                 MouseEvent e)

Process the mouse events of the widget

dispatchKeyEvent

public boolean dispatchKeyEvent(UI ui,
                                KeyEvent e,
                                boolean toFocusable)

hasKeyEventFocus

protected boolean hasKeyEventFocus()

dispatchMousePressed

public EventState dispatchMousePressed(UI ui,
                                       MouseEvent e)

dispatchMouseReleased

public boolean dispatchMouseReleased(UI ui,
                                     MouseEvent e)

dispatchShowPopup

protected boolean dispatchShowPopup(UI ui,
                                    MouseEvent e)

dispatchMouseMoved

public EventState dispatchMouseMoved(UI ui,
                                     MouseEvent e,
                                     EventState eventState)

dispatchMouseExited

protected void dispatchMouseExited(UI ui,
                                   MouseEvent e)

dispatchMouseWheelMoved

public EventState dispatchMouseWheelMoved(UI ui,
                                          MouseWheelEvent e)

isOver

public boolean isOver(int pointX,
                      int pointY)

Returns:

true if the mouse is over the widget

isMouseOverOrDown

public final boolean isMouseOverOrDown()

isDownOrMouseDown

protected final boolean isDownOrMouseDown()

setDown

protected final void setDown(boolean down)

hasFocus

public final boolean hasFocus()

requestFocus

public final void requestFocus()

refreshFocus

public final void refreshFocus()

focusTraversal

public final Widget focusTraversal(boolean next)

Parameters:

next - true to traversal next relatively to this Widget

Returns:

the previous or next Widget focusable

focusableTraversalUp

protected final Widget focusableTraversalUp(boolean next)

focusableTraversalDown

protected Widget focusableTraversalDown(boolean next)

getFocusable

public final Widget getFocusable()

setStyle

public final void setStyle(java.lang.String style)

Parameters:

style - the style of this Widget

getPopup

public final <W extends Widget> W getPopup()

Returns:

the popup Widget

setPopup

public void setPopup(Widget popup)

Parameters:

popup - the new popup Widget

getTooltip

public final <W extends Widget> W getTooltip()

Returns:

the tooltip Widget. A tooltip is a Widget shown when mouse remains over this Widget.

setTooltip

public void setTooltip(Widget tooltip)

Parameters:

tooltip - the new tooltip Widget

getMenuPopup

public final <W extends MenuPopup> W getMenuPopup()

Returns:

the menuPopup Widget. A menuPopup is a Widget shown when right click on this Widget.

setMenuPopup

public void setMenuPopup(MenuPopup menuPopup)

Parameters:

menuPopup - the new menuPopup Widget

setParent

protected final void setParent(Panel parent)

Parameters:

parent - owner of this Widget

onParentChanged

protected void onParentChanged()

bindTo

public void bindTo(java.lang.Object object)

Associate all field with the annotation BindToName to the Widget contained by this Widget

Throws:

java.lang.SecurityException

java.lang.NoSuchMethodException

traverse

public WidgetTraversal.Status traverse(WidgetTraversal consumer)

find

public <W extends Widget> W find(java.util.function.Predicate<Widget> predicate)

find

public final <W extends Widget> W find(java.lang.String name)

Returns:

the first Widget with the specified name found, or null if non found

contains

public final boolean contains(Widget widget)

Returns:

the root Widget this

getRoot

public final Widget getRoot()

Returns:

the root Widget this

setAutoPack

public final void setAutoPack(boolean autoPack)

Parameters:

autoPack -

See Also:

setAutoPackWidth(boolean), setAutoPackHeight(boolean)

setAutoPackWidth

public final void setAutoPackWidth(boolean autoPackWidth)

setAutoPackHeight

public final void setAutoPackHeight(boolean autoPackHeight)

setEnabled

public final void setEnabled(boolean enabled)

Parameters:

enabled - true to enable this widget

See Also:

#isEnabledHerited(), isRenderingAndEnabled()

setVisible

public void setVisible(boolean visible)

Parameters:

visible - true to show this widget, false to hide him

isFocusable

public final boolean isFocusable()

Returns:

true if this Widget is focusable

setFocusable

public final void setFocusable(boolean focusable)

Parameters:

focusable - true to set this Widget focusable

isRenderingAndEnabled

public final boolean isRenderingAndEnabled()

getLocation

public final void getLocation(Point dst)

Parameters:

dst - destination Point to store this Widget relative location.
The location is relative to this Widget parent and anchors, if any.

See Also:

getLocationOnScreen(Point), #getLocationAnchor(), #getLocationRefAnchor()

setLocation

public final void setLocation(Point src)

Parameters:

src - new relative location

See Also:

setLocation(int, int)

setLocation

public final void setLocation(int x,
                              int y)

Set the location of this Widget relatively to its parent.

Parameters:

x - position along x axis, 0 is left

y - position along y axis, 0 is bottom

onMove

protected void onMove(int dx,
                      int dy)

doMoveOpti

protected void doMoveOpti(int dx,
                          int dy)

setLocationAnchor

public final void setLocationAnchor(Anchor locationAnchor)

Parameters:

locationAnchor - new location anchor, default is Anchor.BotLeft

setLocationRef

public final void setLocationRef(java.lang.String locationRef)

Parameters:

locationRef -

setLocationRef2

public final void setLocationRef2(Widget locationRef2)

Parameters:

locationRef2 -

setLocationRefAnchor

public final void setLocationRefAnchor(Anchor locationAnchorRef)

Parameters:

locationAnchorRef -

getLocationOnScreen

public final Point getLocationOnScreen(Point dst)

Parameters:

dst - destination Point to store this Widget absolute location.

See Also:

getLocation(Point)

getLocationXOnScreen

public final int getLocationXOnScreen()

Returns:

the preferred width

getLocationYOnScreen

public final int getLocationYOnScreen()

Returns:

the preferred height

forceSize

public final void forceSize(int w,
                            int h)

For the size of a widget. Recommended only to set the root widget to a fixed size.

setSize

public final void setSize(Size size)

See Also:

setSize(int, int)

setSize

public final void setSize(int w,
                          int h)

Set size.
The size on screen may be different due to constraint and layout resolution.

Parameters:

w - new width

h - new height

setMinSize

public final void setMinSize(Size size)

setMinSize

public final void setMinSize(int w,
                             int h)

getMinWidthLayout

protected final int getMinWidthLayout()

getMinHeightLayout

protected final int getMinHeightLayout()

setMinSizeLayout

protected final void setMinSizeLayout(int w,
                                      int h)

getPreferredWidth

public final int getPreferredWidth()

Returns:

the minimum width after layout constraint applied

getPreferredHeight

public final int getPreferredHeight()

Returns:

the minimum height after layout constraint applied

getMinWidthWidget

public final int getMinWidthWidget()

Returns:

the minimum width after layout constraint applied

getMinHeightWidget

public final int getMinHeightWidget()

Returns:

the minimum height after layout constraint applied

setMaxSize

public final void setMaxSize(Size size)

setMaxSize

public final void setMaxSize(int w,
                             int h)

setSizeOnScreen

public final void setSizeOnScreen(int w,
                                  int h)

Entrypoint for layouot manager

getWidthOnScreen

public final int getWidthOnScreen()

Returns:

the preferred width

getHeightOnScreen

public final int getHeightOnScreen()

Returns:

the preferred height

getInsets

public final Insets getInsets(Insets dst)

Returns:

this Widget insets

getInsetsWidth

public final int getInsetsWidth()

getInsetsHeight

public final int getInsetsHeight()

setInsets

public final void setInsets(Insets insets)

setInsets

public final void setInsets(int top,
                            int left,
                            int bottom,
                            int right)

setBackgroundColor

public final void setBackgroundColor(Color4 backgroundColor)

Parameters:

backgroundColor - the color of the text

getCurrentBackgroundColor

protected final Color4 getCurrentBackgroundColor()

getCurrentBackground

protected final Sprite getCurrentBackground()

getRefBackground

public final Sprite getRefBackground()