Render a short aligned text. More...

Inheritance diagram for Dragengine.Gui.Label:

Public Member Functions
void	dispose ()
	Dispose of widget. More...

int	getAlignment ()
	Text alignment. More...

int	getMaximalWidth ()
	Maximal width of text before break occurs. More...

Point	getMinimumSize ()
	Minimal size of widget. More...

Point	getMinimumSizeForWidth (int width)
	Minimum size of widget using reference widget width and variable height. More...

TextModel	getModel ()
	Text model. More...

String	getText ()
	Text. More...

Point	getTextSize ()
	Size of text. More...

bool	getWordWrap ()
	Word wrap if line is too long. More...

Label	new (String text)
	Create label. More...

Label	new (String text, int alignment)

Label	new (String text, String designerSelector)

Label	new (TextModel model)

Label	new (TextModel model, int alignment)

Label	new (TextModel model, String designerSelector)

void	onGuiThemeChanged ()
	Gui theme changed. More...

void	onResize (WidgetEvent event)
	Size changed. More...

void	onSetFont ()
	Font changed. More...

void	onSetTextColor ()
	Foreground color changed. More...

void	onStateChanged (StateChangeEvent event)
	State changed. More...

void	onTranslationChanged ()
	Translation manager or active language pack changed. More...

void	setAlignment (int alignment)
	Set text alignment. More...

void	setMaximalWidth (int width)
	Set maximal width of text before break occurs. More...

void	setModel (TextModel model)
	Set text model. More...

void	setText (String text)
	Set text. More...

void	setWordWrap (bool wordWrap)
	Set word wrap if line is too long. More...

void	textChanged (TextModel textModel)
	Text changed. More...

Public Member Functions inherited from Dragengine.Gui.Widget
void	addDragListener (DragListener listener)

void	addFocusListener (FocusListener listener)
	Add focus listener. More...

void	addGamepadListener (GamepadListener listener)
	Add gamepad listener. More...

void	addKeyListener (KeyListener listener)

void	addMouseListener (MouseListener listener)

void	addStateChangeListener (StateChangeListener listener)
	Add state change listener. More...

void	addWidgetListener (WidgetListener listener)
	Add widget listener. More...

bool	canGrabFullFocus ()

void	captureMouse ()

void	design ()
	Design widget using WidgetDesigner. More...

Widget	findFocusableWidget ()

Widget	findLastFocusableWidget ()

CanvasCreator	getBackgroundCanvasCreator ()
	Background canvas creator or null to use background color. More...

Border	getBorder ()

BorderSize	getBorderSize ()

RectArea	getBoundary ()
	Rectangulare boundary of the widget. More...

RectArea	getBoundaryWithBorder ()
	Rectangulare boundary of the widget including border. More...

bool	getCanFocus ()

CanvasView	getCanvasBackground ()

CanvasView	getCanvasContent ()

CanvasView	getCanvasWidget ()

Clipboard	getClipboard ()
	Clipboard or null to use parent clipboard. More...

ColorMatrix	getColorTransformation ()
	Color transformation. More...

WidgetDesigner	getDesigner ()
	Designer. More...

String	getDesignerSelector ()
	Designer selector. More...

Desktop	getDesktop ()

Point	getDesktopPosition ()
	Widget position in desktop coordinates. More...

bool	getEnabled ()

MousePointerFactory	getFirstMousePointer ()
	First assigned mouse pointer. More...

Font	getFont ()

bool	getHasFocus ()

int	getHeight ()
	Height of widget. More...

RangeModel	getHorizontalRangeModel ()
	Horizontal range model for viewports to synchronize the horizontal scrollbar. More...

Widget	getHoverWidget ()
	Widget the mouse hovers above or null. More...

Point	getMinimumSizeForHeight (int height)
	Minimum size of widget using reference widget height and variable width. More...

Point	getMinimumSizeWithBorder ()

Point	getMinimumSizeWithBorderForHeight (int height)
	Minimum size of widget with border using reference height. More...

Point	getMinimumSizeWithBorderForWidth (int width)
	Minimum size of widget with border for reference width. More...

MousePointerFactory	getMousePointer ()
	Mouse pointer to use. More...

BorderSize	getPadding ()
	Padding. More...

Container	getParent ()

Point	getPosition ()
	Position of the widget. More...

