Dragengine.Gui.PanelInteractPrompt Class Reference
Display list of InteractPromptEntry. More...
Inheritance diagram for Dragengine.Gui.PanelInteractPrompt:
Classes | |
| class | BindingsChanged |
| Bindings changed listener. More... | |
Public Member Functions | |
| void | contentChanged (ListModel listModel, int fromIndex, int toIndex) |
| Content of the model changed. More... | |
| void | dispose () |
| Dispose of widget. More... | |
| void | elementsAdded (ListModel listModel, int fromIndex, int toIndex) |
| Elements added. More... | |
| void | elementsRemoved (ListModel listModel, int fromIndex, int toIndex) |
| Elements removed. More... | |
| int | getBindingIconHeight () |
| Binding icon height. More... | |
| BindingManager | getBindingManager () |
| Binding manager. More... | |
| String | getEntryBaseSelectorName () |
| Base selector name used for created entries. More... | |
| DefaultListModel | getModel () |
| List model. More... | |
| DisplayInteractPromptEntry.Placement | getPlacement () |
| Placement to use for newly created widgets. More... | |
| PanelInteractPrompt | new () |
| Create interact prompt panel. More... | |
| PanelInteractPrompt | new (BindingManager bindingManager, int bindingIconHeight) |
| PanelInteractPrompt | new (BindingManager bindingManager, int bindingIconHeight, DisplayInteractPromptEntry.Placement placement) |
| PanelInteractPrompt | new (BindingManager bindingManager, int bindingIconHeight, DisplayInteractPromptEntry.Placement placement, String designerSelector, String entryBaseSelectorName) |
| void | selectionChanged (ListModel listModel) |
| Selection in the model changed. More... | |
| void | setModel (DefaultListModel model) |
| Set list model. More... | |
| void | setPrompts (Array prompts) |
| Set prompts from array of instances of InteractPromptEntry. More... | |
| void | updateWidgets () |
| Update widgets representing the entries. More... | |
 Public Member Functions inherited from Dragengine.Gui.Panel | |
