Sub title box text using border layout for name, text and portrait. More...

Inheritance diagram for Dragengine.Gui.SubTitleBoxTextBorder:

Classes
class	Factory
	Factory for loading actor actions. More...

class	HideTimer
	Hide timer. More...

enum	Placement
	Placement. More...

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

DisplayImage	getImagePortrait ()
	Portait image or null. More...

Label	getLabelName ()
	Name label or null. More...

Label	getLabelText ()
	Text label or null. More...

Placement	getPlacement ()
	Placement. More...

DisplayStyledText	getStyledName ()
	Name styled text or null. More...

DisplayStyledText	getStyledText ()
	Text styled text or null. More...

DisplayVideo	getVideoPortrait ()
	Video portrait or null. More...

void	hideSubtitleAfter (float seconds)
	Hide after timer elapses. More...

void	hideSubtitleNow ()
	Hide now. More...

void	hideTimerElapsed ()
	Hide subtitle due to hide timer elapsed. More...

SubTitleBoxTextBorder	new (String text, String name, StyledTextDefinition styledText, StyledTextDefinition styledName, Image portraitImage, Video portraitVideo, Placement placement)
	Create sub title box text. More...

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

String	persistencyFactoryName ()
	Name of PersistencyFactory required to load object from file. More...

Widget	subtitleWidget ()
	Subtitle widget. More...

void	writeObjectToFile (PersistencyEnvironment env, FileWriter writer)
	Write object to file writer. More...

Public Member Functions inherited from Dragengine.Gui.Panel
Panel	new ()
	Create panel. More...

Panel	new (int x, int y, int width, int height)
	Create panel. More...

Panel	new (Layout layout)
	Create panel with layout. More...

Panel	new (Layout layout, Block blockAddContent)
	Create panel with layout calling block to add content. More...

Public Member Functions inherited from Dragengine.Gui.Container
void	addWidget (Widget widget)

void	addWidget (Widget widget, Object settings)

bool	allowsChildGrabFocus ()

void	doLayout ()

Widget	findFocusableWidget ()

Widget	findLastFocusableWidget ()

Widget	findWidget (Block ablock)
	Find widget using block or null if not found. More...

int	getContainerHeight ()

Point	getContainerSize ()

int	getContainerWidth ()

bool	getHasBlockedDoLayout ()
	doLayout calls happened during runWhileBlockingLayout. More...

Layout	getLayout ()

Point	getMinimumSize ()

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

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

bool	getStateChangeNotifyChildren ()
	Notify children if state changed. More...

Widget	getWidget (int index)

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

int	getWidgetCount ()

void	giveUpFocus ()

bool	hasFocusWidget ()
	Focus widget is inside container somewhere. More...

bool	hasWidget (Widget widget)

int	indexOfWidget (Widget widget)

Object	injectWidget (Object injectValue, Block ablock)
	Process value visiting widgets using block. More...

bool	isChildVisible (Widget child)

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

void	layoutParent ()

void	moveWidget (Widget widget, int newPosition)

Container	new (Point position, Point size)

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

void	onGuiThemeChanged ()

void	onPaddingChanged ()
	Padding changed. More...

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

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

void	removeAllWidgets ()
	Remove and dispose all widgets. More...

void	removeWidget (Widget widget)
	Remove widget without disposing. More...

bool	requestCaptureMouse (Widget widget)

bool	requestReleaseMouse (Widget widget)

void	runWhileBlockingLayout (Block ablock)
	Run block while layouting is blocked. More...

void	setEnabled (bool enabled)

void	setHasBlockedDoLayout (bool hasBlockedDoLayout)
	Set if doLayout calls happened during runWhileBlockingLayout. More...

void	setLayout (Layout layout)

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

void	setStateChangeNotifyChildren (bool notify)
	Set to notify children if state 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...

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

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	isPointInside (Point position)

bool	isTransformationSet ()

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

void	notifyBorderParametersChanged ()