bool	getProtectBackgroundCanvasCreator ()
	Protect custom set background canvas creator. More...

bool	getProtectBorder ()
	Protect custom set border. More...

bool	getProtectFont ()
	Protect custom set font. More...

bool	getProtectMinimumSize ()
	Protect custom set minimumsize. More...

bool	getProtectMousePointer ()
	Protect custom set mouse pointer. More...

bool	getProtectPadding ()
	Protect custom set padding. More...

bool	getProtectTextColor ()
	Protect custom set text color. More...

Point	getRelativePosition (Container parent)
	Widget position in parent widget coordinates. More...

Point	getScreenPosition ()
	Widget position in screen coordinates. More...

RectArea	getScreenRectArea ()

Point	getSetMinimumSize ()

Point	getSize ()
	Size of the widget. More...

Color	getTextColor ()
	Text color. More...

String	getTitle ()
	Widget title. More...

Object	getToolTip ()
	Tooltip or null. More...

float	getTotalTransparency ()

TexMatrix2	getTransformation ()

float	getTransparency ()

RangeModel	getVerticalRangeModel ()
	Vertical range model for viewports to synchronize the vertical scrollbar. More...

bool	getVisible ()

Widget	getWidgetAt (Point position)
	Widget at coordinates or null if not found. More...

int	getWidth ()
	Width of widget. More...

Window	getWindow ()

Point	getWindowPosition ()
	Widget position in window coordinates. More...

int	getX ()
	X position of widget. More...

int	getY ()
	Y position of widget. More...

void	grabFocus ()

bool	hasParent (Container container)

bool	isDesignerSet ()
	Custom designer is set. More...

bool	isFullEnabled ()
	Widget and all parent widgets are enabled. More...

bool	isMinimumSizeSet ()

bool	isMouseInside ()
	Mouse is hovering over this widget. More...

bool	isPointInside (Point position)

bool	isTransformationSet ()

void	layoutParent ()

Widget	new ()
	Create widget. More...

Widget	new (int x, int y, int width, int height)
	Create widget with initial location and size. More...

Widget	new (Point position, Point size)
	Create widget with initial location and size. More...

Widget	nextFocusWidget ()
	Find next widget in the focus cycle that can grab the focus. More...

void	notifyBorderParametersChanged ()

void	onDesignerChanged ()
	Designer changed. More...

void	onDesignerSelectorChanged ()
	Designer selector changed. More...

void	onDispose (WidgetEvent event)
	Window is disposing. More...

void	onFocusLost (FocusEvent event)
	Widget lost focus. More...

void	onFocusReceived (FocusEvent event)
	Widget received focus. More...

void	onFrameUpdate (float elapsed)
	Do frame update. More...

void	onGamepadButtonPressed (GamepadEvent event)
	Gamepad button has been pressed. More...

void	onGamepadButtonReleased (GamepadEvent event)
	Gamepad button has been released. More...

void	onHidden (WidgetEvent event)
	Widget has been hidden. More...

void	onPaddingChanged ()
	Padding changed. More...

void	onParentStateChanged ()
	Parent state changed. More...

void	onParentStateChanged (bool force)
	Parent state changed. More...

void	onReposition (WidgetEvent event)
	Position changed. More...

void	onShown (WidgetEvent event)
	Widget has been shown. More...

void	popdownVirtualKeyboard ()
	Popdown virtual keyboard if Desktop has one assigned. More...

void	popupVirtualKeyboard ()
	Popup virtual keyboard if Desktop has one assigned. More...

Widget	prevFocusWidget ()
	Find previous widget in the focus cycle that can grab the focus. More...

void	processEvent (Event event)

void	releaseMouse ()

void	removeDragListener (DragListener listener)

void	removeFocusListener (FocusListener listener)
	Remove focus listener. More...

void	removeGamepadListener (GamepadListener listener)
	Remove gamepad listener. More...

void	removeKeyListener (KeyListener listener)

void	removeMouseListener (MouseListener listener)

void	removeStateChangeListener (StateChangeListener listener)
	Remove state change listener. More...

void	removeWidgetListener (WidgetListener listener)
	Remove widget listener. More...

void	requestGrabFocus (Widget widget)

void	safeDispose ()
	Safely dispose of widget. More...

void	sendEvent (Event event)

