Drag[en]gine Script Module DragonScript Script API  1.0
CheckBox Class Reference

Check box widget. More...

Inheritance diagram for CheckBox:
ToggleButton Button Container 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...
 
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 ToggleButton
void dispose ()
 
ToggleButtonGroup getGroup ()
 Button group or null if not belonging to one. More...
 
bool getStickyToggled ()
 Button stays toggled. More...
 
bool getToggled ()
 Button is toggled. More...
 
ToggleButton new ()
 Create toggle button. More...
 
ToggleButton new (String text)
 Create text toggle button. More...
 
ToggleButton new (String text, Image image)
 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 setGroup (ToggleButtonGroup group)
 Set button group or null if not belonging to one. More...
 
void setStickyToggled (bool stickyToggled)
 Set if button stays toggled. More...
 
void setToggled (bool toggled)
 Set if button is toggled. More...
 
- Public Member Functions inherited from Button
void addActionListener (ActionListener listener)
 
void createContentWidgets ()
 Create button content widgets. More...
 
void design ()
 Design button using ButtonDesigner. More...
 
void dispose ()
 
void fireAction (int modifiers)
 
ButtonDesigner getDesigner ()
 Button designer. More...
 
bool getHilighted ()
 
Image getHoverImage ()
 Hover image or null to use regular image. More...
 
Image getImage ()
 
bool getPressed ()
 
String getText ()
 Text of the button. More...
 
bool isDesignerSet ()
 Designer is set manually. More...
 
Button new ()
 Create button. More...
 
Button new (String text)
 Create text button. More...
 
Button new (String text, Image image)
 Create text and image button. More...
 
void onButtonPress (MouseEvent event)
 
void onButtonRelease (MouseEvent event)
 
void onDesignerChanged ()
 Designer changed. More...
 
void onFocusLost (FocusEvent event)
 Widget lost focus. More...
 
void onFocusReceived (FocusEvent event)
 Widget received focus. More...
 
void onGuiThemeChanged ()
 
void onKeyPress (KeyEvent event)
 
void onKeyRelease (KeyEvent event)
 
void onMouseEnter (MouseEvent event)
 
void onMouseLeave (MouseEvent event)
 
void onMouseMove (MouseEvent event)
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void onStateChanged (StateChangeEvent event)
 State changed. More...
 
void removeActionListener (ActionListener listener)
 
void setDesigner (ButtonDesigner designer)
 Set button designer. More...
 
void setEnabled (bool enabled)
 Set if widget is enabled. More...
 
void setFont (Font font)
 
void setForegroundColor (Color color)
 
void setHilighted (bool hilighted)
 
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 Container
void addWidget (Widget widget)
 
void addWidget (Widget widget, Object settings)
 
bool allowsChildGrabFocus ()
 
void dispose ()
 
void doLayout ()
 
Widget findLastFocusableWidget ()
 
void forEachWidget (Block ablock)
 
bool getAutoVisibleChildren ()
 
bool getBlockLayout ()
 Block layout calls. More...
 
int getContainerHeight ()
 
Point getContainerSize ()
 
int getContainerWidth ()
 
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...
 
int getPaddingBottom ()
 
int getPaddingHeight ()
 Height gain of padding. More...
 
int getPaddingLeft ()
 
int getPaddingRight ()
 
Point getPaddingSize ()
 Size gain of padding. More...
 
int getPaddingTop ()
 
int getPaddingWidth ()
 Width gain of padding. 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)
 
bool isChildVisible (Widget child)
 
bool isMouseInside ()
 Mouse is hovering over this widget. More...
 
void layoutParent ()
 
void moveWidget (Widget widget, int newPosition)
 
Container new ()
 
Container new (int x, int y, int width, int height)
 
Widget nextFocusWidgetAfter (Widget widget)
 Find next widget in the focus cycle that can grab the focus. More...
 
void onGuiThemeChanged ()
 
void onHidden (WidgetEvent event)
 Widget has been hidden. More...
 
void onResize (WidgetEvent event)
 Size 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 ()
 
void removeWidget (Widget widget)
 
void reorderChildCanvas ()
 
bool requestCaptureMouse (Widget widget)
 
bool requestReleaseMouse (Widget widget)
 
void runWhileBlockingLayout (Block ablock)
 Run block while layouting is blocked. More...
 
void setAutoVisibleChildren (bool autoVisible)
 
void setBlockLayout (bool blockLayout)
 Set block layout calls. More...
 
void setLayout (Layout layout)
 
void setMousePointer (MousePointer mousePointer)
 
void setPadding (int left, int top, int right, int bottom)
 
void setPadding (int padding)
 
void setPadding (BorderSize borderSize)
 Set padding from border size. More...
 
- Public Member Functions inherited from Widget
void addDragListener (DragListener listener)
 
void addFocusListener (FocusListener listener)
 Add focus 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 dispose ()
 
Widget findFocusableWidget ()
 
Widget findLastFocusableWidget ()
 
CanvasCreator getBackgroundCanvasCreator ()
 Background canvas creator or null to use background color. More...
 
Color getBackgroundColor ()
 
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 ()
 
ColorMatrix getColorTransformation ()
 Color transformation. More...
 
Desktop getDesktop ()
 
Point getDesktopPosition ()
 Widget position in desktop coordinates. More...
 
bool getEnabled ()
 
