Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay Class Reference

Display text for interactive main menu. More...

Inheritance diagram for Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay:

Classes
enum	State
	States. More...

Public Member Functions
void	clearText ()
	Clear text to display.
void	dispose ()
	Dispose of widget.
float	getElapsedTime ()
	Elapsed fade time.
float	getFadeTime ()
	Fade time.
Label	getLabel ()
	Label.
InteractiveMainMenu	getMainMenu ()
	Interactive main menu.
State	getState ()
	State.
String	getText ()
	Text to display.
IMMTextDisplay	new (InteractiveMainMenu mainMenu)
	Create text display for interactive main menu.
void	reset ()
	Reset.
void	setFadeTime (float time)
	Set fade time.
void	setText (String text)
	Set text to display.
void	update (float elapsed)
	Update camera.
Public Member Functions inherited from Dragengine.Gui.Panel
Panel	new ()
	Create panel.
Panel	new (int x, int y, int width, int height)
	Create panel.
Panel	new (Layout layout)
	Create panel with layout.
Panel	new (Layout layout, Block blockAddContent)
	Create panel with layout calling block to add content.
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 (Point position, Point size)
Widget	nextFocusWidgetAfter (Widget widget)
	Find next widget in the focus cycle that can grab the focus.
void	onGuiThemeChanged ()
void	onPaddingChanged ()
	Padding changed.
void	onStateChanged (StateChangeEvent event)
	State 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	onFocusLost (FocusEvent event)
	Widget lost focus.
void	onFocusReceived (FocusEvent event)
	Widget received focus.
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	setFont (Font font)
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	setTextColor (Color color)
	Set text color.
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
float	pElapsedTime
float	pFadeTime
Label	pLabel
InteractiveMainMenu	pMainMenu
String	pRealText
State	pState
String	pText
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

Protected Member Functions
void	onTextChanged ()
	Text changed.
void	setElapsedTime (float time)
	Set elapsed fade time.
void	setState (State state)
	Set state.
void	updateFading ()
	Update fading.
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

Display text for interactive main menu.

Shows a label at the bottom side of the main menu window overlaying the render panel displaying the display text of active hot spots. Other text can be shown too. A full screen panel is placed over the render window with BorderLayout. A smaller panel is placed in the bottom area of this layout with CentrizedBoxLayout. The label is located inside. The panel is styled using "Panel.IMMTextDisplay". This is mainly used to add the desired padding from the screen border. The label only is styled using "Label.IMMTextDisplay". The main panel is shown if the text to display is not empty. If empty the panel is hidden.

Member Function Documentation

clearText()

void Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.clearText

(

)

Clear text to display.

dispose()

void Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.dispose

(

)

Dispose of widget.

Reimplemented from Dragengine.Gui.Widget.

getElapsedTime()

float Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.getElapsedTime

(

)

Elapsed fade time.

getFadeTime()

float Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.getFadeTime

(

)

Fade time.

getLabel()

Label Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.getLabel

(

)

Label.

getMainMenu()

InteractiveMainMenu Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.getMainMenu

(

)

Interactive main menu.

getState()

State Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.getState

(

)

State.

getText()

String Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.getText

(

)

Text to display.

new()

IMMTextDisplay Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.new

(

InteractiveMainMenu

mainMenu

)

Create text display for interactive main menu.

onTextChanged()

void Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.onTextChanged ( )

protected

Text changed.

reset()

void Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.reset

(

)

Reset.

setElapsedTime()

void Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.setElapsedTime ( float  time )

protected

Set elapsed fade time.

setFadeTime()

void Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.setFadeTime

(

float

time

)

Set fade time.

setState()

void Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.setState ( State  state )

protected

Set state.

setText()

void Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.setText

(

String

text

)

Set text to display.

update()

void Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.update

(

float

elapsed

)

Update camera.

updateFading()

void Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.updateFading ( )

protected

Update fading.

Member Data Documentation

pElapsedTime

float Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.pElapsedTime

pFadeTime

float Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.pFadeTime

pLabel

Label Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.pLabel

pMainMenu

InteractiveMainMenu Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.pMainMenu

pRealText

String Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.pRealText

pState

State Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.pState

pText

String Dragengine.Gui.MainMenus.Interactive.IMMTextDisplay.pText

---

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

• IMMTextDisplay.ds