void	sendEventToListeners (Event event, bool sendToParent)
	Send event to all appropriate listeners for events of its kind. More...

void	setBackgroundCanvasCreator (CanvasCreator creator)
	Set background canvas creator or null to use background color. More...

void	setBorder (Border border)

void	setCanFocus (bool canFocus)

void	setClipboard (Clipboard clipboard)
	Set clipboard or null to use parent clipboard. More...

void	setColorTransformation (ColorMatrix transformation)
	Set color transformation. More...

void	setDesigner (WidgetDesigner designer)
	Set designer. More...

void	setDesignerSelector (String selector)
	Set designer selector. More...

void	setEnabled (bool enabled)

void	setFont (Font font)

void	setHasFocus (bool hasFocus)

void	setHeight (int height)
	Set height of widget. More...

void	setMinimumSize (Point size)

void	setMousePointer (MousePointerFactory mousePointer)
	Set mouse pointer to use. More...

void	setPadding (BorderSize padding)
	Set padding. More...

void	setParent (Container parent)

void	setPosition (Point position)
	Set position of widget. More...

void	setProtectBackgroundCanvasCreator (bool protect)
	Set protect custom set background canvas creator. More...

void	setProtectBorder (bool protect)
	Set protect custom set border. More...

void	setProtectFont (bool protect)
	Set protect custom set font. More...

void	setProtectMinimumSize (bool protect)
	Set protect custom set minimumsize. More...

void	setProtectMousePointer (bool protect)
	Set protect custom set mouse pointer. More...

void	setProtectPadding (bool protect)
	Set protect custom set padding. More...

void	setProtectTextColor (bool protect)
	Set protect custom set text color. More...

void	setSize (Point size)
	Set size of widget. More...

void	setTextColor (Color color)
	Set text color. More...

void	setTitle (String title)
	Set widget title. More...

void	setToolTip (Object toolTip)
	Set tooltip or null. More...

void	setTransformation (TexMatrix2 transformation)

void	setTransparency (float transparency)

void	setVisible (bool visible)

void	setWidth (int width)
	Set width of widget. More...

void	setX (int x)
	Set X position of widget. More...

void	setY (int y)
	Set Y Position of widget. More...

void	startFrameUpdater ()
	Start frame updater if not running. More...

void	stopFrameUpdater ()
	Stop frame updater if running. More...

void	stopRepeatEventTimer ()

Public Attributes
int	pAlignment

int	pMaxWidth

Point	pMinSizeForWidthSize

int	pMinSizeForWidthWidth

Point	pMinTextSize

TextModel	pModel

TextLayout	pTextLayout

bool	pWordWrap

Public Attributes inherited from Dragengine.Gui.Widget
CanvasCreator	pBackgroundCanvasCreator

Border	pBorder

bool	pCanFocus

CanvasView	pCanvasBackground

CanvasView	pCanvasContent

CanvasView	pCanvasWidget

Clipboard	pClipboard

WidgetDesigner	pDesigner

String	pDesignerSelector

Array	pDragListeners

bool	pEnabled

Array	pFocusListeners

Font	pFont

FrameUpdater	pFrameUpdater

Array	pGamepadListeners

bool	pHasFocus

bool	pIsDesignerSet

Array	pKeyListeners

Point	pMinSize

Array	pMouseListeners

MousePointerFactory	pMousePointer

BorderSize	pPadding

Container	pParent

Point	pPosition

bool	pProtectBackgroundCanvasCreator

bool	pProtectBorder

bool	pProtectFont

bool	pProtectMinimumSize

bool	pProtectMousePointer

bool	pProtectPadding

bool	pProtectTextColor

RepeatKeyEventTimer	pRepeatEventTimer

Point	pSize

Array	pStateChangeListeners

Color	pTextColor

GuiTheme	pTheme

String	pThemeSelector

String	pTitle

Object	pToolTip

TexMatrix2	pTransformation

TranslationManager	pTranslationManager

float	pTransparency

bool	pVisible

Array	pWidgetListeners

Static Public Attributes
static final int	bottom = 4
	Align text at bottom side. More...

static final int	bottomCenter = bottom \| center
	Align text middle-center. More...

static final int	bottomLeft = bottom \| left
	Align text bottom-left. More...

static final int	bottomRight = bottom \| right
	Align text bottom-right. More...

