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

Constructor Summary

Constructors

Constructor and Description
Widget()

Method Summary

Modifier and Type	Method and Description
void	addAnimator(com.bonzaiengine.ui.anim.WidgetAnimator<?> a)
void	addFocusListener(FocusListener l)
void	addKeyListener(KeyListener l)
void	addMouseFocusListener(FocusListener l)
void	addMouseListener(MouseListener l)
void	addMouseMotionListener(MouseMotionListener l)
void	addMouseWheelListener(MouseWheelListener l)
<W extends Widget> W	find(java.lang.String name)
boolean	find(Widget widget)
Widget	focusTraversal(boolean next)
void	forceSize(int w, int h) For the size of a widget.
Sprite	getBackground()
Sprite	getBackgroundBorder()
float[]	getBackgroundColor()
Sprite	getBackgroundFocus()
Sprite	getBackgroundOver()
Sprite	getBackgroundPress()
int	getBorderSize()
Constraint	getConstraint()
float	getDisableFade()
int	getHeight()
int	getHeightOnScreen()
void	getInsets(Insets dst)
int	getInsetsBottom()
int	getInsetsHeight()
int	getInsetsLeft()
int	getInsetsRight()
int	getInsetsTop()
int	getInsetsWidth()
void	getLocation(Point dst)
Anchor	getLocationAnchor()
Point	getLocationOnScreen(Point dst)
java.lang.String	getLocationRef()
Widget	getLocationRef2()
Anchor	getLocationRefAnchor()
int	getLocationX()
int	getLocationXOnScreen()
int	getLocationY()
int	getLocationYOnScreen()
int	getMaxHeight()
int	getMaxWidth()
<W extends MenuPopup> W	getMenuPopup()
int	getMinHeight()
int	getMinHeightWidget()
int	getMinWidth()
int	getMinWidthWidget()
java.lang.String	getName()
float	getOpacity()
Panel	getParent()
<W extends Widget> W	getPopup()
Widget	getRoot()
java.lang.String	getStyle()
<W extends Widget> W	getTooltip()
Viewport	getViewport()
Viewport	getViewportInternal()
int	getWidth()
int	getWidthOnScreen()
boolean	hasFocus()
boolean	isAutoPackHeight()
boolean	isAutoPackWidth()
boolean	isEnabled()
boolean	isEnabledHerited()
boolean	isEventsOnExternalDrag()
boolean	isExternalDrag()
boolean	isFocusable()
boolean	isMouseDown()
boolean	isMouseOver()
boolean	isMouseOverOrDown()
boolean	isOver(int mX, int mY)
boolean	isVisible()
boolean	isVisibleAndEnabledHerited()
boolean	isVisibleHerited()
boolean	keyPressed(UI ui, KeyEvent e)
boolean	keyReleased(UI ui, KeyEvent e)
boolean	mouseClicked(UI ui, MouseEvent e)
boolean	mouseDragged(UI ui, MouseEvent e, boolean catched)
void	mouseEntered(UI ui, MouseEvent e)
void	mouseExited(UI ui, MouseEvent e)
boolean	mouseMoved(UI ui, MouseEvent e, boolean catched)
boolean	mousePressed(UI ui, MouseEvent e)
boolean	mouseReleased(UI ui, MouseEvent e)
boolean	mouseWheelMoved(UI ui, MouseWheelEvent e)
void	refreshFocus()
boolean	removeAnimator(com.bonzaiengine.ui.anim.WidgetAnimator<?> a)
boolean	removeFocusListener(FocusListener listener)
boolean	removeKeyListener(KeyListener l)
boolean	removeMouseFocusListener(FocusListener listener)
boolean	removeMouseListener(MouseListener l)
boolean	removeMouseMotionListener(MouseMotionListener l)
boolean	removeMouseWheelListener(MouseWheelListener l)
void	render(UI ui) Widget rendering
void	requestFocus()
void	setAutoPack(boolean autoPack)
void	setAutoPackHeight(boolean autoPackHeight)
void	setAutoPackWidth(boolean autoPackWidth)
void	setBackground(Sprite background)
void	setBackgroundBorder(Sprite backgroundBorder)
void	setBackgroundColor(Color4 backgroundColor)
void	setBackgroundFocus(Sprite backgroundFocus)
void	setBackgroundOver(Sprite backgroundOver)
void	setBackgroundPress(Sprite backgroundPress)
void	setBorderSize(int borderSize)
void	setCatchAllEvents(boolean catchAllEvents)
void	setDisableFade(float disableFade)
void	setEnabled(boolean enabled)
void	setEventsOnExternalDrag(boolean eventsOnExternalDrag)
void	setExternalDrag(boolean externalDrag)
void	setFocusable(boolean focusable)
void	setFocusOwner(Widget widget)
void	setInsets(Insets insets)
void	setInsets(int top, int left, int bottom, int right)
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	setLocationAndAnchorInViewport(int x, int y, Anchor defaultAnchor, Insets anchorInsetsOrNull, Viewport viewport) Set location and location anchor for this Widget.
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)
void	setName(java.lang.String name)
void	setOpacity(float opacity)
void	setPopup(Widget popup)
void	setSize(int w, int h) Set size.
void	setSize(Size size)
void	setStyle(java.lang.String style)
void	setTooltip(Widget tooltip)
void	setVisible(boolean visible)
java.lang.String	toString()
void	uiFireAction(UI ui, InputEvent event) Used internally
void	update(UI ui, long timePassedMS) Widget update.