| 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... | |
| bool | getBlockLayoutParent () |
| Block layoutParent calls. 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 | getHasBlockedLayoutParent () |
| layoutParent calls happened during runWhileBlockingLayoutParent. More... | |
| 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 | getLocalMouseLocation () |
| Parent desktop mouse location in widget coordinates. 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 () |
| void | layoutParentIfBlocked () |
| Calls layoutParent if getHasBlockedLayoutParent() is true. 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 | 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 | runWhileBlockingLayoutParent (Block ablock) |
| Run block while layouting is blocked. More... | |
| 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 | setBlockLayoutParent (bool blockLayoutParent) |
| Set block layoutParent calls. 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 | setHasBlockedLayoutParent (bool hasBlockedLayoutParent) |
| Set if layoutParent calls happened during runWhileBlockingLayoutParent. More... | |
| 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... | |
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
Display list of InteractPromptEntry.
Uses DefaultListModel to store the list of InteractPromptEntry to display. Changing the content of the list model updates the PanelInteractPrompt. For each model entry a view widget is created and added to the panel.
This widget is non-interactive and best suited for showing a small number of prompts.
The panel can be styled using selector these designer selectors:
- "InteractPrompt": The prompt panel.
Member Function Documentation
◆ contentChanged()
| void Dragengine.Gui.PanelInteractPrompt.contentChanged | ( | ListModel | listModel, |
| int | fromIndex, | ||
| int | toIndex | ||
| ) |
Content of the model changed.
Implements Dragengine.Gui.ListModelListener.
◆ dispose()
| void Dragengine.Gui.PanelInteractPrompt.dispose | ( | ) |
Dispose of widget.
Reimplemented from Dragengine.Gui.Widget.
◆ elementsAdded()
| void Dragengine.Gui.PanelInteractPrompt.elementsAdded | ( | ListModel | listModel, |
| int | fromIndex, | ||
| int | toIndex | ||
| ) |
Elements added.
Implements Dragengine.Gui.ListModelListener.
◆ elementsRemoved()
| void Dragengine.Gui.PanelInteractPrompt.elementsRemoved | ( | ListModel | listModel, |
| int | fromIndex, | ||
| int | toIndex | ||
| ) |
Elements removed.
Implements Dragengine.Gui.ListModelListener.
◆ getBindingIconHeight()
| int Dragengine.Gui.PanelInteractPrompt.getBindingIconHeight | ( | ) |
Binding icon height.
◆ getBindingManager()
| BindingManager Dragengine.Gui.PanelInteractPrompt.getBindingManager | ( | ) |
Binding manager.
◆ getEntryBaseSelectorName()
| String Dragengine.Gui.PanelInteractPrompt.getEntryBaseSelectorName | ( | ) |
Base selector name used for created entries.
◆ getModel()
| DefaultListModel Dragengine.Gui.PanelInteractPrompt.getModel | ( | ) |
List model.
◆ getPlacement()
| DisplayInteractPromptEntry.Placement Dragengine.Gui.PanelInteractPrompt.getPlacement | ( | ) |
Placement to use for newly created widgets.
◆ new() [1/4]
| PanelInteractPrompt Dragengine.Gui.PanelInteractPrompt.new | ( | ) |
Create interact prompt panel.
Reimplemented from Dragengine.Gui.Panel.
◆ new() [2/4]
| PanelInteractPrompt Dragengine.Gui.PanelInteractPrompt.new | ( | BindingManager | bindingManager, |
| int | bindingIconHeight | ||
| ) |
◆ new() [3/4]
| PanelInteractPrompt Dragengine.Gui.PanelInteractPrompt.new | ( | BindingManager | bindingManager, |
| int | bindingIconHeight, | ||
| DisplayInteractPromptEntry.Placement | placement | ||
| ) |
◆ new() [4/4]
| PanelInteractPrompt Dragengine.Gui.PanelInteractPrompt.new | ( | BindingManager | bindingManager, |
| int | bindingIconHeight, | ||
| DisplayInteractPromptEntry.Placement | placement, | ||
| String | designerSelector, | ||
| String | entryBaseSelectorName | ||
| ) |
◆ selectionChanged()
| void Dragengine.Gui.PanelInteractPrompt.selectionChanged | ( | ListModel | listModel | ) |
Selection in the model changed.
Implements Dragengine.Gui.ListModelListener.
◆ setModel()
| void Dragengine.Gui.PanelInteractPrompt.setModel | ( | DefaultListModel | model | ) |
Set list model.
◆ setPrompts()
| void Dragengine.Gui.PanelInteractPrompt.setPrompts | ( | Array | prompts | ) |
Set prompts from array of instances of InteractPromptEntry.
◆ updateWidgets()
| void Dragengine.Gui.PanelInteractPrompt.updateWidgets | ( | ) |
Update widgets representing the entries.
Call if entries changed. Tries to update existing widgets first creating new ones if required. All unused widgets beyond the required count of widgets are hidden to reduce widget creation to a minimum.
Member Data Documentation
◆ pBindingIconHeight
| int Dragengine.Gui.PanelInteractPrompt.pBindingIconHeight |
◆ pBindingManager
| BindingManager Dragengine.Gui.PanelInteractPrompt.pBindingManager |
◆ pBindingsChanged
| BindingsChanged Dragengine.Gui.PanelInteractPrompt.pBindingsChanged |
◆ pEntryBaseSelectorName
| String Dragengine.Gui.PanelInteractPrompt.pEntryBaseSelectorName |
◆ pModel
| DefaultListModel Dragengine.Gui.PanelInteractPrompt.pModel |
◆ pPlacement
| DisplayInteractPromptEntry.Placement Dragengine.Gui.PanelInteractPrompt.pPlacement |
The documentation for this class was generated from the following file:
