Drag[en]gine Script Module DragonScript
1.23
|
Public Member Functions | |
void | createContentWidgets () |
Create button content widgets. More... | |
void | dispose () |
void | fireAction (int modifiers) |
Image | getHoverImage () |
Hover image or null to use regular image. More... | |
Image | getImage () |
bool | getPressed () |
String | getText () |
Text of the button. More... | |
Button | new () |
Create button. More... | |
Button | new (String text, ActionListener action) |
Create text button. More... | |
Button | new (String text, Image image) |
Create text and image button. More... | |
Button | new (String text, Image image, ActionListener action) |
Create text and image button. More... | |
void | onButtonPress (MouseEvent event) |
void | onButtonRelease (MouseEvent event) |
void | onFocusLost (FocusEvent event) |
Widget lost focus. More... | |
void | onFocusReceived (FocusEvent event) |
Widget received focus. More... | |
void | onGuiThemeChanged () |
Gui theme changed. More... | |
void | onKeyPress (KeyEvent event) |
void | onKeyRelease (KeyEvent event) |
void | onMouseEnter (MouseEvent event) |
void | onMouseMove (MouseEvent event) |
void | removeActionListener (ActionListener listener) |
void | setHoverImage (Image image) |
Set hover image or null to use regular image. More... | |
void | setImage (Image image) |
void | setPressed (bool pressed) |
void | setText (String text) |
Set text of the button. More... | |
void | updateWidgetImage () |
Update image to display depending on current button state. 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 (int x, int y, int width, int height) |
Container | new (Layout layout) |
Create container with layout. More... | |
Container | new (Layout layout, Block blockAddContent) |
Create container with layout calling block to add content. More... | |
Container | new (Point position, Point size) |
Widget | nextFocusWidgetAfter (Widget widget) |
Find next widget in the focus cycle that can grab the focus. More... | |
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 | 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... | |
Protected Member Functions | |
DisplayImage | getWidgetImage () |
Image or null if not used. More... | |
void | setWidgetImage (DisplayImage widget) |
Set image or null if not used. More... | |
void | setWidgetText (Label widget) |
Set label or null if not used. 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... | |
Button widget.
Supports designing using designer selector 'Button'. If present the child label is designed using designer selector 'Label.Button'. If present the child display image is designed using designer selector 'Image.Button'. For best results the child label and image designer has to be a subclass of DefaultButtonWidgetDesigner.
void Dragengine.Gui.Button.createContentWidgets | ( | ) |
Create button content widgets.
Call if the layout of the widgets changes. Removes the old widgets first.
Reimplemented in Dragengine.Gui.OptionBox, and Dragengine.Gui.CheckBox.
void Dragengine.Gui.Button.dispose | ( | ) |
Disposes of the widget. This cleans all references and prepars the widget for beeing freed. If the widget is already disposed nothing happens.
Reimplemented from Dragengine.Gui.Widget.
Reimplemented in Dragengine.Gui.ToggleButton, Dragengine.Gui.OptionBox, Dragengine.Gui.CheckBox, and Dragengine.Gui.BgButton.
void Dragengine.Gui.Button.fireAction | ( | int | modifiers | ) |
Fire button press action.
Image Dragengine.Gui.Button.getHoverImage | ( | ) |
Hover image or null to use regular image.
Image Dragengine.Gui.Button.getImage | ( | ) |
Image of the button.
Reimplemented in Dragengine.Gui.BgButton.
bool Dragengine.Gui.Button.getPressed | ( | ) |
Button is pressed.
String Dragengine.Gui.Button.getText | ( | ) |
Text of the button.
Reimplemented in Dragengine.Gui.BgButton.
|
protected |
Image or null if not used.
Button Dragengine.Gui.Button.new | ( | ) |
Create button.
Reimplemented from Dragengine.Gui.Container.
Reimplemented in Dragengine.Gui.ToggleButton, Dragengine.Gui.OptionBox, and Dragengine.Gui.CheckBox.
Button Dragengine.Gui.Button.new | ( | String | text, |
ActionListener | action | ||
) |
Create text button.
Reimplemented in Dragengine.Gui.ToggleButton.
Create text and image button.
Reimplemented in Dragengine.Gui.ToggleButton, Dragengine.Gui.OptionBox, and Dragengine.Gui.CheckBox.
Button Dragengine.Gui.Button.new | ( | String | text, |
Image | image, | ||
ActionListener | action | ||
) |
Create text and image button.
Reimplemented in Dragengine.Gui.ToggleButton.
void Dragengine.Gui.Button.onButtonPress | ( | MouseEvent | event | ) |
Mouse button has been pressed.
Reimplemented in Dragengine.Gui.ToggleButton.
void Dragengine.Gui.Button.onButtonRelease | ( | MouseEvent | event | ) |
Mouse button has been released.
Reimplemented in Dragengine.Gui.ToggleButton.
void Dragengine.Gui.Button.onFocusLost | ( | FocusEvent | event | ) |
Widget lost focus.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.Button.onFocusReceived | ( | FocusEvent | event | ) |
Widget received focus.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.Button.onGuiThemeChanged | ( | ) |
Gui theme changed.
Reimplemented from Dragengine.Gui.Container.
void Dragengine.Gui.Button.onKeyPress | ( | KeyEvent | event | ) |
Key on the keyboard has been pressed.
Reimplemented in Dragengine.Gui.ToggleButton.
void Dragengine.Gui.Button.onKeyRelease | ( | KeyEvent | event | ) |
Key on the keyboard has been released.
Reimplemented in Dragengine.Gui.ToggleButton.
void Dragengine.Gui.Button.onMouseEnter | ( | MouseEvent | event | ) |
Notification that the mouse entered the widget. The default behaviour is to send the message to all registered listeners or propagate it back to the parent if allowed.
void Dragengine.Gui.Button.onMouseMove | ( | MouseEvent | event | ) |
Mouse has moved.
Reimplemented in Dragengine.Gui.ToggleButton.
void Dragengine.Gui.Button.removeActionListener | ( | ActionListener | listener | ) |
Remove action listener.
void Dragengine.Gui.Button.setHoverImage | ( | Image | image | ) |
Set hover image or null to use regular image.
void Dragengine.Gui.Button.setImage | ( | Image | image | ) |
Set image of the button.
Reimplemented in Dragengine.Gui.BgButton.
void Dragengine.Gui.Button.setPressed | ( | bool | pressed | ) |
Set if button is pressed.
void Dragengine.Gui.Button.setText | ( | String | text | ) |
Set text of the button.
Reimplemented in Dragengine.Gui.BgButton.
|
protected |
Set image or null if not used.
|
protected |
Set label or null if not used.
void Dragengine.Gui.Button.updateWidgetImage | ( | ) |
Update image to display depending on current button state.
Array Dragengine.Gui.Button.pActionListeners |
bool Dragengine.Gui.Button.pHasGrab |
Image Dragengine.Gui.Button.pHoverImage |
Image Dragengine.Gui.Button.pImage |
bool Dragengine.Gui.Button.pPressed |
String Dragengine.Gui.Button.pText |
DisplayImage Dragengine.Gui.Button.pWidgetImage |
Label Dragengine.Gui.Button.pWidgetText |