Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.CheckBox Class Reference

Check box widget. More...

Inheritance diagram for Dragengine.Gui.CheckBox:
Dragengine.Gui.ToggleButton Dragengine.Gui.Button Dragengine.Gui.ToggleModelListener Dragengine.Gui.Container Dragengine.Gui.Widget

Public Member Functions

void createContentWidgets ()
 Create button content widgets. More...
 
void dispose ()
 
Widget getCheckBoxWidget ()
 Check box widget or null if not set. More...
 
Widget getCheckWidget ()
 Check mark widget or null if not set. More...
 
CheckBox new ()
 Create check box. More...
 
CheckBox new (String text)
 Create text check button. More...
 
CheckBox new (String text, Image image)
 Create text and image check button. More...
 
CheckBox new (ToggleModel model)
 Create check box. More...
 
CheckBox new (ToggleModel model, String text)
 Create text check button. More...
 
CheckBox new (ToggleModel model, String text, Image image)
 Create text and image check button. More...
 
void onDesignerChanged ()
 Designer changed. More...
 
void setCheckBoxWidget (Widget widget)
 Set check box widget or null if not set. More...
 
void setCheckWidget (Widget widget)
 Set check mark widget. More...
 
- Public Member Functions inherited from Dragengine.Gui.ToggleButton
ToggleButtonGroup getButtonGroup ()
 Button group or null. More...
 
bool getStickyToggled ()
 Button stays toggled. More...
 
bool getToggled ()
 Button is toggled. More...
 
ToggleModel getToggleModel ()
 Toggle model. More...
 
ToggleButton new (String text, ActionListener action)
 Create text toggle button. More...
 
ToggleButton new (String text, Image image, ActionListener action)
 Create text and image toggle button. More...
 
ToggleButton new (ToggleModel model, String text, ActionListener action)
 Create text toggle button. More...
 
ToggleButton new (ToggleModel model, String text, Image image, ActionListener action)
 Create text and image toggle button. More...
 
void onButtonPress (MouseEvent event)
 
void onButtonRelease (MouseEvent event)
 Mouse button has been released. More...
 
void onKeyPress (KeyEvent event)
 Key on the keyboard has been pressed. More...
 
void onKeyRelease (KeyEvent event)
 Key on the keyboard has been released. More...
 
void onMouseMove (MouseEvent event)
 Mouse has moved. More...
 
void setButtonGroup (ToggleButtonGroup buttonGroup)
 Set button group or null. More...
 
void setStickyToggled (bool stickyToggled)
 Set if button stays toggled. More...
 
void setToggled (bool toggled)
 Set if button is toggled. More...
 
void setToggleModel (ToggleModel model)
 Set list model. More...
 
void toggledChanged (ToggleModel model)
 Toggled state changed. More...
 
- Public Member Functions inherited from Dragengine.Gui.Button
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...
 
void onFocusLost (FocusEvent event)
 Widget lost focus. More...
 
void onFocusReceived (FocusEvent event)
 Widget received focus. More...
 
void onGuiThemeChanged ()
 Gui theme changed. More...
 
void onMouseEnter (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 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...
 

Additional Inherited Members

- Public Attributes inherited from Dragengine.Gui.Button
Array pActionListeners
 
bool pHasGrab
 
Image pHoverImage
 
Image pImage
 
bool pPressed
 
String pText
 
DisplayImage pWidgetImage
 
Label pWidgetText
 
- 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
 
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 pHasBlockedLayoutParent
 
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.Button
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...
 

Detailed Description

Check box widget.

Specialization of the ToggleButton showing a tickable check box.

Member Function Documentation

◆ createContentWidgets()

void Dragengine.Gui.CheckBox.createContentWidgets ( )

Create button content widgets.

Call if the layout of the widgets changes. Removes the old widgets first.

Reimplemented from Dragengine.Gui.Button.

◆ dispose()

void Dragengine.Gui.CheckBox.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.ToggleButton.

◆ getCheckBoxWidget()

Widget Dragengine.Gui.CheckBox.getCheckBoxWidget ( )

Check box widget or null if not set.

For use by check box designers.

◆ getCheckWidget()

Widget Dragengine.Gui.CheckBox.getCheckWidget ( )

Check mark widget or null if not set.

For use by check box designers.

◆ new() [1/6]

CheckBox Dragengine.Gui.CheckBox.new ( )

Create check box.

Reimplemented from Dragengine.Gui.ToggleButton.

◆ new() [2/6]

CheckBox Dragengine.Gui.CheckBox.new ( String  text)

Create text check button.

Reimplemented from Dragengine.Gui.ToggleButton.

◆ new() [3/6]

CheckBox Dragengine.Gui.CheckBox.new ( String  text,
Image  image 
)

Create text and image check button.

Reimplemented from Dragengine.Gui.ToggleButton.

◆ new() [4/6]

CheckBox Dragengine.Gui.CheckBox.new ( ToggleModel  model)

Create check box.

Reimplemented from Dragengine.Gui.ToggleButton.

◆ new() [5/6]

CheckBox Dragengine.Gui.CheckBox.new ( ToggleModel  model,
String  text 
)

Create text check button.

Reimplemented from Dragengine.Gui.ToggleButton.

◆ new() [6/6]

CheckBox Dragengine.Gui.CheckBox.new ( ToggleModel  model,
String  text,
Image  image 
)

Create text and image check button.

Reimplemented from Dragengine.Gui.ToggleButton.

◆ onDesignerChanged()

void Dragengine.Gui.CheckBox.onDesignerChanged ( )

Designer changed.

Reimplemented from Dragengine.Gui.Widget.

◆ setCheckBoxWidget()

void Dragengine.Gui.CheckBox.setCheckBoxWidget ( Widget  widget)

Set check box widget or null if not set.

For use by check box designers.

◆ setCheckWidget()

void Dragengine.Gui.CheckBox.setCheckWidget ( Widget  widget)

Set check mark widget.

For use by check box designers.


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