static final int	center = 2
	Align text center. More...

static final int	defaultAlignment = middleCenter
	Default alignment middle-center. More...

static final int	left = 0
	Align text left side. More...

static final int	middle = 8
	Align text middled. More...

static final int	middleCenter = middle \| center
	Align text middle-center. More...

static final int	middleLeft = middle \| left
	Align text middle-left. More...

static final int	middleRight = middle \| right
	Align text middle-right. More...

static final int	right = 1
	Align text right side. More...

static final int	top = 0
	Align text at top side. More...

static final int	topCenter = top \| center
	Align text middle-center. More...

static final int	topLeft = top \| left
	Align text top-left. More...

static final int	topRight = top \| right
	Align text top-right. More...

Additional Inherited Members
Protected Member Functions inherited from Dragengine.Gui.Widget
WidgetDesigner	getDesignerFromTheme ()
	Get designer from gui theme. More...

void	updateCanvasBackground ()
	Update background canvas content. More...

void	updateCanvasGeometry ()
	Update canvas position and size. More...

Detailed Description

Render a short aligned text.

Member Function Documentation

◆ dispose()

void Dragengine.Gui.Label.dispose ( )

Dispose of widget.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.DisplayFPSRate.

◆ getAlignment()

int Dragengine.Gui.Label.getAlignment ( )

Text alignment.

◆ getMaximalWidth()

int Dragengine.Gui.Label.getMaximalWidth ( )

Maximal width of text before break occurs.

◆ getMinimumSize()

Point Dragengine.Gui.Label.getMinimumSize ( )

Minimal size of widget.

Reimplemented from Dragengine.Gui.Widget.

◆ getMinimumSizeForWidth()

Point Dragengine.Gui.Label.getMinimumSizeForWidth ( int width )

Minimum size of widget using reference widget width and variable height.

Default implementation uses getMinimumSize().

Reimplemented from Dragengine.Gui.Widget.

◆ getModel()

TextModel Dragengine.Gui.Label.getModel ( )

Text model.

◆ getText()

String Dragengine.Gui.Label.getText ( )

Text.

◆ getTextSize()

Point Dragengine.Gui.Label.getTextSize ( )

Size of text.

◆ getWordWrap()

bool Dragengine.Gui.Label.getWordWrap ( )

Word wrap if line is too long.

◆ new() [1/6]

Label Dragengine.Gui.Label.new ( String text )

Create label.

◆ new() [2/6]

Label Dragengine.Gui.Label.new	(	String	text,
		int	alignment
	)

◆ new() [3/6]

Label Dragengine.Gui.Label.new	(	String	text,
		String	designerSelector
	)

◆ new() [4/6]

Label Dragengine.Gui.Label.new ( TextModel model )

◆ new() [5/6]

Label Dragengine.Gui.Label.new	(	TextModel	model,
		int	alignment
	)

◆ new() [6/6]

Label Dragengine.Gui.Label.new	(	TextModel	model,
		String	designerSelector
	)

◆ onGuiThemeChanged()

void Dragengine.Gui.Label.onGuiThemeChanged ( )

Gui theme changed.

Reimplemented from Dragengine.Gui.Widget.

◆ onResize()

void Dragengine.Gui.Label.onResize ( WidgetEvent event )

Size changed.

Reimplemented from Dragengine.Gui.Widget.

◆ onSetFont()

void Dragengine.Gui.Label.onSetFont ( )

Font changed.

Reimplemented from Dragengine.Gui.Widget.

◆ onSetTextColor()

void Dragengine.Gui.Label.onSetTextColor ( )

Foreground color changed.

Reimplemented from Dragengine.Gui.Widget.

◆ onStateChanged()

void Dragengine.Gui.Label.onStateChanged ( StateChangeEvent event )

State changed.

Sends event to listeners.

Reimplemented from Dragengine.Gui.Widget.

◆ onTranslationChanged()

void Dragengine.Gui.Label.onTranslationChanged ( )

Translation manager or active language pack changed.

Version: 1.20

Reimplemented from Dragengine.Gui.Widget.

◆ setAlignment()

void Dragengine.Gui.Label.setAlignment ( int alignment )

Set text alignment.

Parameters

alignment One of left, right, center combined with one of top, bottom, middle.

◆ setMaximalWidth()

