Dragengine.Gui.BgButton Class Reference

Button with state dependent background image and optional text and image. More...

Inheritance diagram for Dragengine.Gui.BgButton:

Public Member Functions
void	dispose ()
	Dispose of widget.
Image	getImage ()
	Image of the button.
Image	getImageBgPressed ()
	Pressed background image.
Image	getImageBgUnpressed ()
	Unpressed background image.
String	getText ()
	Text of the button.
BorderSize	getTextPadding ()
	Text padding.
void	lockSize ()
	Lock size to unpressed or presed image size, whichever exists.
BgButton	new (Image bgUnpressed, Image bgPressed)
	Create button.
BgButton	new (Image bgUnpressed, Image bgPressed, String text, Image image)
	Create button.
void	onStateChanged (StateChangeEvent event)
	State changed.
void	setFont (Font font)
void	setImage (Image image)
	Set image of the button.
void	setImageBgPressed (Image image)
	Set pressed background image.
void	setImageBgUnpressed (Image image)
	Set unpressed background image.
void	setText (String text)
	Set text of the button.
void	setTextColor (Color color)
void	setTextPadding (BorderSize padding)
	Set text padding.
void	setTextPadding (int padding)
	Set text padding.
void	unlockSize ()
	Unlock size.
void	updateBackgroundImage ()
Public Member Functions inherited from Dragengine.Gui.Button
void	createContentWidgets ()
	Create button content widgets.
void	fireAction (int modifiers)
Image	getHoverImage ()
	Hover image or null to use regular image.
bool	getPressed ()
Button	new ()
	Create button.
Button	new (String text, ActionListener action)
	Create text button.
Button	new (String text, Image image)
	Create text and image button.
Button	new (String text, Image image, ActionListener action)
	Create text and image button.
void	onButtonPress (MouseEvent event)
void	onButtonRelease (MouseEvent event)
void	onFocusLost (FocusEvent event)
	Widget lost focus.
void	onFocusReceived (FocusEvent event)
	Widget received focus.
void	onGuiThemeChanged ()
	Gui theme changed.
void	onKeyPress (KeyEvent event)
void	onKeyRelease (KeyEvent event)
void	onMouseEnter (MouseEvent event)
void	onMouseMove (MouseEvent event)
void	removeActionListener (ActionListener listener)
void	setHoverImage (Image image)
	Set hover image or null to use regular image.
void	setPressed (bool pressed)
void	updateWidgetImage ()
	Update image to display depending on current button state.
Public Member Functions inherited from Dragengine.Gui.Container
void	addWidget (Widget widget)
void	addWidget (Widget widget, Object settings)
bool	allowsChildGrabFocus ()
void	collectClosestFocusWidget (ClosestDirectionFocusFinder finder, Point origin)
	Find closest focus widget for directional navigation.
void	doLayout ()
Widget	findFocusableWidget ()
Widget	findLastFocusableWidget ()
Widget	findWidget (Block ablock)
	Find widget using block or null if not found.
int	getContainerHeight ()
Point	getContainerSize ()
int	getContainerWidth ()
bool	getHasBlockedDoLayout ()
	doLayout calls happened during runWhileBlockingLayout.
Layout	getLayout ()
Point	getMinimumSize ()
Point	getMinimumSizeForHeight (int height)
	Minimum size of widget using reference widget height and variable width.
Point	getMinimumSizeForWidth (int width)
	Minimum size of widget using reference widget width and variable height.
bool	getStateChangeNotifyChildren ()
	Notify children if state changed.
Widget	getWidget (int index)
Widget	getWidgetAt (Point position)
	Widget at coordinates or null if not found.
int	getWidgetCount ()
void	giveUpFocus ()
bool	hasFocusWidget ()
	Focus widget is inside container somewhere.
bool	hasWidget (Widget widget)
int	indexOfWidget (Widget widget)
Object	injectWidget (Object injectValue, Block ablock)
	Process value visiting widgets using block.
bool	isChildVisible (Widget child)
	Child widget is visible.
bool	isChildVisibleOnDesktop (Widget child)
	Child widget is visible on desktop.
bool	isMouseInside ()
	Mouse is hovering over this widget.
void	layoutParent ()
void	moveWidget (Widget widget, int newPosition)
Container	new (int x, int y, int width, int height)
Container	new (Layout layout)
	Create container with layout.
Container	new (Layout layout, Block blockAddContent)
	Create container with layout calling block to add content.
