Dragengine.Gui.DisplayStyledText Class Reference
Display page of styled text document. More...
Inheritance diagram for Dragengine.Gui.DisplayStyledText:
Public Member Functions | |
| int | getCurrentPage () |
| Index of page to display. More... | |
| Point | getMinimumSize () |
| Minimum size of widget. More... | |
| Point | getMinimumSizeForWidth (int width) |
| Minimum size of widget using reference widget width and variable height. More... | |
| Point | getMinPageSize () |
| Minimum page size in case widget size is smaller. More... | |
| int | getPageCount () |
| Number of pages. More... | |
| bool | getPagedMode () |
| Paged mode. More... | |
| StyledTextDefinition | getStyledTextDefinition () |
| Styled text document definition or null if not set. More... | |
| DisplayStyledText | new () |
| Create widget. More... | |
| void | onResize (WidgetEvent event) |
| Size changed. More... | |
| void | setCurrentPage (int page) |
| Set index of page to display. More... | |
| void | setMinPageSize (Point size) |
| Set minimum page size in case widget size is smaller. More... | |
| void | setPagedMode (bool pagedMode) |
| Set paged mode. More... | |
| void | setStyledTextDefinition (StyledTextDefinition definition) |
| Set styled text document definition or null if not set. 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... | |
| void | dispose () |
| 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 (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 | onGuiThemeChanged () |
| 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 | onSetFont () |
| void | onSetTextColor () |
| Text color changed. More... | |
| void | onShown (WidgetEvent event) |
| Widget has been shown. More... | |
| void | onStateChanged (StateChangeEvent event) |
| State changed. 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 | 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 () |
Protected Member Functions | |
| Point | calcMinSize (Point pageSize) |
| Calculate minimum size for layout. More... | |
| 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 page of styled text document.
By default the text document uses page mode. In page mode the document is split into pages with the size of the available space (widget width minus padding). To switch between the pages call the setCurrentPage() method.
Optionally the text document can be set to non-page mode. In this mode the entire document is formatted on one single page.
To properly layout the document width of the widget is used. This is especially important if you want to use ScrollPanel to allow scrolling up and down. The Viewport widget is required to be set to FlowLayout or another layout adjusting the widget size to cover the full size. FlowLayout is best suited for this task since it allows the widget to be higher than the available space while using the available width. The following code creates a vertically scrollable DisplayStyledText.
var DisplayStyledText widget = DisplayStyledText.new()
// widget.setPagedMode(false) // if you want to use single page mode.
container.addWidge(ScrollPanel.new(Viewport.new(widget, FlowLayout.new(LayoutAxis.y))))
Member Function Documentation
◆ calcMinSize()
Calculate minimum size for layout.
◆ getCurrentPage()
| int Dragengine.Gui.DisplayStyledText.getCurrentPage | ( | ) |
Index of page to display.
◆ getMinimumSize()
| Point Dragengine.Gui.DisplayStyledText.getMinimumSize | ( | ) |
Minimum size of widget.
Reimplemented from Dragengine.Gui.Widget.
◆ getMinimumSizeForWidth()
| Point Dragengine.Gui.DisplayStyledText.getMinimumSizeForWidth | ( | int | width | ) |
Minimum size of widget using reference widget width and variable height.
Reimplemented from Dragengine.Gui.Widget.
◆ getMinPageSize()
| Point Dragengine.Gui.DisplayStyledText.getMinPageSize | ( | ) |
Minimum page size in case widget size is smaller.
◆ getPageCount()
| int Dragengine.Gui.DisplayStyledText.getPageCount | ( | ) |
Number of pages.
◆ getPagedMode()
| bool Dragengine.Gui.DisplayStyledText.getPagedMode | ( | ) |
Paged mode.
◆ getStyledTextDefinition()
| StyledTextDefinition Dragengine.Gui.DisplayStyledText.getStyledTextDefinition | ( | ) |
Styled text document definition or null if not set.
◆ new()
| DisplayStyledText Dragengine.Gui.DisplayStyledText.new | ( | ) |
Create widget.
Reimplemented from Dragengine.Gui.Widget.
◆ onResize()
| void Dragengine.Gui.DisplayStyledText.onResize | ( | WidgetEvent | event | ) |
Size changed.
Reimplemented from Dragengine.Gui.Widget.
◆ setCurrentPage()
| void Dragengine.Gui.DisplayStyledText.setCurrentPage | ( | int | page | ) |
Set index of page to display.
◆ setMinPageSize()
| void Dragengine.Gui.DisplayStyledText.setMinPageSize | ( | Point | size | ) |
Set minimum page size in case widget size is smaller.
◆ setPagedMode()
| void Dragengine.Gui.DisplayStyledText.setPagedMode | ( | bool | pagedMode | ) |
Set paged mode.
◆ setStyledTextDefinition()
| void Dragengine.Gui.DisplayStyledText.setStyledTextDefinition | ( | StyledTextDefinition | definition | ) |
Set styled text document definition or null if not set.
The documentation for this class was generated from the following file:
