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

Drop down list displaying the currently selected element. More...

Inheritance diagram for ComboBox:
Container ListSelectionNotifier Widget

Classes

class  EditorFocusLost
 Editor focus lost listener. More...
 
class  PopupWidgetListener
 Popup widget listener. More...
 
class  RollUpMouseListener
 Roll up mouse listener. More...
 
class  StartEditMouseListener
 Start edit mouse listener. More...
 
class  WheelChangeSelection
 Change combo box selectiong using mouse wheel. More...
 

Public Member Functions

void addSelectionNotifier (ListSelectionNotifier notifier)
 Add list selection notifier. More...
 
void design ()
 Design button using ButtonDesigner. More...
 
void dispose ()
 Dispose of widget. More...
 
void dropDown ()
 Drop down the list box if not already dropped down. More...
 
bool droppedDown ()
 Drop down list visible. More...
 
Widget getButtonDropDownWidget ()
 Drop down button widget or null if not set. More...
 
ComboBoxDesigner getDesigner ()
 Combo box designer. More...
 
ComboBoxEditor getEditor ()
 Combo box editor if editable or null if not editable. More...
 
ListElementRenderer getElementRenderer ()
 List element renderer. More...
 
ListModel getModel ()
 List model. More...
 
int getNumberDisplayLines ()
 Number of lines to display in the drop down list box. More...
 
int getSelectedElement ()
 Index of the selected item or -1 if none is selected. More...
 
bool isDesignerSet ()
 Designer is set manually. More...
 
ComboBox new ()
 Create combo box widget. More...
 
ComboBox new (ListModel model)
 Create combo box widget. More...
 
ComboBox new (ListModel model, ListElementRenderer renderer)
 Create combo box widget. More...
 
void onFocusLost (FocusEvent event)
 Widget lost focus. More...
 
void onFocusReceived (FocusEvent event)
 Widget received focus. More...
 
void onGuiThemeChanged ()
 
void onMouseEnter (MouseEvent event)
 
void onMouseLeave (MouseEvent event)
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void onStateChanged (StateChangeEvent event)
 State changed. More...
 
void removeSelectionNotifier (ListSelectionNotifier notifier)
 Remove list selection notifier. More...
 
void requestGrabFocus (Widget widget)
 Request to focus the specified widget. More...
 
void rollUp ()
 Roll up the list box if dropped down. More...
 
void selectionChanged (ListBox listBox)
 Selection in the list box changed. More...
 
void setDesigner (ComboBoxDesigner designer)
 Set combo box designer. More...
 
void setDropBownButtonWidget (Widget widget)
 Set drop down button widget or null if not set. More...
 
void setEditor (ComboBoxEditor editor)
 Set combo box editor if editable or null if not editable. More...
 
void setElementRenderer (ListElementRenderer renderer)
 Set list element renderer. More...
 
void setModel (ListModel model)
 Set list model. More...
 
void setNumberDisplayLines (int lines)
 Set number of lines to display in the drop down list box. More...
 
void setSelectedElement (int index)
 Set index of the selected item or -1 if none is selected. More...
 
void startEditing ()
 Start editing if an editor is set otherwise toggle drop down. More...
 
void toggleDropDown ()
 Toggle between dropped down and rolled up state. More...
 
void updateSelectedVisibility ()
 Update visibility of editor and selected element renderer. More...
 
void updateSelectedWidget ()
 Update selected widget. 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...
 

Detailed Description

Drop down list displaying the currently selected element.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ addSelectionNotifier()

void addSelectionNotifier ( ListSelectionNotifier  notifier)

Add list selection notifier.

§ design()

void design ( )

Design button using ButtonDesigner.

§ dispose()

void dispose ( )

Dispose of widget.

§ dropDown()

void dropDown ( )

Drop down the list box if not already dropped down.

§ droppedDown()

bool droppedDown ( )

Drop down list visible.

§ getButtonDropDownWidget()

Widget getButtonDropDownWidget ( )

Drop down button widget or null if not set.

For use by button designers.

§ getDesigner()

ComboBoxDesigner getDesigner ( )

Combo box designer.

§ getEditor()

ComboBoxEditor getEditor ( )

Combo box editor if editable or null if not editable.

§ getElementRenderer()

ListElementRenderer getElementRenderer ( )

List element renderer.

§ getModel()

ListModel getModel ( )

List model.

§ getNumberDisplayLines()

int getNumberDisplayLines ( )

Number of lines to display in the drop down list box.

§ getSelectedElement()

int getSelectedElement ( )

Index of the selected item or -1 if none is selected.

§ isDesignerSet()

bool isDesignerSet ( )

Designer is set manually.

§ new() [1/3]

ComboBox new ( )

Create combo box widget.

§ new() [2/3]

ComboBox new ( ListModel  model)

Create combo box widget.

§ new() [3/3]

ComboBox new ( ListModel  model,
ListElementRenderer  renderer 
)

Create combo box widget.

§ onFocusLost()

void onFocusLost ( FocusEvent  event)

Widget lost focus.

§ onFocusReceived()

void onFocusReceived ( FocusEvent  event)

Widget received focus.

§ onGuiThemeChanged()

void onGuiThemeChanged ( )

Notification that the gui theme changed.

§ onMouseEnter()

void 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.

§ onMouseLeave()

void onMouseLeave ( MouseEvent  event)

Notification that the mouse left the widget. The default behaviour is to send the message to all registered listeners or propagate it back to the parent if allowed.

§ onResize()

void onResize ( WidgetEvent  event)

Size changed.

§ onStateChanged()

void onStateChanged ( StateChangeEvent  event)

State changed.

Sends event to listeners.

§ removeSelectionNotifier()

void removeSelectionNotifier ( ListSelectionNotifier  notifier)

Remove list selection notifier.

§ requestGrabFocus()

void requestGrabFocus ( Widget  widget)

Request to focus the specified widget.

§ rollUp()

void rollUp ( )

Roll up the list box if dropped down.

§ selectionChanged()

void selectionChanged ( ListBox  listBox)

Selection in the list box changed.

Implements ListSelectionNotifier.

§ setDesigner()

void setDesigner ( ComboBoxDesigner  designer)

Set combo box designer.

§ setDropBownButtonWidget()

void setDropBownButtonWidget ( Widget  widget)

Set drop down button widget or null if not set.

For use by button designers.

§ setEditor()

void setEditor ( ComboBoxEditor  editor)

Set combo box editor if editable or null if not editable.

§ setElementRenderer()

void setElementRenderer ( ListElementRenderer  renderer)

Set list element renderer.

§ setModel()

void setModel ( ListModel  model)

Set list model.

§ setNumberDisplayLines()

void setNumberDisplayLines ( int  lines)

Set number of lines to display in the drop down list box.

§ setSelectedElement()

void setSelectedElement ( int  index)

Set index of the selected item or -1 if none is selected.

§ startEditing()

void startEditing ( )

Start editing if an editor is set otherwise toggle drop down.

§ toggleDropDown()

void toggleDropDown ( )

Toggle between dropped down and rolled up state.

§ updateSelectedVisibility()

void updateSelectedVisibility ( )

Update visibility of editor and selected element renderer.

§ updateSelectedWidget()

void updateSelectedWidget ( )

Update selected widget.


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