Container	new (Point position, Point size)
Widget	nextFocusWidgetAfter (Widget widget)
	Find next widget in the focus cycle that can grab the focus.
void	onPaddingChanged ()
	Padding changed.
Widget	prevFocusWidgetAfter (Widget widget)
	Find previous widget in the focus cycle that can grab the focus.
void	removeAllWidgets ()
	Remove and dispose all widgets.
void	removeWidget (Widget widget)
	Remove widget without disposing.
bool	requestCaptureDirectional (Widget widget)
	Request to capture directional navigation for the specified widget.
bool	requestCaptureMouse (Widget widget)
bool	requestReleaseDirectional (Widget widget)
	Request to release directional navigation capture.
bool	requestReleaseMouse (Widget widget)
void	runWhileBlockingLayout (Block ablock)
	Run block while layouting is blocked.
void	setEnabled (bool enabled)
void	setHasBlockedDoLayout (bool hasBlockedDoLayout)
	Set if doLayout calls happened during runWhileBlockingLayout.
void	setLayout (Layout layout)
void	setMousePointer (MousePointerFactory mousePointer)
	Set mouse pointer to use.
void	setStateChangeNotifyChildren (bool notify)
	Set to notify children if state changed.
Public Member Functions inherited from Dragengine.Gui.Widget
void	addDragListener (DragListener listener)
void	addFocusListener (FocusListener listener)
	Add focus listener.
void	addGamepadListener (GamepadListener listener)
	Add gamepad listener.
void	addKeyListener (KeyListener listener)
void	addMouseListener (MouseListener listener)
void	addStateChangeListener (StateChangeListener listener)
	Add state change listener.
void	addWidgetListener (WidgetListener listener)
	Add widget listener.
bool	canGrabFullFocus ()
void	captureDirectional ()
	Captures directional navigation if not already captured by another widget.
void	design ()
	Design widget using WidgetDesigner.
void	desktopWarpMouseFocusHere ()
	Warp mouse to focus location on this widget.
void	desktopWarpMouseFocusLocation ()
	Warp mouse to focus location on desktop focus widget.
void	ensureVisible ()
	Ensure widget is fully visible on desktop if possible.
void	ensureVisible (RectArea boundary)
	Ensure boundary is visible on desktop if possible.
void	focusDirectional (int direction)
	Focus widget in direction that can grab the focus.
CanvasCreator	getBackgroundCanvasCreator ()
	Background canvas creator or null to use background color.
bool	getBlockLayoutParent ()
	Block layoutParent calls.
Border	getBorder ()
BorderSize	getBorderSize ()
RectArea	getBoundary ()
	Rectangular boundary of the widget.
RectArea	getBoundaryWithBorder ()
	Rectangular boundary of the widget including border.
bool	getCanFocus ()
bool	getCanFocusDirectional ()
	Widget can get focus using directional navigation.
CanvasView	getCanvasBackground ()
CanvasView	getCanvasContent ()
CanvasView	getCanvasWidget ()
Clipboard	getClipboard ()
	Clipboard or null to use parent clipboard.
ColorMatrix	getColorTransformation ()
	Color transformation.
WidgetDesigner	getDesigner ()
	Designer.
String	getDesignerSelector ()
	Designer selector.
Desktop	getDesktop ()
RectArea	getDesktopBoundary ()
	Rectangular boundary of widget relative to desktop.
RectArea	getDesktopBoundaryWithBorder ()
	Rectangular boundary of widget including border relative to parent.
Point	getDesktopPosition ()
	Widget position in desktop coordinates.
Widget	getDirectionalCaptureWidget ()
	Widget having captured directional navigation.
bool	getEnabled ()
MousePointerFactory	getFirstMousePointer ()
	First assigned mouse pointer.
Point	getFocusMouseLocation ()
	Focus mouse location in widget coordinates.
Font	getFont ()
bool	getHasBlockedLayoutParent ()
	layoutParent calls happened during runWhileBlockingLayoutParent.
bool	getHasFocus ()
int	getHeight ()
	Height of widget.
RangeModel	getHorizontalRangeModel ()
	Horizontal range model for viewports to synchronize the horizontal scrollbar.
Widget	getHoverWidget ()
	Widget the mouse hovers above or null.
Point	getLocalMouseLocation ()
	Parent desktop mouse location in widget coordinates.
Point	getMinimumSizeWithBorder ()
Point	getMinimumSizeWithBorderForHeight (int height)
	Minimum size of widget with border using reference height.
Point	getMinimumSizeWithBorderForWidth (int width)
	Minimum size of widget with border for reference width.