MousePointer getFirstMousePointer ()
 
Font getFont ()
 
Color getForegroundColor ()
 
GuiTheme getGuiTheme ()
 
bool getHasFocus ()
 
int getHeight ()
 Height of widget. More...
 
RangeModel getHorizontalRangeModel ()
 Horizontal range model for viewports to synchronize the horizontal scrollbar. More...
 
Point getMinimumSize ()
 
Point getMinimumSizeForHeight (int height)
 Minimum size of widget using reference widget height and variable width. More...
 
Point getMinimumSizeForHeightWithBorder (int height)
 Minimum size of widget with border using reference widget height and variable width. More...
 
Point getMinimumSizeForWidth (int width)
 Minimum size of widget using reference widget width and variable height. More...
 
Point getMinimumSizeForWidthWithBorder (int width)
 Minimum size of widget with border using reference widget width and variable height. More...
 
Point getMinimumSizeWithBorder ()
 
MousePointer getMousePointer ()
 
Container getParent ()
 
Point getPosition ()
 Position of the widget. 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...
 
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 isBackgroundColorSet ()
 
bool isFontSet ()
 
bool isForegroundColorSet ()
 
bool isGuiThemeSet ()
 
bool isMinimumSizeSet ()
 
bool isMouseInside ()
 Mouse is hovering over this widget. More...
 
bool isPointInside (Point position)
 
bool isTransformationSet ()
 
void layoutParent ()
 
Widget new ()
 
Widget new (int x, int y, int width, int height)
 
Widget nextFocusWidget ()
 Find next widget in the focus cycle that can grab the focus. More...
 
void notifyBorderParametersChanged ()
 
void onButtonPress (MouseEvent event)
 
void onButtonRelease (MouseEvent event)
 
void onDispose (WidgetEvent event)
 Window is disposing. More...
 
void onDragDrop (DragEvent event)
 
void onDragEnter (DragEvent event)
 
void onDragLeave (DragEvent event)
 
void onDragOver (DragEvent event)
 
void onFocusLost (FocusEvent event)
 Widget lost focus. More...
 
void onFocusReceived (FocusEvent event)
 Widget received focus. More...
 
void onGuiThemeChanged ()
 
void onHidden (WidgetEvent event)
 Widget has been hidden. More...
 
void onKeyPress (KeyEvent event)
 
void onKeyRelease (KeyEvent event)
 
void onKeyType (KeyEvent event)
 
void onMouseEnter (MouseEvent event)
 
void onMouseLeave (MouseEvent event)
 
void onMouseMove (MouseEvent event)
 
void onReposition (WidgetEvent event)
 Position changed. More...
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void onSetBackgroundColor ()
 
void onSetFont ()
 
void onSetForegroundColor ()
 
void onShown (WidgetEvent event)
 Widget has been shown. More...
 
void onStateChanged (StateChangeEvent event)
 State changed. 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 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 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 setBackgroundColor (Color color)
 
void setBorder (Border border)
 
void setCanFocus (bool canFocus)
 
void setColorTransformation (ColorMatrix transformation)
 Set color transformation. More...
 
void setEnabled (bool enabled)
 
void setFont (Font font)
 
void setForegroundColor (Color color)
 
void setGuiTheme (GuiTheme theme)
 
void setHasFocus (bool hasFocus)
 
void setHeight (int height)
 Set height of widget. More...
 
void setMinimumSize (Point size)
 
void setMousePointer (MousePointer mousePointer)
 
void setParent (Container parent)
 
void setPosition (Point position)
 Set position of widget. More...
 
void setSize (Point size)
 Set size of widget. 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 stopRepeatEventTimer ()
 
void updateCanvasBackground ()
 Update background canvas content. More...
 

Protected Member Functions

ButtonDesigner createDefaultDesigner ()
 Create designer from gui theme. More...
 
- Protected Member Functions inherited from Button
ButtonDesigner createDefaultDesigner ()
 Create designer from gui theme. More...
 
DisplayImage getWidgetImage ()
 Image or null if not used. More...
 
Label getWidgetText ()
 Label 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...
 

Detailed Description

Check box widget.

Specialization of the ToggleButton showing a tickable check box.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ createContentWidgets()

void createContentWidgets ( )

Create button content widgets.

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

§ createDefaultDesigner()

ButtonDesigner createDefaultDesigner ( )
protected

Create designer from gui theme.

§ dispose()

void dispose ( )

Disposes of the widget. This cleans all references and prepars the widget for beeing freed. If the widget is already disposed nothing happens.

§ getCheckBoxWidget()

Widget getCheckBoxWidget ( )

Check box widget or null if not set.

For use by check box designers.

§ getCheckWidget()

Widget getCheckWidget ( )

Check mark widget or null if not set.

For use by check box designers.

§ new() [1/3]

CheckBox new ( )

Create check box.

§ new() [2/3]

CheckBox new ( String  text)

Create text check button.

§ new() [3/3]

CheckBox new ( String  text,
Image  image 
)

Create text and image check button.

§ onDesignerChanged()

void onDesignerChanged ( )

Designer changed.

§ setCheckBoxWidget()

void setCheckBoxWidget ( Widget  widget)

Set check box widget or null if not set.

For use by check box designers.

§ setCheckWidget()

void setCheckWidget ( Widget  widget)

Set check mark widget.

For use by check box designers.


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