Methods inherited from class java.lang.Object

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

Constructor Detail

Widget

public Widget()

Method Detail

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 -

render

public final void render(UI ui)

Widget rendering

addAnimator

public final void addAnimator(com.bonzaiengine.ui.anim.WidgetAnimator<?> a)

Parameters:

a - listener to register to this widget

removeAnimator

public final boolean removeAnimator(com.bonzaiengine.ui.anim.WidgetAnimator<?> a)

uiFireAction

public final void uiFireAction(UI ui,
                               InputEvent event)

Used internally

addFocusListener

public final void addFocusListener(FocusListener l)

Parameters:

l - listener to register to this widget

removeFocusListener

public final boolean removeFocusListener(FocusListener listener)

addMouseFocusListener

public final void addMouseFocusListener(FocusListener l)

Parameters:

l - listener to register to this widget

removeMouseFocusListener

public final boolean removeMouseFocusListener(FocusListener listener)

setCatchAllEvents

public void setCatchAllEvents(boolean catchAllEvents)

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)

keyPressed

public boolean keyPressed(UI ui,
                          KeyEvent e)

keyReleased

public boolean keyReleased(UI ui,
                           KeyEvent e)

mouseEntered

public void mouseEntered(UI ui,
                         MouseEvent e)

mouseExited

public void mouseExited(UI ui,
                        MouseEvent e)

mousePressed

public boolean mousePressed(UI ui,
                            MouseEvent e)

mouseReleased

public boolean mouseReleased(UI ui,
                             MouseEvent e)

mouseClicked

public final boolean mouseClicked(UI ui,
                                  MouseEvent e)

mouseMoved

public boolean mouseMoved(UI ui,
                          MouseEvent e,
                          boolean catched)

mouseDragged

public boolean mouseDragged(UI ui,
                            MouseEvent e,
                            boolean catched)

mouseWheelMoved

public boolean mouseWheelMoved(UI ui,
                               MouseWheelEvent e)

isOver

public boolean isOver(int mX,
                      int mY)

Returns:

true if the mouse is over the widget

isMouseOver

public final boolean isMouseOver()

isMouseDown

public final boolean isMouseDown()

isMouseOverOrDown

public final boolean isMouseOverOrDown()

setFocusOwner

public final void setFocusOwner(Widget widget)

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

getName

public final java.lang.String getName()

Returns:

the name of the widget

setName

public final void setName(java.lang.String name)

Parameters:

name - the name of the widget

getStyle

public final java.lang.String getStyle()

Returns:

the style of this Widget

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:

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:

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:

the - new menuPopup Widget

getParent

public final Panel getParent()

Returns:

the owner of this Widget

find

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

Returns:

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

find

public boolean find(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)

isAutoPackWidth

public final boolean isAutoPackWidth()

isAutoPackHeight

public final boolean isAutoPackHeight()

isEnabled

public final boolean isEnabled()

Returns:

the enable state of this widget

setEnabled

public final void setEnabled(boolean enabled)

Parameters:

enabled - true to enable this widget

See Also:

isEnabledHerited(), isVisibleAndEnabledHerited()

isVisible

public final boolean isVisible()

Returns:

the visibility state of this widget

See Also:

isVisibleHerited(), isVisibleAndEnabledHerited()

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

isVisibleAndEnabledHerited

public final boolean isVisibleAndEnabledHerited()

isVisibleHerited

public final boolean isVisibleHerited()

isEnabledHerited

public final boolean isEnabledHerited()

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

getLocationAnchor

public final Anchor getLocationAnchor()

Returns:

the location anchor (external anchor)

setLocationAnchor

public final void setLocationAnchor(Anchor locationAnchor)

Parameters:

locationAnchor - new location anchor, default is Anchor.BotLeft

setLocationAndAnchorInViewport

public final void setLocationAndAnchorInViewport(int x,
                                                 int y,
                                                 Anchor defaultAnchor,
                                                 Insets anchorInsetsOrNull,
                                                 Viewport viewport)

Set location and location anchor for this Widget.
If the Widget exceeds the specified viewport, location anchor is adjusted to fit the best inside viewport.