Widget	getMouseCaptureWidget ()
	Widget having captured the mouse.
MousePointerFactory	getMousePointer ()
	Mouse pointer to use.
BorderSize	getPadding ()
	Padding.
Container	getParent ()
Point	getPosition ()
	Position of the widget.
bool	getProtectBackgroundCanvasCreator ()
	Protect custom set background canvas creator.
bool	getProtectBorder ()
	Protect custom set border.
bool	getProtectFont ()
	Protect custom set font.
bool	getProtectMinimumSize ()
	Protect custom set minimumsize.
bool	getProtectMousePointer ()
	Protect custom set mouse pointer.
bool	getProtectPadding ()
	Protect custom set padding.
bool	getProtectTextColor ()
	Protect custom set text color.
RectArea	getRelativeBoundary (Container parent)
	Rectangular boundary of widget relative to parent.
RectArea	getRelativeBoundaryWithBorder (Container parent)
	Rectangular boundary of widget including border relative to parent.
Point	getRelativePosition (Container parent)
	Widget position in parent widget coordinates.
Point	getScreenPosition ()
	Widget position in screen coordinates.
RectArea	getScreenRectArea ()
Point	getSetMinimumSize ()
Point	getSize ()
	Size of the widget.
Color	getTextColor ()
	Text color.
String	getTitle ()
	Widget title.
Object	getToolTip ()
	Tooltip or null.
float	getTotalTransparency ()
TexMatrix2	getTransformation ()
float	getTransparency ()
RangeModel	getVerticalRangeModel ()
	Vertical range model for viewports to synchronize the vertical scrollbar.
bool	getVisible ()
RectArea	getVisibleDesktopBoundary ()
	Visible widget boundary in desktop coordinates.
RectArea	getVisibleRelativeBoundary (Container parent)
	Visible widget boundary relative to parent coordinate system.
int	getWidth ()
	Width of widget.
Window	getWindow ()
Point	getWindowPosition ()
	Widget position in window coordinates.
int	getX ()
	X position of widget.
int	getY ()
	Y position of widget.
void	grabFocus ()
bool	hasParent (Container container)
bool	isCapturingDirectional ()
	Widget is capturing directional navigation.
bool	isCapturingMouse ()
	Widget is capturing mouse.
bool	isDesignerSet ()
	Custom designer is set.
bool	isFullEnabled ()
	Widget and all parent widgets are enabled.
bool	isMinimumSizeSet ()
bool	isPointInside (Point position)
bool	isTransformationSet ()
void	layoutParentIfBlocked ()
	Calls layoutParent if getHasBlockedLayoutParent() is true.
Widget	nextFocusWidget ()
	Find next widget in the focus cycle that can grab the focus.
void	notifyBorderParametersChanged ()
void	onDesignerChanged ()
	Designer changed.
void	onDesignerSelectorChanged ()
	Designer selector changed.
void	onDispose (WidgetEvent event)
	Window is disposing.
void	onFrameUpdate (float elapsed)
	Do frame update.
void	onGamepadButtonPressed (GamepadEvent event)
	Gamepad button has been pressed.
void	onGamepadButtonReleased (GamepadEvent event)
	Gamepad button has been released.
void	onHidden (WidgetEvent event)
	Widget has been hidden.
void	onParentStateChanged ()
	Parent state changed.
void	onParentStateChanged (bool force)
	Parent state changed.
void	onReposition (WidgetEvent event)
	Position changed.
void	onResize (WidgetEvent event)
	Size changed.
void	onSetFont ()
void	onSetTextColor ()
	Text color changed.
void	onShown (WidgetEvent event)
	Widget has been shown.
void	onTranslationChanged ()
	Translation manager or active language pack changed.
void	popdownVirtualKeyboard ()
	Popdown virtual keyboard if Desktop has one assigned.
void	popdownVirtualKeyboardDirectional ()
	Popdown virtual keyboard if Desktop has one assigned and direction focus widget.
void	popupVirtualKeyboard ()
	Popup virtual keyboard if Desktop has one assigned.
Widget	prevFocusWidget ()
	Find previous widget in the focus cycle that can grab the focus.
void	processEvent (Event event)
	Process an event.
void	releaseDirectional ()
	Release directional navigation capture.
void	releaseMouse ()
void	removeDragListener (DragListener listener)
void	removeFocusListener (FocusListener listener)
	Remove focus listener.
void	removeGamepadListener (GamepadListener listener)
	Remove gamepad listener.