void	onDesignerChanged ()
	Designer 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	onParentStateChanged ()
	Parent state changed. More...

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

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

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

void	onSetFont ()

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

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

void	onTranslationChanged ()
	Translation manager or active language pack changed. 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	setFont (Font font)

void	setHasFocus (bool hasFocus)

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

void	setMinimumSize (Point size)

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

Static Public Member Functions
static SubTitleBoxTextBorder	readFromFile (Factory factory, PersistencyEnvironment env, FileReader reader)
	Read action from file. More...

Protected Attributes
HideTimer	pHideTimer

DisplayImage	pImagePortrait

Label	pLabelName

Label	pLabelText

Placement	pPlacement

DisplayStyledText	pStyledName

DisplayStyledText	pStyledText

DisplayVideo	pVideoPortrait

Additional Inherited Members
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

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

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

Sub title box text using border layout for name, text and portrait.

Displays a styled text and optionally name and portrait image or video. The box can be designed with selector "SubTitleBoxText".

The name label can be designed with selector "Label.SubTitleBoxText.Name". The text part can be designed with selector "Label.SubTitleBoxText.Text". If StyledTextDefinition is used the label designers are ignored.

The portrait image can be designed with selector "Image.SubTitleBoxText.Portrait". The portrait video can be designed with selector "Video.SubTitleBoxText.Portrait".

The most simple use of SubTitleBoxText is by using the designers mentioned above. This uses the same design for all text.

For situation specific design setDesignerSelector can be used to assign a different selector for different text.

For the most customization support use StyledTextDefinition which give full control over the text combined with setDesignerSelector for desigining the portrait and panel itself.

The placement of the name text can be left or above the text as well as above or below the portrait if present.

Member Function Documentation

◆ dispose()

void Dragengine.Gui.SubTitleBoxTextBorder.dispose ( )

Dispose of widget.

Reimplemented from Dragengine.Gui.Widget.

◆ getImagePortrait()

DisplayImage Dragengine.Gui.SubTitleBoxTextBorder.getImagePortrait ( )

Portait image or null.

◆ getLabelName()

Label Dragengine.Gui.SubTitleBoxTextBorder.getLabelName ( )

Name label or null.

◆ getLabelText()

Label Dragengine.Gui.SubTitleBoxTextBorder.getLabelText ( )

Text label or null.

◆ getPlacement()

Placement Dragengine.Gui.SubTitleBoxTextBorder.getPlacement ( )

Placement.

◆ getStyledName()

DisplayStyledText Dragengine.Gui.SubTitleBoxTextBorder.getStyledName ( )

Name styled text or null.

◆ getStyledText()

DisplayStyledText Dragengine.Gui.SubTitleBoxTextBorder.getStyledText ( )

Text styled text or null.

◆ getVideoPortrait()

DisplayVideo Dragengine.Gui.SubTitleBoxTextBorder.getVideoPortrait ( )

Video portrait or null.

◆ hideSubtitleAfter()

void Dragengine.Gui.SubTitleBoxTextBorder.hideSubtitleAfter ( float seconds )

Hide after timer elapses.

Implements Dragengine.Gui.SubTitleBoxText.

◆ hideSubtitleNow()

void Dragengine.Gui.SubTitleBoxTextBorder.hideSubtitleNow ( )

Hide now.

Implements Dragengine.Gui.SubTitleBoxText.

◆ hideTimerElapsed()

void Dragengine.Gui.SubTitleBoxTextBorder.hideTimerElapsed ( )

Hide subtitle due to hide timer elapsed.

Version: 1.16

Default implementation calls hideSubtitleNow()

◆ new()

SubTitleBoxTextBorder Dragengine.Gui.SubTitleBoxTextBorder.new	(	String	text,
		String	name,
		StyledTextDefinition	styledText,
		StyledTextDefinition	styledName,
		Image	portraitImage,
		Video	portraitVideo,
		Placement	placement
	)

Create sub title box text.

Text is mandatory. Name and portrait are optional and can be set to null. If portrait is used either portraitImage or portraitVideo has to be set. The placement of the name is set using placement. Use designer selectors to style the elements. If styledName aor styledText is used designer selectors have no effect on \ name or text.

Parameters

text	Simple text. Ignored if styledText is used.
name	Name or null to not display a name.
styledText	Styled text or null to use simple text.
styledName	Styled name or null to use simple name.
portraitImage	Portrait image or null if not used.
portraitVideo	Portrait video or null if not used.
placement	Name placement from NAME_*.

◆ onDesignerSelectorChanged()

void Dragengine.Gui.SubTitleBoxTextBorder.onDesignerSelectorChanged ( )

Designer selector changed.

If name label is present sets designer selector to "Label.\{designerSelector\}.Name". If text label is present sets designer selector to "Label.\{designerSelector\}.Text".

Both labels can be designed with selector 'Label.{designerSelector}'.

Reimplemented from Dragengine.Gui.Widget.

◆ persistencyFactoryName()

String Dragengine.Gui.SubTitleBoxTextBorder.persistencyFactoryName ( )

Name of PersistencyFactory required to load object from file.

Name of PersistencyFactory is first written to the file as string with 8-bit length. Then writeToFile() is called to write the object itself. Empty name is not allowed as is names longer than 255 characters. Name has to match a PersistencyFactory present in the Persistency instance used for loading objects. Object is read using PersistencyFactory.readObjectFromFile() of the matching PersistencyFactory.

Implements Dragengine.LoadSave.Persistable.

◆ readFromFile()

static SubTitleBoxTextBorder Dragengine.Gui.SubTitleBoxTextBorder.readFromFile	(	Factory	factory,
		PersistencyEnvironment	env,
		FileReader	reader
	)

static

Read action from file.

Version: 1.16

◆ subtitleWidget()

Widget Dragengine.Gui.SubTitleBoxTextBorder.subtitleWidget ( )

Subtitle widget.

Implements Dragengine.Gui.SubTitleBoxText.

◆ writeObjectToFile()

void Dragengine.Gui.SubTitleBoxTextBorder.writeObjectToFile	(	PersistencyEnvironment	env,
		FileWriter	writer
	)

Write object to file writer.

Implements Dragengine.LoadSave.Persistable.

Member Data Documentation

◆ pHideTimer

HideTimer Dragengine.Gui.SubTitleBoxTextBorder.pHideTimer

protected

◆ pImagePortrait

DisplayImage Dragengine.Gui.SubTitleBoxTextBorder.pImagePortrait

protected

◆ pLabelName

Label Dragengine.Gui.SubTitleBoxTextBorder.pLabelName

protected

◆ pLabelText

Label Dragengine.Gui.SubTitleBoxTextBorder.pLabelText

protected

◆ pPlacement

Placement Dragengine.Gui.SubTitleBoxTextBorder.pPlacement

protected

◆ pStyledName

DisplayStyledText Dragengine.Gui.SubTitleBoxTextBorder.pStyledName

protected

◆ pStyledText

DisplayStyledText Dragengine.Gui.SubTitleBoxTextBorder.pStyledText

protected

◆ pVideoPortrait

DisplayVideo Dragengine.Gui.SubTitleBoxTextBorder.pVideoPortrait

protected

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

SubTitleBoxTextBorder.ds

Classes

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dispose()

◆ getImagePortrait()

◆ getLabelName()

◆ getLabelText()

◆ getPlacement()

◆ getStyledName()

◆ getStyledText()

◆ getVideoPortrait()

◆ hideSubtitleAfter()

◆ hideSubtitleNow()

◆ hideTimerElapsed()

◆ new()

◆ onDesignerSelectorChanged()

◆ persistencyFactoryName()

◆ readFromFile()

◆ subtitleWidget()

◆ writeObjectToFile()

Member Data Documentation

◆ pHideTimer

◆ pImagePortrait

◆ pLabelName

◆ pLabelText

◆ pPlacement

◆ pStyledName

◆ pStyledText

◆ pVideoPortrait