Drag[en]gine Script Module DragonScript Script API  1.0
Container Class Reference
Inheritance diagram for Container:
Widget Button ComboBox Desktop ListBox Panel ScrollBar SpinButton Window

Public Member Functions

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

Container base class. A Container is a widget able to store other widgets and to arrange them in a usefull manner.

Author
Roland Pl├╝ss
Version
1.0

Member Function Documentation

§ addWidget() [1/2]

void addWidget ( Widget  widget)

Adds a widget to this container using default settings.

§ addWidget() [2/2]

void addWidget ( Widget  widget,
Object  settings 
)

Adds a widget to this container using the specified settings.

§ allowsChildGrabFocus()

bool allowsChildGrabFocus ( )

Determines if the container allows child widgets to grab the focus.

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

§ doLayout()

void doLayout ( )

Lay out widgets using the set layout. This call is protected against loops caused by layoutParent called from inside a widget being laid out. Furthermore changes to the minimum, preferred and maximum size are tracked to call layoutParent() only if required.

§ findLastFocusableWidget()

Widget findLastFocusableWidget ( )

Find last widget that can grab the focus or null if none exists.

§ forEachWidget()

void forEachWidget ( Block  ablock)

Visit widgets using a block.

§ getAutoVisibleChildren()

bool getAutoVisibleChildren ( )

Determines if children are made visible automatically.

§ getBlockLayout()

bool getBlockLayout ( )

Block layout calls.

Used to prevent deadloops and performance problems with layoutParent/doLayout calls. Be careful to disable blocking even in case of exceptions. Also make sure to restore the block layout call in place before changing it by yourself to not break chains.

§ getContainerHeight()

int getContainerHeight ( )

Retrieve height of area for child widgets excluding the padding. This calculates the the height remaining after subtracting the padding.

§ getContainerSize()

Point getContainerSize ( )

Size of area for child widgets excluding the padding. This calculates the size remaining after subtracting the padding.

§ getContainerWidth()

int getContainerWidth ( )

Retrieve width of area for child widgets excluding the padding. This calculates the the width remaining after subtracting the padding.

§ getLayout()

Layout getLayout ( )

Retrieve the layout of the container.

§ getMinimumSize()

Point getMinimumSize ( )

Returns the minimal size calculated by our layout object for this widget.

§ getMinimumSizeForHeight()

Point getMinimumSizeForHeight ( int  height)

Minimum size of widget using reference widget height and variable width.

Default implementation uses getMinimumSize().

§ getMinimumSizeForWidth()

Point getMinimumSizeForWidth ( int  width)

Minimum size of widget using reference widget width and variable height.

Default implementation uses getMinimumSize().

§ getPaddingBottom()

int getPaddingBottom ( )

Retrieve the size of the bottom padding.

§ getPaddingHeight()

int getPaddingHeight ( )

Height gain of padding.

§ getPaddingLeft()

int getPaddingLeft ( )

Retrieve the size of the left padding.

§ getPaddingRight()

int getPaddingRight ( )

Retrieve the size of the right padding.

§ getPaddingSize()

Point getPaddingSize ( )

Size gain of padding.

§ getPaddingTop()

int getPaddingTop ( )

Retrieve the size of the top padding.

§ getPaddingWidth()

int getPaddingWidth ( )

Width gain of padding.

§ getWidget()

Widget getWidget ( int  index)

Retrieve widget at the given index position.

§ getWidgetAt()

Widget getWidgetAt ( Point  position)

Widget at coordinates or null if not found.

§ getWidgetCount()

int getWidgetCount ( )

Retrieve number of child widgets.

§ giveUpFocus()

void giveUpFocus ( )

Notifies that the current focus widget can no longer hold the focus.

§ hasFocusWidget()

bool hasFocusWidget ( )

Focus widget is inside container somewhere.

§ hasWidget()

bool hasWidget ( Widget  widget)

Determines if the widget is part of the container.

§ indexOfWidget()

int indexOfWidget ( Widget  widget)

Retrieves the index of the widget or -1 if not found.

§ isChildVisible()

bool isChildVisible ( Widget  child)

Determines if the given child widget is visible. This check if the widget is visible and that the widget boundaries lie inside the viewable area of the container.

§ isMouseInside()

bool isMouseInside ( )

Mouse is hovering over this widget.

Tests if the hover widget of the parent desktop is this widget.

§ layoutParent()

void layoutParent ( )

Layout parent if existing. Modified version to respect layout blocking.

§ moveWidget()

void moveWidget ( Widget  widget,
int  newPosition 
)

Move widget from one position to another.

§ new() [1/2]

Container new ( )

Creates a new container.

§ new() [2/2]

Container new ( int  x,
int  y,
int  width,
int  height 
)

Creates a new container located at (x,y) with the given size.

§ nextFocusWidgetAfter()

Widget nextFocusWidgetAfter ( Widget  widget)

Find next widget in the focus cycle that can grab the focus.

§ onGuiThemeChanged()

void onGuiThemeChanged ( )

Notification that the gui theme changed.

§ onHidden()

void onHidden ( WidgetEvent  event)

Widget has been hidden.

§ onResize()

void onResize ( WidgetEvent  event)

Size changed.

§ onStateChanged()

void onStateChanged ( StateChangeEvent  event)

State changed.

§ prevFocusWidgetAfter()

Widget prevFocusWidgetAfter ( Widget  widget)

Find previous widget in the focus cycle that can grab the focus.

§ removeAllWidgets()

void removeAllWidgets ( )

Removes all widgets from this container.

§ removeWidget()

void removeWidget ( Widget  widget)

Removes a widget from this container.

§ reorderChildCanvas()

void reorderChildCanvas ( )

Update order of all child widget canvas.

§ requestCaptureMouse()

bool requestCaptureMouse ( Widget  widget)

Request to capture the mouse for the specified widget. Returns true if the request has been accepted.

§ requestReleaseMouse()

bool requestReleaseMouse ( Widget  widget)

Request to release mouse capture. Returns true if the request has been accepted.

§ runWhileBlockingLayout()

void runWhileBlockingLayout ( Block  ablock)

Run block while layouting is blocked.

This method is useful when you have to add or remove multiple widgets avoiding layout calls to be done for each modification except once to avoid performance loss. The method ensures the blocking state is restored to the value present before even in case of exceptions. You still have to call doLayout() to trigger an update after returning from the method call. This method call can be nested safely.

§ setAutoVisibleChildren()

void setAutoVisibleChildren ( bool  autoVisible)

Sets if children are made visible automatically.

§ setBlockLayout()

void setBlockLayout ( bool  blockLayout)

Set block layout calls.

Used to prevent deadloops and performance problems with layoutParent/doLayout calls. Be careful to disable blocking even in case of exceptions. Also make sure to restore the block layout call in place before changing it by yourself to not break chains.

§ setLayout()

void setLayout ( Layout  layout)

Set layout.

§ setMousePointer()

void setMousePointer ( MousePointer  mousePointer)

Sets the MousePointer assigned to this widget. If null the Widget has no MousePointer assigned and the parent one will be used.

§ setPadding() [1/3]

void setPadding ( int  left,
int  top,
int  right,
int  bottom 
)

Set the size of all paddings.

§ setPadding() [2/3]

void setPadding ( int  padding)

Set the size of all paddings.

§ setPadding() [3/3]

void setPadding ( BorderSize  borderSize)

Set padding from border size.


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