void	removeKeyListener (KeyListener listener)
void	removeMouseListener (MouseListener listener)
void	removeStateChangeListener (StateChangeListener listener)
	Remove state change listener.
void	removeWidgetListener (WidgetListener listener)
	Remove widget listener.
void	requestGrabFocus (Widget widget)
void	runWhileBlockingLayoutParent (Block ablock)
	Run block while layouting is blocked.
void	safeDispose ()
	Safely dispose of widget.
void	sendEvent (Event event)
void	sendEventToListeners (Event event, bool sendToParent)
	Send event to all appropriate listeners for events of its kind.
void	setBackgroundCanvasCreator (CanvasCreator creator)
	Set background canvas creator or null to use background color.
void	setBlockLayoutParent (bool blockLayoutParent)
	Set block layoutParent calls.
void	setBorder (Border border)
void	setCanFocus (bool canFocus)
void	setCanFocusDirectional (bool canFocus)
	Set if widget can get focus using directional navigation.
void	setClipboard (Clipboard clipboard)
	Set clipboard or null to use parent clipboard.
void	setColorTransformation (ColorMatrix transformation)
	Set color transformation.
void	setDesigner (WidgetDesigner designer)
	Set designer.
void	setDesignerSelector (String selector)
	Set designer selector.
void	setHasBlockedLayoutParent (bool hasBlockedLayoutParent)
	Set if layoutParent calls happened during runWhileBlockingLayoutParent.
void	setHasFocus (bool hasFocus)
void	setHeight (int height)
	Set height of widget.
void	setMinimumSize (Point size)
void	setPadding (BorderSize padding)
	Set padding.
void	setParent (Container parent)
void	setPosition (Point position)
	Set position of widget.
void	setProtectBackgroundCanvasCreator (bool protect)
	Set protect custom set background canvas creator.
void	setProtectBorder (bool protect)
	Set protect custom set border.
void	setProtectFont (bool protect)
	Set protect custom set font.
void	setProtectMinimumSize (bool protect)
	Set protect custom set minimumsize.
void	setProtectMousePointer (bool protect)
	Set protect custom set mouse pointer.
void	setProtectPadding (bool protect)
	Set protect custom set padding.
void	setProtectTextColor (bool protect)
	Set protect custom set text color.
void	setSize (Point size)
	Set size of widget.
void	setTitle (String title)
	Set widget title.
void	setToolTip (Object toolTip)
	Set tooltip or null.
void	setTransformation (TexMatrix2 transformation)
void	setTransparency (float transparency)
void	setVisible (bool visible)
void	setWidth (int width)
	Set width of widget.
void	setX (int x)
	Set X position of widget.
void	setY (int y)
	Set Y Position of widget.
void	simulateKeyPress (int keyCode, int keyChar)
	Simulate keyboard press event.
void	simulateKeyPressRelease (int keyCode, int keyChar)
	Simulate keyboard press and release event.
void	simulateKeyRelease (int keyCode, int keyChar)
	Simulate keyboard release event.
void	startFrameUpdater ()
	Start frame updater if not running.
void	stopFrameUpdater ()
	Stop frame updater if running.

Public Attributes
DisplayImage	pBackground
DisplayImage	pImage
Image	pImageBgPressed
Image	pImageBgUnpressed
Label	pLabel
Panel	pPanelText
Public Attributes inherited from Dragengine.Gui.Button
Array	pActionListeners
bool	pHasGrab
Image	pHoverImage
Image	pImage
bool	pPressed
String	pText
DisplayImage	pWidgetImage
Label	pWidgetText
Public Attributes inherited from Dragengine.Gui.Container
bool	pBlockLayout
Point	pCachedMinSize
int	pCachedMinSizeForHeightHeight
Point	pCachedMinSizeForHeightSize
Point	pCachedMinSizeForWidthSize
int	pCachedMinSizeForWidthWidth
Array	pChildren
bool	pHasBlockedDoLayout
Layout	pLayout
bool	pStateChangeNotifyChildren
Public Attributes inherited from Dragengine.Gui.Widget
CanvasCreator	pBackgroundCanvasCreator
bool	pBlockLayoutParent
Border	pBorder
CanvasView	pCanvasWidget
Clipboard	pClipboard
WidgetDesigner	pDesigner
String	pDesignerSelector
Font	pFont
FrameUpdater	pFrameUpdater
bool	pIsDesignerSet
Array	pKeyListeners
MousePointerFactory	pMousePointer
BorderSize	pPadding
Container	pParent
Point	pPosition
bool	pProtectBackgroundCanvasCreator
RepeatKeyEventTimer	pRepeatEventTimer
Color	pTextColor
GuiTheme	pTheme
String	pThemeSelector
String	pTitle
Object	pToolTip
TexMatrix2	pTransformation
TranslationManager	pTranslationManager
float	pTransparency
bool	pVisible