void Dragengine.Gui.Label.setMaximalWidth ( int width )

Set maximal width of text before break occurs.

◆ setModel()

void Dragengine.Gui.Label.setModel ( TextModel model )

Set text model.

◆ setText()

void Dragengine.Gui.Label.setText ( String text )

Set text.

◆ setWordWrap()

void Dragengine.Gui.Label.setWordWrap ( bool wordWrap )

Set word wrap if line is too long.

◆ textChanged()

void Dragengine.Gui.Label.textChanged ( TextModel textModel )

Text changed.

Implements Dragengine.Gui.TextModelListener.

Member Data Documentation

◆ bottom

final int Dragengine.Gui.Label.bottom = 4

static

Align text at bottom side.

◆ bottomCenter

final int Dragengine.Gui.Label.bottomCenter = bottom | center

static

Align text middle-center.

◆ bottomLeft

final int Dragengine.Gui.Label.bottomLeft = bottom | left

static

Align text bottom-left.

◆ bottomRight

final int Dragengine.Gui.Label.bottomRight = bottom | right

static

Align text bottom-right.

◆ center

final int Dragengine.Gui.Label.center = 2

static

Align text center.

◆ defaultAlignment

final int Dragengine.Gui.Label.defaultAlignment = middleCenter

static

Default alignment middle-center.

◆ left

final int Dragengine.Gui.Label.left = 0

static

Align text left side.

◆ middle

final int Dragengine.Gui.Label.middle = 8

static

Align text middled.

◆ middleCenter

final int Dragengine.Gui.Label.middleCenter = middle | center

static

Align text middle-center.

◆ middleLeft

final int Dragengine.Gui.Label.middleLeft = middle | left

static

Align text middle-left.

◆ middleRight

final int Dragengine.Gui.Label.middleRight = middle | right

static

Align text middle-right.

◆ pAlignment

int Dragengine.Gui.Label.pAlignment

◆ pMaxWidth

int Dragengine.Gui.Label.pMaxWidth

◆ pMinSizeForWidthSize

Point Dragengine.Gui.Label.pMinSizeForWidthSize

◆ pMinSizeForWidthWidth

int Dragengine.Gui.Label.pMinSizeForWidthWidth

◆ pMinTextSize

Point Dragengine.Gui.Label.pMinTextSize

◆ pModel

TextModel Dragengine.Gui.Label.pModel

◆ pTextLayout

TextLayout Dragengine.Gui.Label.pTextLayout

◆ pWordWrap

bool Dragengine.Gui.Label.pWordWrap

◆ right

final int Dragengine.Gui.Label.right = 1

static

Align text right side.

◆ top

final int Dragengine.Gui.Label.top = 0

static

Align text at top side.

◆ topCenter

final int Dragengine.Gui.Label.topCenter = top | center

static

Align text middle-center.

◆ topLeft

final int Dragengine.Gui.Label.topLeft = top | left

static

Align text top-left.

◆ topRight

final int Dragengine.Gui.Label.topRight = top | right

static

Align text top-right.

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

Label.ds

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dispose()

◆ getAlignment()

◆ getMaximalWidth()

◆ getMinimumSize()

◆ getMinimumSizeForWidth()

◆ getModel()

◆ getText()

◆ getTextSize()

◆ getWordWrap()

◆ new() [1/6]

◆ new() [2/6]

◆ new() [3/6]

◆ new() [4/6]

◆ new() [5/6]

◆ new() [6/6]

◆ onGuiThemeChanged()

◆ onResize()

◆ onSetFont()

◆ onSetTextColor()

◆ onStateChanged()

◆ onTranslationChanged()

◆ setAlignment()

◆ setMaximalWidth()

◆ setModel()

◆ setText()

◆ setWordWrap()

◆ textChanged()

Member Data Documentation

◆ bottom

◆ bottomCenter

◆ bottomLeft

◆ bottomRight

◆ center

◆ defaultAlignment

◆ left

◆ middle

◆ middleCenter

◆ middleLeft

◆ middleRight

◆ pAlignment

◆ pMaxWidth

◆ pMinSizeForWidthSize

◆ pMinSizeForWidthWidth

◆ pMinTextSize

◆ pModel

◆ pTextLayout

◆ pWordWrap

◆ right

◆ top

◆ topCenter

◆ topLeft

◆ topRight