Parameters:

x - location x (not on screen, relatively to parent)

y - location y (not on screen, relatively to parent)

defaultAnchor - default location anchor

anchorInsetsOrNull - insets around the location, or null for no offset. Default usage is null, could be usefull if anchor is around the mouse cursor.

viewport - on screen viewport which defines the bounding box area that this Widget should not exceed.

getLocationRef

public final java.lang.String getLocationRef()

Returns:

the location reference

setLocationRef

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

Parameters:

locationRef -

getLocationRef2

public final Widget getLocationRef2()

Returns:

the location reference

setLocationRef2

public final void setLocationRef2(Widget locationRef2)

Parameters:

locationRef2 -

getLocationRefAnchor

public final Anchor getLocationRefAnchor()

Returns:

the location reference anchor

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)

getLocationX

public final int getLocationX()

Returns:

the preferred width

getLocationY

public final int getLocationY()

Returns:

the preferred height

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

getWidth

public final int getWidth()

Returns:

this Widget preferred width

getHeight

public final int getHeight()

Returns:

this Widget preferred height

getMinWidth

public final int getMinWidth()

Returns:

the minimum width set by user (excluding layout constraint)

getMinHeight

public final int getMinHeight()

Returns:

the minimum height set by user (excluding layout constraint)

setMinSize

public final void setMinSize(Size size)

setMinSize

public final void setMinSize(int w,
                             int h)

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

getMaxWidth

public final int getMaxWidth()

Returns:

the minimum width

getMaxHeight

public final int getMaxHeight()

Returns:

the minimum height

setMaxSize

public final void setMaxSize(Size size)

setMaxSize

public final void setMaxSize(int w,
                             int h)

getWidthOnScreen

public final int getWidthOnScreen()

Returns:

the preferred width

getHeightOnScreen

public final int getHeightOnScreen()

Returns:

the preferred height

getViewport

public final Viewport getViewport()

Returns:

the area used by this Widget

getViewportInternal

public final Viewport getViewportInternal()

Returns:

the area inside insets used by this Widget

getConstraint

public final Constraint getConstraint()

Returns:

this Widget Constraint

getInsets

public final void getInsets(Insets dst)

getInsetsTop

public final int getInsetsTop()

getInsetsBottom

public final int getInsetsBottom()

getInsetsLeft

public final int getInsetsLeft()

getInsetsRight

public final int getInsetsRight()

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)

getOpacity

public final float getOpacity()

Returns:

the opacity of this component

setOpacity

public final void setOpacity(float opacity)

setDisableFade

public void setDisableFade(float disableFade)

Parameters:

disableFade - set the fade value when this Widget is disabled

getDisableFade

public final float getDisableFade()

Returns:

the fade value when this Widget is disabled

setBackground

public final void setBackground(Sprite background)

Parameters:

background - the background sprite

getBackground

public final Sprite getBackground()

Returns:

the background sprite

setBackgroundPress

public final void setBackgroundPress(Sprite backgroundPress)

Parameters:

backgroundPress - the background press sprite

getBackgroundPress

public final Sprite getBackgroundPress()

Returns:

the background press sprite

setBackgroundOver

public final void setBackgroundOver(Sprite backgroundOver)

Parameters:

backgroundOver - the background over sprite

getBackgroundOver

public final Sprite getBackgroundOver()

Returns:

the background color of this widget

setBackgroundBorder

public final void setBackgroundBorder(Sprite backgroundBorder)

Parameters:

backgroundBorder - the background border sprite

getBackgroundBorder

public final Sprite getBackgroundBorder()

Returns:

the background border sprite

setBorderSize

public final void setBorderSize(int borderSize)

Parameters:

borderSize - border size in pixel of this Widget. Default: 1

getBorderSize

public final int getBorderSize()

Returns:

the border size of the background border texture. The border may exceed to Widget Viewport

setBackgroundFocus

public final void setBackgroundFocus(Sprite backgroundFocus)

Parameters:

backgroundFocus - the background focus sprite

getBackgroundFocus

public final Sprite getBackgroundFocus()

Returns:

the background focus sprite

setBackgroundColor

public final void setBackgroundColor(Color4 backgroundColor)

Parameters:

backgroundColor - the color of the text

getBackgroundColor

public final float[] getBackgroundColor()

Returns:

the color of the text

setExternalDrag

public final void setExternalDrag(boolean externalDrag)

isExternalDrag

public final boolean isExternalDrag()

Returns:

true if this Widget fire drag event when drag is outside of its area

setEventsOnExternalDrag

public void setEventsOnExternalDrag(boolean eventsOnExternalDrag)

isEventsOnExternalDrag

public boolean isEventsOnExternalDrag()

Returns:

true if this Widget receives events when another Widget is dragging