Additional Inherited Members
Protected Member Functions inherited from Dragengine.Gui.Button
DisplayImage	getWidgetImage ()
	Image or null if not used.
void	setWidgetImage (DisplayImage widget)
	Set image or null if not used.
void	setWidgetText (Label widget)
	Set label or null if not used.
Protected Member Functions inherited from Dragengine.Gui.Widget
WidgetDesigner	getDesignerFromTheme ()
	Get designer from gui theme.
void	updateCanvasBackground ()
	Update background canvas content.
void	updateCanvasGeometry ()
	Update canvas position and size.

Detailed Description

Button with state dependent background image and optional text and image.

Member Function Documentation

dispose()

void Dragengine.Gui.BgButton.dispose

(

)

Dispose of widget.

Reimplemented from Dragengine.Gui.Button.

getImage()

Image Dragengine.Gui.BgButton.getImage

(

)

Image of the button.

Reimplemented from Dragengine.Gui.Button.

getImageBgPressed()

Image Dragengine.Gui.BgButton.getImageBgPressed

(

)

Pressed background image.

getImageBgUnpressed()

Image Dragengine.Gui.BgButton.getImageBgUnpressed

(

)

Unpressed background image.

getText()

String Dragengine.Gui.BgButton.getText

(

)

Text of the button.

Reimplemented from Dragengine.Gui.Button.

getTextPadding()

BorderSize Dragengine.Gui.BgButton.getTextPadding

(

)

Text padding.

lockSize()

void Dragengine.Gui.BgButton.lockSize

(

)

Lock size to unpressed or presed image size, whichever exists.

new() [1/2]

BgButton Dragengine.Gui.BgButton.new	(	Image	bgUnpressed,
		Image	bgPressed
	)

Create button.

new() [2/2]

BgButton Dragengine.Gui.BgButton.new	(	Image	bgUnpressed,
		Image	bgPressed,
		String	text,
		Image	image
	)

Create button.

onStateChanged()

void Dragengine.Gui.BgButton.onStateChanged

(

StateChangeEvent

event

)

State changed.

Reimplemented from Dragengine.Gui.Container.

setFont()

void Dragengine.Gui.BgButton.setFont

(

Font

font

)

Set font of the button text.

Reimplemented from Dragengine.Gui.Widget.

setImage()

void Dragengine.Gui.BgButton.setImage

(

Image

image

)

Set image of the button.

Reimplemented from Dragengine.Gui.Button.

setImageBgPressed()

void Dragengine.Gui.BgButton.setImageBgPressed

(

Image

image

)

Set pressed background image.

setImageBgUnpressed()

void Dragengine.Gui.BgButton.setImageBgUnpressed

(

Image

image

)

Set unpressed background image.

setText()

void Dragengine.Gui.BgButton.setText

(

String

text

)

Set text of the button.

Reimplemented from Dragengine.Gui.Button.

setTextColor()

void Dragengine.Gui.BgButton.setTextColor

(

Color

color

)

Set foreground color of button text.

Reimplemented from Dragengine.Gui.Widget.

setTextPadding() [1/2]

void Dragengine.Gui.BgButton.setTextPadding

(

BorderSize

padding

)

Set text padding.

setTextPadding() [2/2]

void Dragengine.Gui.BgButton.setTextPadding

(

int

padding

)

Set text padding.

unlockSize()

void Dragengine.Gui.BgButton.unlockSize

(

)

Unlock size.

updateBackgroundImage()

void Dragengine.Gui.BgButton.updateBackgroundImage

(

)

Update background image.

Member Data Documentation

pBackground

DisplayImage Dragengine.Gui.BgButton.pBackground

pImage

DisplayImage Dragengine.Gui.BgButton.pImage

pImageBgPressed

Image Dragengine.Gui.BgButton.pImageBgPressed

pImageBgUnpressed

Image Dragengine.Gui.BgButton.pImageBgUnpressed

pLabel

Label Dragengine.Gui.BgButton.pLabel

pPanelText

Panel Dragengine.Gui.BgButton.pPanelText

---

The documentation for this class was generated from the following file:

• BgImageButton.ds